menu

Payment API

What's on this page

API Reference / Payout

Payout

Payout Detail object

Name Type Description
merchantName string The merchant name.
accountNumberFrom string The IBAN number from where the payout originated.
accountNumberTo string The IBAN number to where the payout is paid out.
unstructuredReference string The unstructured reference of this payout.
amount decimal The amount paid out.
payoutDate string The date using format yyyy-mm-dd
payoutFrequency string Possible values: daily, weekly, two_weekly, monthly.
payoutGrouping string Possible values: daily, transaction.
payoutReference string The reference of this payout.
transactionDate string The date the transaction was performed. Using format yyyy-mm-dd
status string Possible values: open, processed, done.

PagedPayouts object

Name Description
data List of Payout object
page Page object

Payout object

Name Type Description
merchantName string The merchant name.
accountNumberFrom string The IBAN number from where the payout originated.
accountNumberTo string The IBAN number to where the payout is paid out.
unstructuredReference string The unstructured reference of this payout.
amount decimal The amount paid out.
payoutDate string The date using format yyyy-mm-dd
payoutFrequency string Possible values: daily, weekly, two_weekly, monthly.
payoutGrouping string Possible values: daily, transaction.
payoutReference string The reference of this payout.

Page object

Name Type Description
size integer The requested page size.
number integer The number of the current page. (The first page has number 0)
totalElements integer The total amount of elements over all pages.
totalPages integer The total number of available pages.

Read payouts request

  • Resource: /api/v1/payout?payoutDateFrom={payoutDateFrom}&payoutDateTo={payoutDateTo}&page={page}&size={size}
  • Method: GET
  • Authentication: basic auth
  • Parameters:
Name Type Format Inclusion Description
payoutDateFrom date yyyy-mm-dd Required The start date to include the requested payouts
payoutDateTo date yyyy-mm-dd Required The end date to include the requested payouts
page int Optional The requested page of the payouts. First page = 0. (default = 0)
size int Optional The number of payouts that is requested per page. (default = 25, maximum = 500)

Read payouts response

Example

{
  "data": [
    {
      "accountNumberFrom": "BE31798258915655",
      "accountNumberTo": "BE71096123456769",
      "merchantName": "Retail Store",
      "unstructuredReference": "Payment - 212cb802 AANT. 5 Retail Store",
      "amount": 10,
      "payoutDate": "2021-07-05",
      "payoutFrequency": "daily",
      "payoutGrouping": "daily",
      "payoutReference": "212cb802"
    },
    {
      "accountNumberFrom": "BE31798258915655",
      "accountNumberTo": "BE71096123456769",
      "merchantName": "Retail Store",
      "unstructuredReference": "Payment - 53cbd57e AANT. 5 Retail Store",
      "amount": 10,
      "payoutDate": "2021-07-05",
      "payoutFrequency": "daily",
      "payoutGrouping": "daily",
      "payoutReference": "53cbd57e"
    }
  ],
  "page": {
    "size": 2,
    "totalElements": 2,
    "totalPages": 1,
    "number": 0
  }
}

Read payout details request

  • Resource: /api/v1/payout/payoutReference
  • Method: GET
  • Authentication: basic auth

Read payout details response

Example

{
  "accountNumberFrom": "BE31798258915655",
  "accountNumberTo": "BE71096123456769",
  "merchantName": "Retail Store",
  "unstructuredReference": "Payment - 53cbd57e AANT. 5 Retail Store",
  "amount": 10,
  "payoutDate": "2020-12-25",
  "payoutFrequency": "daily",
  "payoutGrouping": "daily",
  "payoutReference": "53cbd57e",
  "status": "done"
}