v1

latestOpenAPI 3.0.02026-07-24103118224.7 KB

Accounts

Get the bank form schema for a country

Returns the required fields for a bank payout destination. Each field includes requestBodyPath (e.g. bank.iban) showing where it belongs in the nested POST /api/account/bank body under bank, owner, or address. Pass includeExample=true for a sample nested request body.

get/api/account/bank-form

Query parameters

countrystring required

Example:US

ISO-3166 alpha-2 country code

type'INDIVIDUAL' | 'BUSINESS' required

Business type of the merchant

includeExampleboolean

When true, wraps the form in { form, requestBodyExample } with a sample nested POST /api/account/bank body. Default response remains a bare array.

Response

Get the bank form schema for a country successful

Get the bank form schema for a country with nested request body example

requestBodyExampleobject required

Sample nested request body for POST /api/account/bank for the requested country and business type.

Example response

{
  "form": [
    {
      "id": "bank",
      "requestBodyKey": "bank",
      "fields": [
        {
          "id": "bank.iban",
          "requestBodyPath": "bank.iban",
          "type": "input",
          "size": "full",
          "options": [
            "SAVINGS",
            "CHECKING"
          ],
          "value": "FR",
          "schema": {
            "type": "string",
            "minLength": 5,
            "pattern": "^[A-Z]{2}"
          },
          "props": {
            "placeholder": "FR76…",
            "required": true
          }
        }
      ]
    }
  ],
  "requestBodyExample": {
    "country": "FR",
    "bank": {
      "iban": "FR1420041010050500013M02606",
      "bic": "PSSTFRPPXXX"
    },
    "owner": {
      "businessType": "INDIVIDUAL",
      "firstName": "Jean",
      "lastName": "Dupont"
    }
  }
}