XSxs2a
XS2A.pay

Get a list of all xs2a.pay transaction objects

Changed on

Get a list of all xs2a.pay transactions, or filter using query parameters.

get/payments

Request

Query parameters

sender_holderstring

Holder of the sender account

sender_ibanstring

IBAN of the sender account

sender_bicstring

BIC of the sender account

sender_account_numberstring

Account number of the sender account

sender_bank_codestring

National bank code of the sender account

sender_country_id'DE' | 'AT' | 'CH'

The 2-letter country code

Example:DE

Two letter country code id of the sender account, e.g. AT, CH, DE

recipient_holderstring

Holder of the recipient account

recipient_ibanstring

IBAN of the recipient account

recipient_bicstring

BIC of the recipient account

recipient_country_id'DE' | 'AT' | 'CH'

The 2-letter country code

Example:DE

Two letter country code id of the recipient account, e.g. AT, CH, DE

amountnumber float

Amount to transfer

purposestring

Purpose of transfer

per_pageinteger

Items per page

pageinteger

Which page to display

fromstring date-time

Filter by date. Pass ISO8601 conform dates (yyyy-mm-ddThh:mm:ss-zzzz). The time and timezone portions are optional and may be omitted (e.g yyyy-mm-dd or yyyy-mm-ddThh:mm:ss).

tostring date-time

Filter by date. Pass ISO8601 conform dates (yyyy-mm-ddThh:mm:ss-zzzz). The time and timezone portions are optional and may be omitted (e.g yyyy-mm-dd or yyyy-mm-ddThh:mm:ss).

sincestring date-time

Filter by date. Pass ISO8601 conform dates (yyyy-mm-ddThh:mm:ss-zzzz). The time and timezone portions are optional and may be omitted (e.g yyyy-mm-dd or yyyy-mm-ddThh:mm:ss).

Response

Request successfully processed

totalinteger

Total number of results.

per_pageinteger

Number of objects per page

current_pageinteger

Current page.

last_pageinteger

Last page, usually the total of available pages.

frominteger

Showing results from index element.

tointeger

Showing results to index element.

Example response

{
  "total": 26,
  "per_page": 15,
  "current_page": 1,
  "last_page": 15,
  "from": 1,
  "to": 15,
  "data": [
    {
      "id": "xp_fSdkfjS2R2S5x1pu",
      "transaction": "10001-xp-abcd-abcd",
      "sender_holder": "Holder Customer",
      "sender_iban": "DE62888888880012345678",
      "sender_bic": "TESTDE88XXX",
      "sender_bank_name": "Testbank",
      "sender_country_id": "DE",
      "recipient_holder": "Holder",
      "recipient_iban": "DE62888888880012345678",
      "recipient_bic": "TESTDE88XXX",
      "recipient_bank_name": "Testbank",
      "recipient_country_id": "DE",
      "purpose": "Purpose",
      "amount": 10.99,
      "currency_id": "EUR",
      "testmode": "1",
      "payment_status": "RECEIVED",
      "metadata": {
        "key1": "value1"
      }
    }
  ]
}

Changes

  • ae5fbc5feee3Revision changes
    • breaking

      removed the enum value ES from the query request parameter recipient_country_id

    • breaking

      removed the enum value ES from the query request parameter sender_country_id

    • breaking

      removed the enum value FR from the query request parameter recipient_country_id

    • breaking

      removed the enum value FR from the query request parameter sender_country_id

    • breaking

      removed the enum value GB from the query request parameter recipient_country_id

    • breaking

      removed the enum value GB from the query request parameter sender_country_id

    • breaking

      removed the enum value IT from the query request parameter recipient_country_id

    • breaking

      removed the enum value IT from the query request parameter sender_country_id

    • info

      removed the ES enum value from the // response property for the response status

    • info

      removed the ES enum value from the // response property for the response status

    • info

      removed the FR enum value from the // response property for the response status

    • info

      removed the FR enum value from the // response property for the response status

    • info

      removed the GB enum value from the // response property for the response status

    • info

      removed the GB enum value from the // response property for the response status

    • info

      removed the IT enum value from the // response property for the response status

    • info

      removed the IT enum value from the // response property for the response status