View the schema for a Recipient

GET

/v2.01/:ClientId/recipients/schema

GET

/v2.01/:ClientId/recipients/schema

curl -G https://api.sandbox.mangopay.com/v2.01/ClientId/recipients/schema \
     -H "Authorization: Bearer <token>" \
     -d Country=DE \
     -d Currency=EUR \
     -d PayoutMethodType=LocalBankTransfer \
     -d RecipientType=Individual

{
  "DisplayName": {
    "Required": true,
    "MaxLength": 50,
    "Pattern": "^(?!.*[&,'/]).{1,50}$",
    "Label": "Display Name",
    "EndUserDisplay": "Show"
  },
  "Currency": {
    "AllowedValues": [
      "EUR"
    ],
    "Required": true,
    "Label": "Currency",
    "EndUserDisplay": "Hide"
  },
  "Country": {
    "AllowedValues": [
      "DE"
    ],
    "Required": true,
    "Label": "Destination Country",
    "EndUserDisplay": "Hide"
  },
  "RecipientType": {
    "AllowedValues": [
      "Individual"
    ],
    "Required": true,
    "Label": "Recipient Type",
    "EndUserDisplay": "Hide"
  },
  "PayoutMethodType": {
    "AllowedValues": [
      "LocalBankTransfer"
    ],
    "Required": true,
    "Label": "Payout Method Type",
    "EndUserDisplay": "Hide"
  },
  "Tag": {
    "Required": false,
    "MaxLength": 255,
    "Pattern": "^.{0,255}$",
    "Label": "Tag",
    "EndUserDisplay": "Hide"
  },
  "RecipientScope": {
    "AllowedValues": [
      "PAYOUT",
      "PAYIN",
      "ALL"
    ],
    "Required": false,
    "Label": "Recipient Scope",
    "EndUserDisplay": "Hide"
  },
  "IndividualRecipient": {
    "FirstName": {
      "Required": true,
      "MaxLength": 255,
      "Pattern": "^(?!.*[()&,.:_/]).{1,255}$",
      "Label": "First Name",
      "EndUserDisplay": "Show"
    },
    "LastName": {
      "Required": true,
      "MaxLength": 255,
      "Pattern": "^(?!.*[()&,.:_/]).{1,255}$",
      "Label": "Last Name",
      "EndUserDisplay": "Show"
    },
    "Address": {
      "AddressLine1": {
        "Required": true,
        "MaxLength": 255,
        "Pattern": "^(?!.*[()/]).{1,255}$",
        "Label": "Address Line 1",
        "EndUserDisplay": "Show"
      },
      "AddressLine2": {
        "Required": false,
        "MaxLength": 255,
        "Pattern": "^(?!.*[()/]).{1,255}$",
        "Label": "Address Line 2",
        "EndUserDisplay": "Show"
      },
      "City": {
        "Required": true,
        "MaxLength": 80,
        "Pattern": "^(?!.*[&,.:_]).{1,80}$",
        "Label": "City",
        "EndUserDisplay": "Show"
      },
      "Country": {
        "Required": true,
        "MaxLength": 2,
        "Pattern": "^[a-zA-Z]+$",
        "Label": "Country",
        "EndUserDisplay": "Show",
        "MinLength": 2
      },
      "Region": {
        "Required": false,
        "MaxLength": 50,
        "Pattern": "^(?!.*[&,.:_/]).{1,50}$",
        "Label": "Region",
        "EndUserDisplay": "Show"
      },
      "PostalCode": {
        "Required": true,
        "MaxLength": 10,
        "Pattern": "^(?!.*[()&,.:_'/]).{1,10}$",
        "Label": "Postal Code",
        "EndUserDisplay": "Show"
      }
    }
  },
  "LocalBankTransfer": {
    "EUR": {
      "IBAN": {
        "EndUserDisplay": "Show",
        "Label": "IBAN",
        "MaxLength": 34,
        "Pattern": "^[a-zA-Z]{2}\\d{2}\\s*(\\w{4}\\s*){2,7}\\w{1,4}\\s*$",
        "Required": true
      }
    }
  }
}

Fetch the data requirements for a given currency, payout method type, and recipient type

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Path parameters

ClientIdstringRequired

Platform's API account identifier, associated with the API key.

Query parameters

PayoutMethodTypestringRequired

Allowed values: LocalBankTransfer, InternationalBankTransfer

The payout method.

CurrencystringRequired

Allowed values: The three-letter ISO 4217 code of a supported currency: AED, AUD, CAD, CHF, CNH, CZK, DKK, EUR, GBP, HKD, HUF, ILS, JPY, MXN, NOK, NZD, PLN, RON, SAR, SEK, SGD, TRY, USD, ZAR

The currency of the recipient.

CountrystringRequired

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The destination country of the payout method.

RecipientTypestringRequired

Allowed values: Individual, Business

The recipient type:

Individual – An account held by a natural person
Business – An account held by a legal entity

Response

Success

DisplayNameobjectOptional

Field metadata returned by GET View the schema for a Recipient.

CurrencyobjectOptional

Field metadata returned by GET View the schema for a Recipient, including allowed values.

CountryobjectOptional

Field metadata returned by GET View the schema for a Recipient, including allowed values.

RecipientTypeobjectOptional

Field metadata returned by GET View the schema for a Recipient, including allowed values.

PayoutMethodTypeobjectOptional

Field metadata returned by GET View the schema for a Recipient, including allowed values.

TagobjectOptional

Field metadata returned by GET View the schema for a Recipient.

RecipientScopeobjectOptional

Field metadata returned by GET View the schema for a Recipient, including allowed values.

IndividualRecipientobjectOptional

The schema of the IndividualRecipient property.

BusinessRecipientobjectOptional

The schema of the BusinessRecipient property.

InternationalBankTransferobjectOptional

The schema of the InternationalBankTransfer property.

FFC is only included if Currency is USD.

LocalBankTransferobjectOptional

The schema of the LocalBankTransfer property.

Errors

400

Bad Request Error