Skip to main content
GET
/
partner
/
offers
List available exchange rate offers
curl --request GET \
  --url https://api.example.com/api/v1/partner/offers \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 42,
      "currency1": {
        "id": 1,
        "code": "USD",
        "name": "US Dollar"
      },
      "currency2": {
        "id": 2,
        "code": "UAH",
        "name": "Ukrainian Hryvnia"
      },
      "rate": 41.5,
      "minAmount": 100,
      "maxAmount": 50000,
      "isActive": true,
      "exchange": {
        "id": 1
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "total": 120,
    "skip": 0,
    "limit": 25
  }
}

Authorizations

Authorization
string
header
required

Partner API key. Format: sk_branch_<32chars>, sk_personal_<32chars>, or pk_<32chars> (public, read-only)

Query Parameters

skip
integer
default:0

Number of records to skip

limit
integer
default:25

Maximum number of records to return

Required range: x <= 100
filters
string

JSON-encoded filter object. Example: {"isActive":true}

sort
string

JSON-encoded sort array. Example: [["rate","ASC"]]

Response

Paginated list of offers

data
object[]
meta
object