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 PayoutMethodType=InternationalBankTransfer \
>      -d Currency=EUR \
>      -d Country=US \
>      -d RecipientType=Individual

1 {
2   "DisplayName": {
3     "Required": true,
4     "MaxLength": 50,
5     "Pattern": "^(?!.*[&,'/]).{1,50}$",
6     "Label": "Display Name",
7     "EndUserDisplay": "Show"
8   },
9   "Currency": {
10     "AllowedValues": [
11       "EUR",
12       "EUR"
13     ],
14     "Required": true,
15     "MaxLength": 3,
16     "MinLength": 3,
17     "Pattern": "^[a-zA-Z]{3}$",
18     "Label": "Currency",
19     "EndUserDisplay": "Hide"
20   },
21   "Country": {
22     "AllowedValues": [
23       "US",
24       "US"
25     ],
26     "Required": true,
27     "MaxLength": 2,
28     "MinLength": 2,
29     "Pattern": "^[a-zA-Z]{2}$",
30     "Label": "Destination Country",
31     "EndUserDisplay": "Hide"
32   },
33   "RecipientType": {
34     "AllowedValues": [
35       "Individual",
36       "Individual"
37     ],
38     "Required": true,
39     "Pattern": "^[a-zA-Z]+$",
40     "Label": "Recipient Type",
41     "EndUserDisplay": "Hide"
42   },
43   "PayoutMethodType": {
44     "AllowedValues": [
45       "InternationalBankTransfer",
46       "InternationalBankTransfer"
47     ],
48     "Required": true,
49     "Pattern": "^[a-zA-Z]+$",
50     "Label": "Payout Method Type",
51     "EndUserDisplay": "Hide"
52   },
53   "Tag": {
54     "Required": false,
55     "MaxLength": 255,
56     "Pattern": "^.{0,255}$",
57     "Label": "Tag",
58     "EndUserDisplay": "Hide"
59   },
60   "RecipientScope": {
61     "AllowedValues": [
62       "PAYOUT",
63       "PAYIN",
64       "PAYOUT",
65       "PAYIN"
66     ],
67     "Required": false,
68     "Pattern": "^[a-zA-Z]+$",
69     "Label": "Recipient Scope",
70     "EndUserDisplay": "Hide"
71   },
72   "IndividualRecipient": {
73     "FirstName": {
74       "Required": true,
75       "MaxLength": 255,
76       "Pattern": "^(?!.*[()&,.:_/]).{1,255}$",
77       "Label": "First Name",
78       "EndUserDisplay": "Show"
79     },
80     "LastName": {
81       "Required": true,
82       "MaxLength": 255,
83       "Pattern": "^(?!.*[()&,.:_/]).{1,255}$",
84       "Label": "Last Name",
85       "EndUserDisplay": "Show"
86     },
87     "Address": {
88       "AddressLine1": {
89         "Required": true,
90         "MaxLength": 255,
91         "Pattern": "^(?!.*[()/]).{1,255}$",
92         "Label": "Address Line 1",
93         "EndUserDisplay": "Show"
94       },
95       "AddressLine2": {
96         "Required": false,
97         "MaxLength": 255,
98         "Pattern": "^(?!.*[()/]).{1,255}$",
99         "Label": "Address Line 2",
100         "EndUserDisplay": "Show"
101       },
102       "City": {
103         "Required": true,
104         "MaxLength": 80,
105         "Pattern": "^(?!.*[&,.:_]).{1,80}$",
106         "Label": "City",
107         "EndUserDisplay": "Show"
108       },
109       "Country": {
110         "Required": true,
111         "MaxLength": 2,
112         "Pattern": "^[a-zA-Z]+$",
113         "Label": "Country",
114         "EndUserDisplay": "Show",
115         "MinLength": 2
116       },
117       "Region": {
118         "Required": false,
119         "MaxLength": 50,
120         "Pattern": "^(?!.*[&,.:_/]).{1,50}$",
121         "Label": "Region",
122         "EndUserDisplay": "Show"
123       },
124       "PostalCode": {
125         "Required": true,
126         "MaxLength": 10,
127         "Pattern": "^(?!.*[()&,.:_'/]).{1,10}$",
128         "Label": "Postal Code",
129         "EndUserDisplay": "Show"
130       }
131     }
132   },
133   "InternationalBankTransfer": {
134     "AccountNumber": {
135       "Required": true,
136       "MaxLength": 12,
137       "MinLength": 8,
138       "Pattern": "^[0-9a-zA-Z]{8,12}$",
139       "Label": "Account Number",
140       "EndUserDisplay": "Show"
141     },
142     "BIC": {
143       "Required": true,
144       "Pattern": "^[0-9a-zA-Z]{8}([0-9a-zA-Z]{3})?$",
145       "Label": "BIC",
146       "EndUserDisplay": "Show"
147     }
148   }
149 }

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.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) 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.

**Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> of a <a href="/guides/currencies" target="_blank">supported currency</a>: `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

**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

DisplayNameobject

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

Currencyobject

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

Countryobject

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

RecipientTypeobject

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

PayoutMethodTypeobject

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

Tagobject

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

RecipientScopeobject

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

IndividualRecipientobject

The schema of the IndividualRecipient property.

BusinessRecipientobject

The schema of the BusinessRecipient property.

InternationalBankTransferobject

The schema of the InternationalBankTransfer property.

LocalBankTransferobject

The schema of the LocalBankTransfer property.

Errors

400

Bad Request Error