All pages
Powered by GitBook
1 of 1

Loading...

Create currency pair

post
Body

Bulk operation data model

atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
revisioninteger · int32Optional
idstringOptional

The unique identifier of the pair.

namestringOptional

The name of the pair.

externalIdstring · nullableOptional

The external id of the pair

notesstring · nullableOptional

Notes for the pair

primarybooleanOptional

If the pair is primary

revisioninteger · int32Optional
idstringOptional

The unique identifier of the pair.

namestringOptional

The name of the pair.

externalIdstring · nullableOptional

The external id of the pair

notesstring · nullableOptional

Notes for the pair

primarybooleanOptional

If the pair is primary

idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
iconstring · nullableOptional
revisioninteger · int32Optional
revisioninteger · int32Optional
idstringOptional

The unique identifier of the pair.

namestringOptional

The name of the pair.

externalIdstring · nullableOptional

The external id of the pair

notesstring · nullableOptional

Notes for the pair

primarybooleanOptional

If the pair is primary

latestRateall ofOptional
⤷Circular reference to all of
recordDatestring · date-timeOptional

Date and time of rate

valuenumber · doubleOptional

Rate from source to destination currency

externalIdstring · nullableOptional

External id of rate

statusstring · enumOptional

Record status enumeration

Possible values:
idstringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
valuenumber · doubleOptional

Rate from source to destination currency

externalIdstring · nullableOptional

External id of rate

iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional

The unique identifier of the currency.

namestringOptional

The name of the currency.

codestringOptional

The ISO code of currency

precisioninteger · int32Optional

Precision of the currency

iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional

The unique identifier of the currency.

namestringOptional

The name of the currency.

codestringOptional

The ISO code of currency

precisioninteger · int32Optional

Precision of the currency

idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
iconstring · nullableOptional
revisioninteger · int32Optional
revisioninteger · int32Optional
idstringOptional

The unique identifier of the pair.

namestringOptional

The name of the pair.

externalIdstring · nullableOptional

The external id of the pair

notesstring · nullableOptional

Notes for the pair

primarybooleanOptional

If the pair is primary

idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
iconstring · nullableOptional
revisioninteger · int32Optional
pairall ofOptional
⤷Circular reference to all of
recordDatestring · date-timeOptional

Date and time of rate

valuenumber · doubleOptional

Rate from source to destination currency

externalIdstring · nullableOptional

External id of rate

statusstring · enumOptional

Record status enumeration

Possible values:
idstringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
valuenumber · doubleOptional

Rate from source to destination currency

externalIdstring · nullableOptional

External id of rate

recordDatestring · date-timeOptional

Date and time of rate

valuenumber · doubleOptional

Rate from source to destination currency

externalIdstring · nullableOptional

External id of rate

statusstring · enumOptional

Record status enumeration

Possible values:
idstringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
valuenumber · doubleOptional

Rate from source to destination currency

externalIdstring · nullableOptional

External id of rate

agreementsinteger · int32Optional

Number of agreements

ratesinteger · int32Optional

Number of rates

statusstring · enumOptional

Rate status enumeration

Possible values:
Responses
201

Created

application/json

Bulk operation data model

atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
revisioninteger · int32Optional
idstringOptional

The unique identifier of the pair.

namestringOptional

The name of the pair.

externalIdstring · nullableOptional

The external id of the pair

notesstring · nullableOptional

Notes for the pair

primarybooleanOptional

If the pair is primary

revisioninteger · int32Optional
idstringOptional

The unique identifier of the pair.

namestringOptional

The name of the pair.

externalIdstring · nullableOptional

The external id of the pair

notesstring · nullableOptional

Notes for the pair

primarybooleanOptional

If the pair is primary

idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
iconstring · nullableOptional
revisioninteger · int32Optional
revisioninteger · int32Optional
idstringOptional

The unique identifier of the pair.

namestringOptional

The name of the pair.

externalIdstring · nullableOptional

The external id of the pair

notesstring · nullableOptional

Notes for the pair

primarybooleanOptional

If the pair is primary

latestRateall ofOptional
⤷Circular reference to all of
recordDatestring · date-timeOptional

Date and time of rate

valuenumber · doubleOptional

Rate from source to destination currency

externalIdstring · nullableOptional

External id of rate

statusstring · enumOptional

Record status enumeration

Possible values:
idstringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
valuenumber · doubleOptional

Rate from source to destination currency

externalIdstring · nullableOptional

External id of rate

iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional

The unique identifier of the currency.

namestringOptional

The name of the currency.

codestringOptional

The ISO code of currency

precisioninteger · int32Optional

Precision of the currency

iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional

The unique identifier of the currency.

namestringOptional

The name of the currency.

codestringOptional

The ISO code of currency

precisioninteger · int32Optional

Precision of the currency

idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
iconstring · nullableOptional
revisioninteger · int32Optional
revisioninteger · int32Optional
idstringOptional

The unique identifier of the pair.

namestringOptional

The name of the pair.

externalIdstring · nullableOptional

The external id of the pair

notesstring · nullableOptional

Notes for the pair

primarybooleanOptional

If the pair is primary

idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
iconstring · nullableOptional
revisioninteger · int32Optional
pairall ofOptional
⤷Circular reference to all of
recordDatestring · date-timeOptional

Date and time of rate

valuenumber · doubleOptional

Rate from source to destination currency

externalIdstring · nullableOptional

External id of rate

statusstring · enumOptional

Record status enumeration

Possible values:
idstringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
valuenumber · doubleOptional

Rate from source to destination currency

externalIdstring · nullableOptional

External id of rate

recordDatestring · date-timeOptional

Date and time of rate

valuenumber · doubleOptional

Rate from source to destination currency

externalIdstring · nullableOptional

External id of rate

statusstring · enumOptional

Record status enumeration

Possible values:
idstringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
valuenumber · doubleOptional

Rate from source to destination currency

externalIdstring · nullableOptional

External id of rate

agreementsinteger · int32Optional

Number of agreements

ratesinteger · int32Optional

Number of rates

statusstring · enumOptional

Rate status enumeration

Possible values:
403

Forbidden

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
404

Not Found

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
500

Internal Server Error

No content

post/public/v1/exchange/pairs
POST /public/v1/exchange/pairs HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 1425

{
  "data": [
    {
      "audit": {
        "created": {
          "at": "2026-01-01T00:00:00.000Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-01-01T00:00:00.000Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "deleted": {
          "at": "2026-01-01T00:00:00.000Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "revision": 1,
      "id": "text",
      "name": "text",
      "externalId": "text",
      "notes": "text",
      "primary": true,
      "reverse": {
        "revision": 1,
        "id": "text",
        "name": "text",
        "externalId": "text",
        "notes": "text",
        "primary": true,
        "latestRate": "[Circular Reference]"
      },
      "sourceCurrency": {
        "icon": "text",
        "revision": 1,
        "id": "text",
        "name": "text",
        "code": "text",
        "precision": 1
      },
      "destinationCurrency": {
        "icon": "text",
        "revision": 1,
        "id": "text",
        "name": "text",
        "code": "text",
        "precision": 1
      },
      "latestRate": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "deleted": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "icon": "text",
        "revision": 1,
        "pair": {},
        "recordDate": "2026-01-01T00:00:00.000Z",
        "value": 1,
        "externalId": "text",
        "status": "Active",
        "reverseRate": {
          "id": "text",
          "icon": "text",
          "revision": 1,
          "value": 1,
          "externalId": "text"
        }
      },
      "agreements": 1,
      "rates": 1,
      "status": "Active"
    }
  ]
}
{
  "data": [
    {
      "audit": {
        "created": {
          "at": "2026-01-01T00:00:00.000Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-01-01T00:00:00.000Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "deleted": {
          "at": "2026-01-01T00:00:00.000Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "revision": 1,
      "id": "text",
      "name": "text",
      "externalId": "text",
      "notes": "text",
      "primary": true,
      "reverse": {
        "revision": 1,
        "id": "text",
        "name": "text",
        "externalId": "text",
        "notes": "text",
        "primary": true,
        "latestRate": "[Circular Reference]"
      },
      "sourceCurrency": {
        "icon": "text",
        "revision": 1,
        "id": "text",
        "name": "text",
        "code": "text",
        "precision": 1
      },
      "destinationCurrency": {
        "icon": "text",
        "revision": 1,
        "id": "text",
        "name": "text",
        "code": "text",
        "precision": 1
      },
      "latestRate": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "deleted": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "icon": "text",
        "revision": 1,
        "pair": {},
        "recordDate": "2026-01-01T00:00:00.000Z",
        "value": 1,
        "externalId": "text",
        "status": "Active",
        "reverseRate": {
          "id": "text",
          "icon": "text",
          "revision": 1,
          "value": 1,
          "externalId": "text"
        }
      },
      "agreements": 1,
      "rates": 1,
      "status": "Active"
    }
  ]
}

Creates a new pair or pairs of currencies.