Sign in

v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB
Settlement Accounts

Get settlement account payouts

The GET /virtual-accounts/{accountId}/settlement-rule-payouts endpoint retrieves information about payouts created by a settlement rule, for a given settlement account.

get/virtual-accounts/{accountId}/settlement-rule-payouts

Path parameters

accountIdstring required

The system-generated, unique id which specifies the settlement account.

Request body

accountIdstring

The settlement account id.

limitinteger

The maximum number of items to return in the response.

offsetstring

The offset of the first item to return in the response.

settlementRuleIdstring

The id of the settlement rule.

startDatestring

The start date of the settlement rule payout.

endDatestring

The end date of the settlement rule payout.

idsstring[]

The list of payout ids.

invertIdsboolean

If true, the response will contain all settlement rule payouts except those specified in the ids field.

statusesstring[]

The list of payout statuses.

invertStatusesboolean

If true, the response will contain all settlement rule payouts except those specified in the statuses field.

refIdsstring[]

The list of settlement payout reference ids.

Example request

{
  "accountId": "pa:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV",
  "limit": 10,
  "offset": "LerV6Jmex",
  "settlementRuleId": "123e4567-e89b-12d3-a456-426614174000",
  "startDate": "2024-01-01",
  "endDate": "2024-12-01",
  "ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "statuses": [
    "INITIATION_PENDING",
    "INITIATION_PROCESSING"
  ],
  "refIds": [
    "ShBdcTeqFabqJJhUF"
  ]
}

Response

Successful response

Example response

{
  "pageInfo": {
    "limit": 20,
    "offset": "LerV6Jmex",
    "nextOffset": "KgwG8Qkat"
  },
  "payouts": [
    {
      "id": "py:12345abcd:abcd",
      "bankTransactionId": "2UhwCZ3BMaEcAUK8bZdukor7NL4tH6TBuu6aJMp5KKfX:5zKcENpV",
      "memberId": "m:123456abcd:abcd",
      "createdDateTime": "2024-04-05T00:00:00.000+00:00",
      "updatedDateTime": "2024-04-05T00:00:00.000+00:00",
      "status": "INITIATION_COMPLETED",
      "bankPaymentStatus": "ACPC",
      "statusReasonInformation": "The payment is settled on debtor side.",
      "initiation": {
        "description": "e49j-2145-sp17-k3h0",
        "refId": "9htio4a1sp2akdr1aa",
        "onBehalfOfId": "c5a863bc-86f2-4418-a26f-25b24c7983c7",
        "amount": {
          "value": "10.23",
          "currency": "EUR"
        },
        "debtor": {
          "accountId": "a12345"
        },
        "creditor": {
          "name": "Customer Inc.",
          "ultimateCreditorName": "Customer Inc.",
          "iban": "GB29NWBK60161331926819",
          "bic": "BOFIIE2D",
          "accountNumber": "12345678"
        }
      },
      "reference": "ShBdcTeqFabqJJhUF",
      "description": "Description of the payout",
      "settlementRuleId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}