All pages
Powered by GitBook
1 of 6

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Create currency pair

Get currency pair

Pair

The Pair object represents an exchange rate between two currencies, used by one or more sellers in our system to invoice their products.

This object contains the following attributes:

Field
Type
Description

id

Update currency pair

List currency pairs

string, core

(Read-only) The primary identifier for the currency.

externalId

string

(Optional) The identifier within the external system.

name

string, core

(Read-only) User‑friendly name. Auto‑generated from the ISO codes of both currencies.

source

object

Represents the source object.

destination

object

Represents the destination object.

notes

string

The optional text that was provided when creating the rate.

latestRate

rate, core

The of exchange from source to destination.

updatedAt

datetime

The date when the rate was last updated.

agreements

integer

(Read-only) Number of agreements currently using this pair.

status

string

Indicates whether the item is active or deleted.

audit

object

(Read-only) Represents the object.

primary

bool

(Read-only) Indicates if the pair is primary.

reverse

pair

(Read-only) Indicates reverse pair.

revision

integer, core

The entity's revision number.

PAIR OBJECT
{
  "$meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 261
    },
    "omitted": [
      "audit"
    ]
  },
  "data": [
    {
      "id": "FXP-0000-0001",
      "name": "EUR: USD",
      "revision": 1,
      "externalId": "EXT-1234",
      "notes": "notes",
      "source": {
        "id": "CUR-1234",
        "name": "Euro",
        "code": "EUR",
        "revision": 1
      },
      "destination": {
        "id": "CUR-2345",
        "name": "Dollar",
        "code": "USD",
        "revision": 1
      },
      "latestRate": {
        "id": "FXR-1234-8907",
        "rate": "4.23658350000",
        "revision": 1
      },
      "primary": "true",
      "reverse": {
        "id": "FXP-0000-0002",
        "name": "USD: EUR",
        "revision": 1,
        "latestRate": {
          "id": "FXR-1234-8909",
          "rate": "0.1",
          "revision": 1
        }
      },
      "agreements": 0,
      "status": "Active"
    }
  ]
}

Example

currency
currency
rate
audit

Delete currency pairs

Retrieves a currency pair by ID.

get

Returns the pair with the specified ID. Use the select query parameter to specify which fields to include.

Path parameters
idstringRequired

The pair ID.

Query parameters
selectstringOptional

Optional select statement to filter fields.

Responses
200

OK

application/json

Represents a pair of currencies in exchange module.

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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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:
404

Not Found

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
get/public/v1/exchange/pairs/{id}
GET /public/v1/exchange/pairs/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
  "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,
    "sourceCurrency": {
      "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,
      "id": "text",
      "name": "text",
      "code": "text",
      "precision": 1,
      "statistics": {
        "sellerCount": 1,
        "pairCount": 1
      },
      "status": "Active"
    },
    "destinationCurrency": {
      "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,
      "id": "text",
      "name": "text",
      "code": "text",
      "precision": 1,
      "statistics": {
        "sellerCount": 1,
        "pairCount": 1
      },
      "status": "Active"
    },
    "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"
      }
    }
  },
  "sourceCurrency": {
    "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,
    "id": "text",
    "name": "text",
    "code": "text",
    "precision": 1,
    "statistics": {
      "sellerCount": 1,
      "pairCount": 1
    },
    "status": "Active"
  },
  "destinationCurrency": {
    "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,
    "id": "text",
    "name": "text",
    "code": "text",
    "precision": 1,
    "statistics": {
      "sellerCount": 1,
      "pairCount": 1
    },
    "status": "Active"
  },
  "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"
}

Updates pairs from bulk data.

put
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
200

OK

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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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:
400

Bad Request

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

put/public/v1/exchange/pairs
PUT /public/v1/exchange/pairs HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 3286

{
  "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,
        "sourceCurrency": {
          "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,
          "id": "text",
          "name": "text",
          "code": "text",
          "precision": 1,
          "statistics": {
            "sellerCount": 1,
            "pairCount": 1
          },
          "status": "Active"
        },
        "destinationCurrency": {
          "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,
          "id": "text",
          "name": "text",
          "code": "text",
          "precision": 1,
          "statistics": {
            "sellerCount": 1,
            "pairCount": 1
          },
          "status": "Active"
        },
        "latestRate": "[Circular Reference]"
      },
      "sourceCurrency": {
        "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,
        "id": "text",
        "name": "text",
        "code": "text",
        "precision": 1,
        "statistics": {
          "sellerCount": 1,
          "pairCount": 1
        },
        "status": "Active"
      },
      "destinationCurrency": {
        "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,
        "id": "text",
        "name": "text",
        "code": "text",
        "precision": 1,
        "statistics": {
          "sellerCount": 1,
          "pairCount": 1
        },
        "status": "Active"
      },
      "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,
        "sourceCurrency": {
          "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,
          "id": "text",
          "name": "text",
          "code": "text",
          "precision": 1,
          "statistics": {
            "sellerCount": 1,
            "pairCount": 1
          },
          "status": "Active"
        },
        "destinationCurrency": {
          "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,
          "id": "text",
          "name": "text",
          "code": "text",
          "precision": 1,
          "statistics": {
            "sellerCount": 1,
            "pairCount": 1
          },
          "status": "Active"
        },
        "latestRate": "[Circular Reference]"
      },
      "sourceCurrency": {
        "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,
        "id": "text",
        "name": "text",
        "code": "text",
        "precision": 1,
        "statistics": {
          "sellerCount": 1,
          "pairCount": 1
        },
        "status": "Active"
      },
      "destinationCurrency": {
        "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,
        "id": "text",
        "name": "text",
        "code": "text",
        "precision": 1,
        "statistics": {
          "sellerCount": 1,
          "pairCount": 1
        },
        "status": "Active"
      },
      "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"
    }
  ]
}

Deletes multiple pairs from the body.

delete
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
200

OK

application/json

Represents a pair of currencies in exchange module.

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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

delete/public/v1/exchange/pairs
DELETE /public/v1/exchange/pairs HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 3286

{
  "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,
        "sourceCurrency": {
          "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,
          "id": "text",
          "name": "text",
          "code": "text",
          "precision": 1,
          "statistics": {
            "sellerCount": 1,
            "pairCount": 1
          },
          "status": "Active"
        },
        "destinationCurrency": {
          "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,
          "id": "text",
          "name": "text",
          "code": "text",
          "precision": 1,
          "statistics": {
            "sellerCount": 1,
            "pairCount": 1
          },
          "status": "Active"
        },
        "latestRate": "[Circular Reference]"
      },
      "sourceCurrency": {
        "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,
        "id": "text",
        "name": "text",
        "code": "text",
        "precision": 1,
        "statistics": {
          "sellerCount": 1,
          "pairCount": 1
        },
        "status": "Active"
      },
      "destinationCurrency": {
        "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,
        "id": "text",
        "name": "text",
        "code": "text",
        "precision": 1,
        "statistics": {
          "sellerCount": 1,
          "pairCount": 1
        },
        "status": "Active"
      },
      "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"
    }
  ]
}
[
  {
    "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,
      "sourceCurrency": {
        "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,
        "id": "text",
        "name": "text",
        "code": "text",
        "precision": 1,
        "statistics": {
          "sellerCount": 1,
          "pairCount": 1
        },
        "status": "Active"
      },
      "destinationCurrency": {
        "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,
        "id": "text",
        "name": "text",
        "code": "text",
        "precision": 1,
        "statistics": {
          "sellerCount": 1,
          "pairCount": 1
        },
        "status": "Active"
      },
      "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": "[Circular Reference]",
        "recordDate": "2026-01-01T00:00:00.000Z",
        "value": 1,
        "externalId": "text",
        "status": "Active",
        "reverseRate": {
          "id": "text",
          "icon": "text",
          "revision": 1,
          "value": 1,
          "externalId": "text"
        }
      }
    },
    "sourceCurrency": {
      "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,
      "id": "text",
      "name": "text",
      "code": "text",
      "precision": 1,
      "statistics": {
        "sellerCount": 1,
        "pairCount": 1
      },
      "status": "Active"
    },
    "destinationCurrency": {
      "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,
      "id": "text",
      "name": "text",
      "code": "text",
      "precision": 1,
      "statistics": {
        "sellerCount": 1,
        "pairCount": 1
      },
      "status": "Active"
    },
    "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": {
        "revision": 1,
        "id": "text",
        "name": "text",
        "externalId": "text",
        "notes": "text",
        "primary": true,
        "sourceCurrency": {
          "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,
          "id": "text",
          "name": "text",
          "code": "text",
          "precision": 1,
          "statistics": {
            "sellerCount": 1,
            "pairCount": 1
          },
          "status": "Active"
        },
        "destinationCurrency": {
          "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,
          "id": "text",
          "name": "text",
          "code": "text",
          "precision": 1,
          "statistics": {
            "sellerCount": 1,
            "pairCount": 1
          },
          "status": "Active"
        },
        "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": "[Circular Reference]",
          "recordDate": "2026-01-01T00:00:00.000Z",
          "value": 1,
          "externalId": "text",
          "status": "Active",
          "reverseRate": {
            "id": "text",
            "icon": "text",
            "revision": 1,
            "value": 1,
            "externalId": "text"
          }
        }
      },
      "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"
  }
]
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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: 3286

{
  "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,
        "sourceCurrency": {
          "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,
          "id": "text",
          "name": "text",
          "code": "text",
          "precision": 1,
          "statistics": {
            "sellerCount": 1,
            "pairCount": 1
          },
          "status": "Active"
        },
        "destinationCurrency": {
          "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,
          "id": "text",
          "name": "text",
          "code": "text",
          "precision": 1,
          "statistics": {
            "sellerCount": 1,
            "pairCount": 1
          },
          "status": "Active"
        },
        "latestRate": "[Circular Reference]"
      },
      "sourceCurrency": {
        "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,
        "id": "text",
        "name": "text",
        "code": "text",
        "precision": 1,
        "statistics": {
          "sellerCount": 1,
          "pairCount": 1
        },
        "status": "Active"
      },
      "destinationCurrency": {
        "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,
        "id": "text",
        "name": "text",
        "code": "text",
        "precision": 1,
        "statistics": {
          "sellerCount": 1,
          "pairCount": 1
        },
        "status": "Active"
      },
      "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,
        "sourceCurrency": {
          "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,
          "id": "text",
          "name": "text",
          "code": "text",
          "precision": 1,
          "statistics": {
            "sellerCount": 1,
            "pairCount": 1
          },
          "status": "Active"
        },
        "destinationCurrency": {
          "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,
          "id": "text",
          "name": "text",
          "code": "text",
          "precision": 1,
          "statistics": {
            "sellerCount": 1,
            "pairCount": 1
          },
          "status": "Active"
        },
        "latestRate": "[Circular Reference]"
      },
      "sourceCurrency": {
        "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,
        "id": "text",
        "name": "text",
        "code": "text",
        "precision": 1,
        "statistics": {
          "sellerCount": 1,
          "pairCount": 1
        },
        "status": "Active"
      },
      "destinationCurrency": {
        "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,
        "id": "text",
        "name": "text",
        "code": "text",
        "precision": 1,
        "statistics": {
          "sellerCount": 1,
          "pairCount": 1
        },
        "status": "Active"
      },
      "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"
    }
  ]
}
get

Supports filtering, sorting, and pagination via query string parameters.

Header parameters
MPT-StreamingbooleanOptional

Stream the full result set instead of a page. Membership fixes at stream start, each record is emitted once, and MPT-Item-Count gives the exact count. Accept: application/jsonl for line-delimited output. A positive limit caps the stream, -1 or absent reads all; offset skips that many records of the requested order, so limit and offset together read one window. Each window is its own snapshot — consecutive windows are not a resumable export.

Responses
200

OK

Streamed and paged responses both answer 200. Only a streamed one carries the MPT-Streaming and MPT-Item-Count headers listed below.

application/jsonl: one object per line, no envelope, so the schema describes one line. A line is a record or an ID-only deleted stub (StreamedDeletedRecord) — check $meta.deleted before ingesting. Blank lines are keep-alives.

MPT-StreamingbooleanOptional

Streamed responses only, where it is true. Absent on a paged response.

MPT-Item-Countinteger · int64Optional

Streamed responses only. Absent on a paged response. The exact object count — compare it with the number received.

offsetinteger · int32Optional
limitinteger · int32Optional
totalinteger · int32 · nullableOptional
omittedstring[]Optional
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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

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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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
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

sellerCountinteger · int32Optional

Number of sellers using currency

pairCountinteger · int32Optional

Number of pairs

statusstring · enumOptional

Currency status enumeration

Possible values:
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:
400

Invalid RQL, or invalid paging. limit must be positive (caps the stream) or -1 / absent (reads all); offset must be a non-negative integer.

No content

406

No acceptable media type. application/jsonl without the MPT-Streaming header lands here.

No content

413

The result set exceeds the configured stream key cap. Nothing is written to the body.

No content

501

This resource's query service provides no streaming capability.

No content

get/public/v1/exchange/pairs
GET /public/v1/exchange/pairs HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "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,
        "sourceCurrency": {
          "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,
          "id": "text",
          "name": "text",
          "code": "text",
          "precision": 1,
          "statistics": {
            "sellerCount": 1,
            "pairCount": 1
          },
          "status": "Active"
        },
        "destinationCurrency": {
          "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,
          "id": "text",
          "name": "text",
          "code": "text",
          "precision": 1,
          "statistics": {
            "sellerCount": 1,
            "pairCount": 1
          },
          "status": "Active"
        },
        "latestRate": "[Circular Reference]"
      },
      "sourceCurrency": {
        "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,
        "id": "text",
        "name": "text",
        "code": "text",
        "precision": 1,
        "statistics": {
          "sellerCount": 1,
          "pairCount": 1
        },
        "status": "Active"
      },
      "destinationCurrency": {
        "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,
        "id": "text",
        "name": "text",
        "code": "text",
        "precision": 1,
        "statistics": {
          "sellerCount": 1,
          "pairCount": 1
        },
        "status": "Active"
      },
      "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.

Gets a list of currency pairs.