Validate data for a Recipient

POST

/v2.01/:ClientId/users/:UserId/recipients/validate

POST

/v2.01/:ClientId/users/:UserId/recipients/validate

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/users/UserId/recipients/validate \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "BusinessRecipient": {
>       "Address": {
>         "AddressLine1": "3 rue de la Cité",
>         "AddressLine2": "Appartement 7",
>         "City": "Paris",
>         "Country": "FR",
>         "PostalCode": "75001",
>         "Region": "Ile de France"
>       },
>       "BusinessName": "Alex Smith Consulting"
>     },
>     "Country": "FR",
>     "Currency": "EUR",
>     "DisplayName": "Alex Smith EUR international payout account",
>     "InternationalBankTransfer": {
>       "AccountNumber": "FR7630004000031234567890143"
>     },
>     "PayoutMethodType": "InternationalBankTransfer",
>     "RecipientType": "Business",
>     "Tag": "Created using the Mangopay API Postman collection"
>   }
> }'

Check that the user's Recipient data is valid before creation A 200 HTTP response code indicates the request is valid against the schema. No response body is returned.

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.

UserIdstringRequired

The unique identifier of the user.

Request

This endpoint expects an object.

International IndividualobjectRequired

Request body for creating a Recipient where PayoutMethodType is InternationalBankTransfer and RecipientType is Individual.

International BusinessobjectRequired

Request body for creating a Recipient where PayoutMethodType is InternationalBankTransfer and RecipientType is Business.

Local IndividualobjectRequired

Request body for creating a Recipient where PayoutMethodType is LocalBankTransfer and RecipientType is Individual.

Local BusinessobjectRequired

Request body for creating a Recipient where PayoutMethodType is LocalBankTransfer and RecipientType is Business.

Response

Success

Errors

400

Bad Request Error