Sign in
latestOpenAPI 3.0.12026-08-104242199.9 KB

8df83424e244

Partner remittances

Index partner remittances

Returns an array containing all partner remittances for all of your customers.

get/v1/partner_remittances

Query parameters

page[number]string

The number of results pages to return.

page[size]string

The size of each page in the response.

filter[account_id]string

Filter the results by account ID.

filter[status]string

Filter the results by remittance status.

Response

Successful result of the operation

idstring

Unique ID of the partner remittance.

receiver_first_namestring

The receiver's first name.

receiver_last_namestring

The receiver's last name.

receiver_account_numberstring

The receiver's bank account number.

statusstring

The status of the remittance.

descriptionstring

Optional description of the remittance, which will be visible to the recipient.

clearing_profile_idstring

ID of the clearing profile to use for this transaction.

Example response

[
  {
    "id": "2c7da6c316a34fd1915cb9fb2ccc632e",
    "receiver_first_name": "Max",
    "receiver_last_name": "Mustermann",
    "receiver_address": {
      "line_1": "Musterstrasse",
      "postal_code": "10409",
      "city": "Berlin",
      "state": "BE"
    },
    "receiver_account_number": "DE72110101001000014344",
    "amount": {
      "value": 1000,
      "unit": "cents",
      "currency": "EUR"
    },
    "clearing_profile_id": "1c0eda0b559825ef456b21d81f4ee962pacp",
    "sender": {
      "account_id": "575189c6eb825b10b9d0392fcb3bf61dcacc",
      "person_id": "ad8f5cefdc73035f17973fecb4fa2ebccper",
      "first_name": "Peter",
      "last_name": "Testmann",
      "iban": "DE13110101014386274299"
    }
  }
]