Skip to main content

Retrieve Required Payout Fields

GET 
/payouts/fields/:providerCode/:instrumentType/
deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

In the future, this endpoint will be deprecated and replaced by the POST endpoint Retrieve Required Payout Fields because the POST endpoint provides more data and supports more providers.

This endpoint retrieves data fields required to fill the recipient object for a payout. These fields vary based on the specified providerCode, instrumentType. You can get a list of required parameters for your store from Retrieve Payout Methods. Upon calling this endpoint, you will receive a recipient object with fields that need to be filled out and submitted in the payout creation endpoint."

Request​

Path Parameters

    providerCode stringrequired

    The name of the provider for which you want to retrieve data.

    instrumentType stringrequired

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

    Specifies the instrument type for the payout.

Responses​

A list of required fields for each object.

Schema
    data objectrequired
    recipient objectrequired

    Detailed information about the payout recipient.

    personalData string[]

    Personal identification and contact information of the recipient.

    addressData string[]

    Address information for the payout recipient.

    documentData string[]

    Document identification for the payout recipient.

    cardData string[]

    Information required for processing a payout via credit card.

    walletData string[]

    Information required for processing a payout via e-wallet.

    bankTransferData string[]

    Information required for processing a payout via bank transfer.

    paymentData objectnullable

    Details about the payment channel used for the payout.

    channel stringnullable

    The payment channel used for the transaction

    payoutData objectnullable

    Details related to the payout, including fee responsibility and currency.

    feeBear stringnullable

    Indicates who bears the fee for the transaction.

    sourceCurrency stringnullable

    The source currency of the payout.

    payoutOptions objectrequired

    Object containing information about the requirements for filling out Create Payout Request.

    supportedRecipientBanks string[]

    Array containing information about the parameters of available banks for the payout method. Provided only for instrumentType == bank_transfer.

Loading...