Retrieve Payout Status

GET /payouts/:shopId/:payoutNumber

Retrieves the current status of a specific payout operation for a shop.

Request

Path Parameters

shopId stringrequired

ID of the shop from which the payout operation was performed. How to get your shopId

Example: 1234

payoutNumber stringrequired

Payout operation number, which is obtained from the response of the POST /payouts endpoint

Responses

Payout status

application/json

Schema
Example (from schema)

Schema

data objectrequired

shopId integerrequired

The unique identifier of the shop initiating the payout.

id integerrequired

The internal unique identifier of the payout within the system. Used for referencing the payout when contacting technical support in case of any issues.

payoutStatus stringrequired

Possible values: [in_progress, failed, completed, rejected, cancelled, need_action]

Status of the payout. Description of Statuses

payoutNumber stringrequired

A unique identifier for the payout, generated by the merchant, and specific to each shopId.

purpose stringrequired

The purpose or reason for the payout request.

cost objectrequired

Container for cost-related information.

amount stringrequired

Total cost of the payout, formatted as a decimal string with a period (.) as the decimal separator.

currency stringrequired

Specifies the currency in ISO 4217 alphabetic code format, consisting of 3 uppercase letters.

region string

The ISO 3166-1 alpha-2 country code of payout country.

payoutCreatedAt date-timerequired

Date and time the payout was created, in RFC 3339 format including the UTC zone.

payoutPaidAt date-timenullable

Date and time when the payout was successfully sent to the recipient, formatted according to RFC 3339, including the UTC time zone.

payoutTransactions object[]

An array of payouts objects related to the payout. If the array is empty, it indicates that no payouts have been made for the payout yet. If an payout is paid with multiple payouts, there will be one object per payout in the array.

Array [

transactionId stringrequired

Identifier for the specific payout assigned by our system.

providerTransactionId string

Identifier for the specific payout assigned by the payment provider.

cost objectrequired

Financial details of the payout

amount stringrequired

The amount of the transaction. Formatted as a decimal string with a period (.) as the decimal separator.

currency stringrequired

Specifies the currency in ISO 4217 alphabetic code format, consisting of 3 uppercase letters.

provider objectrequired

Information about the provider for this payout.

code string

Provider code.

acquirer objectrequired

Information about the acquirer for this payout.

code string

Acquirer code.

instrumentType stringrequired

Possible values: [card, bank_transfer, wallet, crypto_wallet, voucher]

Specifies the payout instrument. See available payment instruments

status object

Contains the status of the payout, including detailed information in case of payout failure.

status stringrequired

Possible values: [in_progress, completed, cancelled, failed]

The current state of the payout. Description of Statuses

details nullable

Provides additional error details if the payout fails.

errorId stringnullable

A unique identifier for the error generated by the system, used for tracking and troubleshooting.

providerMessage stringnullable

An error message provided by the payment provider, offering insight into the reason for the failure.

code integernullable

An internal error code used by the system to categorize the type of error that occurred.

]

customer objectnullable

Container for customer-specific information.

customerId stringrequired

An identifier for the customer provided when creating the order or payout. If customerId was not specified during order/payout creation but name and surname were provided, the system will generate a customerId in the format of a GUID (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) and return it here.

firstName stringnullable

First name of the customer.

lastName stringnullable

Last name of the customer.

middleName stringnullable

Middle name of the customer, if applicable.

phone stringnullable

Customer's phone number, in international format.

email emailnullable

Email address of the customer.

payoutDetails objectnullable

Describes the details of the payout, which vary according to the instrumentType used.

recipient object nullable

The details of the entity receiving the payout. Contains information specific to the payment instrument type.

oneOf

instrumentType=card
instrumentType=bank_transfer
instrumentType=wallet
instrumentType=crypto_wallet

paymentSystem stringnullable

Possible values: [visa, mastercard, jcb, amex, dсi, unionpay, upi, mir, discover, redcompra, elo, hipercard]

Brand of the card used in the transaction.

visa - "Visa"

mastercard - "MasterCard"

jcb - "JCB"

amex - "American Express"

dci - "Diners Club International"

unionpay - "UnionPay"

upi - "UnionPay International"

mir - "Mir"

discover - "Discover"

redcompra - "Redcompra"

elo - "Elo"

hipercard - "Hipercard"

maskedCardNumber stringnullable

This field displays a partially obscured version of the card number to maintain security and privacy. Depending on the provider, the masked card number might show:

The first 6 and last 4 digits, with the intervening digits replaced by asterisks (e.g., 123456******1234)
Only the last 4 digits (e.g., **** **** **** 1234)

accountNumber stringnullable

The bank account number.

transferType stringnullable

Possible values: [swift, sepa, bank_wire, card2card, pix, sbp, online_banking, open_finance, virtual_account, qris, promptpay, thaiqr, spei, vietnambanksqr, vietqr, khipu, paysafecard, multibanco, bancontact, blik, p24, rapidtransfer, upi, thb_qr, sberbank, giropay, eps, account2card]

Specifies the type of bank transfer. See details about transferType

sender object nullable

The details of the entity initiating the payout. Contains information specific to the payment instrument type.