Retrieve Required Payout Fields

POST 
/payouts/fields

This endpoint has replaced the GET endpoint because the POST endpoint provides more data and supports more providers.

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

Request

application/json

Body

required

instrumentType stringrequired

Possible values: [bank_transfer, card, wallet]

The instrument type for which the required fields are being requested.

providerCode stringrequired

The provider code for which the required fields are being requested.

acquirerCode stringrequired

The acquirer code for which the required fields are being requested.

payoutSettings objectrequired

region stringrequired

Possible values: Value must match regular expression ^[A-Z]{2}$

The payment region for which the required fields are being requested. Region should be specified by its ISO 3166-1 alpha-2 code.

currency stringrequired

Possible values: Value must match regular expression ^[A-Z]{3}$

The payment currency for which the required fields are being requested. Specifies the currency in ISO 4217 alphabetic code format, consisting of 3 uppercase letters.

transferType string

Possible values: [bank_wire, sepa, swift, sbp, card2card, pix, online_banking, qris, promptpay, vietqr, vietnambanksqr, virtual_account, khipu, giropay, eps, open_finance]

The type of bank transfer for which the required fields are being requested. Required for instrumentType = bank_transfer. See details about transferType

Responses

200

A list of required fields for the specified payout method. The response format for the recipient and sender objects is the same. The recipient object is always included in the response, while the sender object is included only for those payouts where it is necessary.

application/json

Schema

Schema

data objectrequired
recipient object[]required
Array [
key stringrequired
The name of the parameter expected in the payout request within the recipient or sender object.
label stringrequired
Human-readable name for the key parameter. Can be used for displaying to the user on the front end.
category stringrequired
Possible values: [personalData, addressData, billingAddressData, shippingAddressData, documentData, cardData, walletData, bankTransferData, paymentData, payoutData]
Indicates in which object the key parameter should be passed in during a payout request.
personalData - Personal identification and contact information of the recipient or sender.
addressData - Address information for the payout recipient or sender.
billingAddressData - Billing address information for the payout recipient or sender.
shippingAddressData - Shipping address information for the payout recipient or sender.
documentData - Information required for verifying the identity of the recipient or sender.
cardData - Information required for processing a payout via debit/credit card for the recipient or sender.
walletData - Information required for processing a payout via e-wallet for the recipient or sender.
bankTransferData - Information required for processing a payout via bank transfer for the recipient or sender.
payoutData - Information related to the payout details, such as fee responsibility and source currency.
paymentData - Information about the payment channel used for processing the payout.
validation objectrequired
Object containing validation information for the value passed for the key parameter during a payout request.
pattern stringnullable
Validation requirements for the value passed for the key parameter during a payout request, provided in regex format.
minLenght integernullable
Minimum length requirement for the value passed for the key parameter.
maxLenght integernullable
Maximum length requirement for the value passed for the key parameter.
type stringrequired
Possible values: [date, text, email, tel, select, number, isMultiple, checkbox]
Default value: text
The field type for the key value, which can be displayed on the front end for the user.
date - date in ISO 8601 format, e.g., YYYY-MM-DD
text - text field
email - email field
tel - phone number field
select - dropdown list with a single selection
number - number field
isMultiple - dropdown list with multiple selections
checkbox - checkbox selection
required booleanrequired
Default value: true
Indicates whether the key and its value are mandatory for initiating a payout.
options object[]nullable
Array of objects containing information about acceptable values. The key should be passed with one of the acceptable values to initiate a payout.
If this array contains elements, you must choose one of these values and cannot pass a custom value.
Array [
value stringnullablerequired
Acceptable value
label stringnullablerequired
Human-readable text description of the value.
]
]
sender object[]
Array [
key stringrequired
The name of the parameter expected in the payout request within the recipient or sender object.
label stringrequired
Human-readable name for the key parameter. Can be used for displaying to the user on the front end.
category stringrequired
Possible values: [personalData, addressData, billingAddressData, shippingAddressData, documentData, cardData, walletData, bankTransferData, paymentData, payoutData]
Indicates in which object the key parameter should be passed in during a payout request.
personalData - Personal identification and contact information of the recipient or sender.
addressData - Address information for the payout recipient or sender.
billingAddressData - Billing address information for the payout recipient or sender.
shippingAddressData - Shipping address information for the payout recipient or sender.
documentData - Information required for verifying the identity of the recipient or sender.
cardData - Information required for processing a payout via debit/credit card for the recipient or sender.
walletData - Information required for processing a payout via e-wallet for the recipient or sender.
bankTransferData - Information required for processing a payout via bank transfer for the recipient or sender.
payoutData - Information related to the payout details, such as fee responsibility and source currency.
paymentData - Information about the payment channel used for processing the payout.
validation objectrequired
Object containing validation information for the value passed for the key parameter during a payout request.
pattern stringnullable
Validation requirements for the value passed for the key parameter during a payout request, provided in regex format.
minLenght integernullable
Minimum length requirement for the value passed for the key parameter.
maxLenght integernullable
Maximum length requirement for the value passed for the key parameter.
type stringrequired
Possible values: [date, text, email, tel, select, number, isMultiple, checkbox]
Default value: text
The field type for the key value, which can be displayed on the front end for the user.
date - date in ISO 8601 format, e.g., YYYY-MM-DD
text - text field
email - email field
tel - phone number field
select - dropdown list with a single selection
number - number field
isMultiple - dropdown list with multiple selections
checkbox - checkbox selection
required booleanrequired
Default value: true
Indicates whether the key and its value are mandatory for initiating a payout.
options object[]nullable
Array of objects containing information about acceptable values. The key should be passed with one of the acceptable values to initiate a payout.
If this array contains elements, you must choose one of these values and cannot pass a custom value.
Array [
value stringnullablerequired
Acceptable value
label stringnullablerequired
Human-readable text description of the value.
]
]

Example (from schema)

{
  "data": {
    "recipient": [
      {
        "key": "firstName",
        "label": "First Name",
        "category": "personalData",
        "validation": {
          "pattern": "^.{1-50}$",
          "minLenght": 1,
          "maxLenght": 50,
          "type": "text",
          "required": true
        },
        "options": [
          {
            "value": "C",
            "label": "Checking account"
          }
        ]
      }
    ],
    "sender": [
      {
        "key": "firstName",
        "label": "First Name",
        "category": "personalData",
        "validation": {
          "pattern": "^.{1-50}$",
          "minLenght": 1,
          "maxLenght": 50,
          "type": "text",
          "required": true
        },
        "options": [
          {
            "value": "C",
            "label": "Checking account"
          }
        ]
      }
    ]
  }
}

Loading...