Sign in

v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB
Payouts

Get payouts

The GET /payouts endpoint retrieves a complete or filtered list of payouts.

get/payouts

Query parameters

limitinteger required

The maximum number of records to return.

offsetstring

The offset from the previous page.

startDatestring

Lower bound for a payout creation date in the format 'YYYY-MM-DD' (UTC time zone). If specified, only payouts created at or after the given date will be returned.

endDatestring

Upper bound for a payout creation date in the format 'YYYY-MM-DD' (UTC time zone). If specified, only payouts created at or before the given date will be returned.

idsstring[]

Filters payouts by their ids - returns only payouts with ids listed in this parameter.

invertIdsboolean

Invert ids query - returns only payouts with ids not listed in the ids parameter.

statusesPayoutStatus[]

Filters payouts by their statuses - returns only payouts with statuses listed in this parameter.

[
  "INITIATION_COMPLETED"
]
invertStatusesboolean

Invert statuses query - returns only payouts with statuses not listed in the statuses parameter.

refIdsstring[]

Filters payouts by their refId values - returns only payouts with refIds listed in this parameter.

onBehalfOfIdstring

Filters payouts by their onBehalfOfId value - returns only payouts with the onBehalfOfId value specified in this parameter. This field is mandatory for unregulated TPPs.

Response

Successful response

Example response

{
  "payouts": [
    {
      "id": "po:yj6sSEf7ZYFP8yxN6XWi1KkMEcB:2gFUX1NDget",
      "bankTransactionId": "2UhwCZ3BMaEcAUK8bZdukor7NL4tH6TBuu6aJMp5KKfX:5zKcENpV",
      "memberId": "m:123456abcd:abcd",
      "createdDateTime": "2017-04-05T10:43:07.000+00:00",
      "updatedDateTime": "2017-04-05T10:45:07.000+00:00",
      "status": "INITIATION_COMPLETED",
      "bankPaymentStatus": "ACPC",
      "statusReasonInformation": "The payment is settled on debtor side.",
      "initiation": {
        "description": "payout for some reason",
        "refId": "9htio4a1sp2akdr1aa",
        "amount": {
          "value": "10.23",
          "currency": "EUR"
        },
        "debtor": {
          "accountId": "a12345"
        },
        "creditor": {
          "name": "Customer Inc.",
          "ultimateCreditorName": "Customer Inc.",
          "iban": "GB29NWBK60161331926819",
          "bic": "BOFIIE2D",
          "accountNumber": "12345678"
        }
      }
    }
  ],
  "paging": {
    "offset": "LerV6Jmex"
  }
}