--- title: "Get payouts" method: GET path: "/payouts" tags: ["Payouts"] --- # Get payouts `GET /payouts` The `GET /payouts` endpoint retrieves a complete or filtered list of payouts. ## Query parameters - `limit` integer, required - `offset` string - `startDate` string - `endDate` string - `ids` string[] - `invertIds` boolean - `statuses` PayoutStatus[] - `invertStatuses` boolean - `refIds` string[] - `onBehalfOfId` string ## Response `200` Successful response - PayoutsResponse - `payouts` Payout[] - `id` string, required — Token.io generated payout id. - `bankTransactionId` string — The transaction id from the bank side. This can be empty if it is not available from the bank. - `memberId` string, required — The Token.io-assigned member id of the TPP. - `createdDateTime` string, required — The date and time this payout object was created The time this payment object was created (in ISO 8601 format). - `updatedDateTime` string, required — The date and time the current status, sub status, status reason information and authentication were last updated (in ISO 8601 format). - `status` 'INITIATION_PENDING' | 'INITIATION_PROCESSING' | 'INITIATION_COMPLETED' | 'INITIATION_REJECTED' | 'INITIATION_FAILED', required — The Token.io Payout Initiation Status.

INITIATION_PENDING - Token.io has received the payout initiation and the initiation passed Token.io validation.

INITIATION_PROCESSING - the payout is processing on the bank side. Status can be updated to one of INITIATION_COMPLETED, INITIATION_REJECTED or INITIATION_FAILED.
If the status is never updated by the bank within certain period of time, the status will stay INITIATION_PROCESSING forever and the corresponding status reason information field will reflect this fact.

INITIATION_COMPLETED - the payout initiation is successful. This does not guarantee the payout is settled.

INITIATION_REJECTED - the payout is rejected by the bank. More details are shared in the corresponding status reason information.

INITIATION_FAILED - Token.io failed to create the initiation due to failures on the bank side, e.g. the bank is not available at the moment. - `bankPaymentStatus` string — The raw bank status. This can be the ISO 20022 payment status code. See ISO 20022 payment status codes for more information. This field can be empty if no payment status is available on bank side. - `statusReasonInformation` string — A human-readable description of the reason for the reported status, which may include a message from the bank. This value should not exceed 256 characters in length. - `initiation` ResolvedPayoutInitiation — The Initiation payload for the refund. - `description` string — The description for the payout. - `refId` string, required — The TPP-generated reference identifier for the token. This is not to be confused with the `requestId`. The `refId` maps to the `tppRefId` in the bank's `consentRequest`. This is needed to match/verify the originating token request with the bank's consent request.
We recommend that the `refId` should not contain special characters (the allowed characters are the 26-letter Latin alphabet, the numerical digits from 0-9 and the hyphen '-'). This field should not exceed 18 characters in length. - `amount` Amount, required — The transaction amount and currency. - `value` string, required — The transaction amount with up to four digits after the decimal point. - `currency` string, required — The ISO 4217 three letter currency code. - `debtor` CorporateApiDebtorInformation, required — The debtor information. - `accountId` string, required — The ID for the debtor settlement account. - `creditor` CreditorInformationPayout, required — The payout creditor object. - `name` string — The owner's name for the creditor account. - `ultimateCreditorName` string — The ultimate creditor's name. - `bankName` string — The creditor's bank name. - `iban` string — The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters. - `bic` string — The Business Identifier Code (BIC), ISO 9362, is the address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs can be either 8 or 11 characters long. - `accountNumber` string — The unique identifier for the bank account in the UK or Ireland. - `sortCode` string — The number assigned to a branch of a bank, typically containing six digits and most commonly used in the UK and Ireland. - `accountVerificationId` string — The Id returned from the /account-verifications endpoint and used to identify the account verification relating to the beneficiary of the payment. Only required for EUR payments. - `paging` PagingInfo - `limit` integer — The limit (maximum number of records to return) that was sent in the request. If the actual number of returned records is less then the limit, there are no more records left to fetch.
The maximum allowed limit is 200. If the passed limit is bigger than this, it will be set to 200. - `offset` string — Offset for the next page. ## Other responses - `400` — The client specified an invalid argument - `401` — The authorization information is missing or invalid - `403` — Permission to access this endpoint is denied - `404` — The requested entity, such as a payment, was not found - `429` — Too many requests - `500` — An unexpected or internal server error - `501` — The operation was not implemented - `503` — Service is unavailable - `504` — Gateway has timed out --- [API](https://skmtc.net/token/apis/token-io-s-open-banking-api-for-tpps.md) · [All operations](https://skmtc.net/token/apis/token-io-s-open-banking-api-for-tpps/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/token/token-io-s-open-banking-api-for-tpps/versions/5e8d6d2c24a1/schema)