Sign in

v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
Exchanges

Exchanges:Browse

Get an overview of all your exchanges. If you do not supply a timerange you will receive the response -7 days until today.

get/exchanges

Query parameters

eqstring

Equals

neqstring

Not equals

Filter by payment state log code (UL-xxxx-xxxx-xxxx)

{
  "eq": "UL-1234-5678-9012",
  "neq": "UL-1234-5678-9012"
}
eqstring

Exact match

neqstring

Not equals

instring[]

Match any of these order IDs

ninstring[]

Exclude these order IDs

Filter by order ID

{
  "eq": "99007308003X455e",
  "neq": "99007308003X455e",
  "in": [
    "99006308003X452b",
    "99007308003X455e"
  ],
  "nin": [
    "99006308003X452b",
    "99007308003X455e"
  ]
}
eqinteger

Equals (1 = OK, 0 = NOK)

neqinteger

Not equals (1 = OK, 0 = NOK)

Filter by webhook call status. Use integer values: 1 = OK (successful), 0 = NOK (failed)

{
  "eq": 1
}
eqstring

Equals

neqstring

Not equals

likestring

Contains

nlikestring

Does not contain

Filter by action type

{
  "eq": "payment:paid",
  "neq": "payment:paid",
  "like": "payment",
  "nlike": "chargeback"
}
eqinteger

Equals

neqinteger

Not equals

instring

In list (comma-separated)

ninstring

Not in list (comma-separated)

Filter by HTTP response code

{
  "eq": 200,
  "neq": 500,
  "in": "200,201",
  "nin": "500,502,503"
}
eqstring

Equals

neqstring

Not equals

instring

In list (comma-separated)

ninstring

Not in list (comma-separated)

Filter by webhook URL

dateStartstring date
Example:2024-12-01

Start date for filtering exchanges (YYYY-MM-DD)

dateEndstring date
Example:2024-12-09

End date for filtering exchanges (YYYY-MM-DD)

Response

Payment state logs retrieved successfully

totalinteger

Total number of payment state log entries matching the filters

countinteger

Number of entries in the current page

pagesinteger

Total number of pages

Example response

{
  "exchanges": [
    {
      "code": "UL-1234-5678-9012",
      "transactionCode": "EX-1234-5678-9012",
      "orderId": "ORD-2025-001234",
      "status": "OK",
      "action": "payment:paid",
      "url": "https://merchant.example.com/webhooks/paynl",
      "timeOfCall": "2025-01-13T14:05:22Z",
      "responseTime": 298,
      "httpMethod": "POST",
      "exchangeMethod": "JSON-POST",
      "responseCode": 200,
      "paymentMethod": {
        "id": 10,
        "name": "iDEAL"
      },
      "amount": 2500,
      "service": {
        "code": "SL-1234-5678",
        "name": "My Webshop"
      }
    }
  ]
}