Get currency pair

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.

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

agreementsinteger · int32Optional

Number of agreements

ratesinteger · int32Optional

Number of rates

statusstring · enumOptional

Rate status enumeration

Possible values:

404

Not Found

application/json

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