View a Recipient

Fetch a Recipient or legacy Bank Account based on its ID

GET /v2.01/{ClientId}/recipients/{RecipientId}

REST

// GET has no body parameters

VOP: ACTIVE, EUR, local, PAYOUT

{
    "Id": "rec_01K6DDEMYPH2NHC0F25BQFJCTK",
    "Status": "PENDING",
    "CreationDate": 1759239427,
    "DisplayName": "EuroCorp EUR FR account",
    "PayoutMethodType": "LocalBankTransfer",
    "RecipientType": "Business",
    "Currency": "EUR",
    "Country": "FR",
    "UserId": "user_m_01K5Y4XQA9HESYF8S9V70K16XH",
    "Tag": "Created using the Mangopay API Postman collection",
    "RecipientScope": "PAYOUT",
    "BusinessRecipient": {
        "BusinessName": "EuroCorp",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "île-de-France",
            "PostalCode": "75003",
            "Country": "FR"
        }
    },
    "LocalBankTransfer": {
        "EUR": {
            "IBAN": "FR7630001007941234567890185",
            "BIC": "BDFEFRPPCCT"
        }
    },
    "RecipientVerificationOfPayee": {
        "RecipientVerificationId": "9cd39426-d2b0-4f70-b79f-e54af433626f",
        "RecipientVerificationCheck": "MATCH",
        "RecipientVerificationMessage": "Account name fully matches account identifier."
    }
}

Verification of Payee (VOP) impacts SEPA local schemes, which means Recipients with Currency value EUR and PayoutMethod value LocalBankTransfer. Read more →

Path parameters

RecipientId · string · required

The unique identifier of the Recipient or legacy Bank Account (the legacy BankAccountId value can be used on this endpoint).

Responses

200

Id · string

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Status · string

Possible values: PENDING, CANCELED, ACTIVE, DEACTIVATED

The status of the recipient:

• PENDING – For PAYOUT scope recipients, the user must complete SCA before the recipient can become ACTIVE. For PAYIN scope recipients, the recipient creation is in progress.
• CANCELED – SCA was not successfully completed and the recipient creation request was canceled. To retry, create another recipient to retrieve another PendingUserAction.RedirectUrl. The CANCELED status does not apply if RecipientScope is PAYIN.
• ACTIVE – Recipient creation was successful (including SCA if RecipientScope is PAYOUT) and the recipient is ready to be used for payouts .
• DEACTIVATED – The recipient has been permanently deactivated and can no longer be used.

CreationDate · Unix timestamp

The date and time at which the object was created.

DisplayName · string

Length: 1–50; cannot contain: &,'/ (pattern:^(?!.*[&,'/]).{1,50}$)

A user-friendly name to identify the account. This value cannot be changed once the recipient is created.

PayoutMethodType · string

Possible values: InternationalBankTransfer, LocalBankTransfer

The payout method of the recipient:

• LocalBankTransfer – The account can only receive the corresponding local Currency for the Country via the domestic payment rail (e.g. EUR via a SEPA local scheme to a SEPA country, GBP via FPS to a GB account, USD via ACH to a US account, etc). Payouts in non-local currencies return an error.
• InternationalBankTransfer – The account can receive both non-local currencies via SWIFT and also local currency via domestic rails.

RecipientType · string

Possible values: Individual, Business

The recipient type:

• Individual – An account held by a natural person, requiring the IndividualRecipient property.
• Business – An account held by a legal entity, requiring the BusinessRecipient property.

Currency · string

Possible values: 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.

Country · string

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

The destination country of the payout method.

UserId · string

The unique identifier of the user.

RecipientScope · string

Possible values: PAYIN, PAYOUT

Default value: PAYOUT

The scope of the recipient:

• PAYOUT – Usable for payouts and in pay-in use cases. A PAYOUT recipient can only be created by a user with the UserCategory OWNER and requires SCA. You need to use the returned PendingUserAction.RedirectUrl value, adding your encoded returnUrl as a query parameter, to redirect the user to the hosted SCA session so they can complete the necessary steps.
• PAYIN - Not usable for payouts but only usable for pay-in use cases, such as direct debit and refunds using payouts. A PAYIN recipient can be created by a user with the UserCategory PAYER or OWNER, and does not require SCA.

Both PAYIN and PAYOUT scopes can be created for either InternationalBankTransfer or LocalBankTransfer, and for either IndividualRecipient or BusinessRecipient, and for any Currency.

Tag · string

Max. length: 255 (pattern: ^.{0,255}$)

Custom data that you can add to this object. This value cannot be changed once the recipient is created.

Individual

IndividualRecipient · object

The account holder if the RecipientType is Individual.

Show properties

FirstName · string

Length: 1–255; cannot contain: ()&,.:_/ (Pattern: ^(?!.*[()&,.:_/]).{1,255}$)

The first name of the individual account holder.

LastName · string

Length: 1–255; cannot contain: ()&,.:_/ (Pattern: ^(?!.*[()&,.:_/]).{1,255}$)

The last name of the individual account holder.

Address · object

Information about the address.

Show properties

AddressLine1 · string

Length: 1–255; cannot contain: ()/ (Pattern: ^(?!.*[()/]).{1,255}$)

The first line of the address.

AddressLine2 · string

Length: 1–255; cannot contain: ()/ (Pattern: ^(?!.*[()/]).{1,255}$)

The second line of the address. Parameter only returned if sent.

City · string

Length: 1-80; cannot contain: &,.:_' (pattern: ^(?!.*[&,.:_]).{1,80}$)

The city of the address.

Region · string

Length: 1–10; cannot contain: &,.:_'-/ (pattern: ^(?!.*[&,.:_/]).{1,50}$)

The region of the address. Parameter only returned if sent.

PostalCode · string

Length: 1–10; cannot contain: ()&,.:_'/ (pattern: ^(?!.*[()&,.:_'/]).{1,10}$)

The postal code of the address.

Country · string

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

The country of the address.

Business

BusinessRecipient · object

The account holder if the RecipientType is Business.

Show properties

BusinessName · string

Length: 1–255; cannot contain: (),.:/ (Pattern: ^(?!.*[(),.:/]).{1,255}$)

The name of the business account holder.

Address · object

Information about the address.

Show properties

AddressLine1 · string

Length: 1–255; cannot contain: ()/ (Pattern: ^(?!.*[()/]).{1,255}$)

The first line of the address.

AddressLine2 · string

Length: 1–255; cannot contain: ()/ (Pattern: ^(?!.*[()/]).{1,255}$)

The second line of the address. Parameter only returned if sent.

City · string

Length: 1-80; cannot contain: &,.:_' (pattern: ^(?!.*[&,.:_]).{1,80}$)

The city of the address.

Region · string

Length: 1–10; cannot contain: &,.:_'-/ (pattern: ^(?!.*[&,.:_/]).{1,50}$)

The region of the address. Parameter only returned if sent.

PostalCode · string

Length: 1–10; cannot contain: ()&,.:_'/ (pattern: ^(?!.*[()&,.:_'/]).{1,10}$)

The postal code of the address.

Country · string

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

The country of the address.

InternationalBankTransfer

InternationalBankTransfer · object

The account details if PayoutMethodType is InternationalBankTransfer.

Show properties

AccountNumber · string

The account number of the account.

BIC · string

The BIC of the account. For IBAN countries, the returned BIC is generated from the IBAN.

LocalBankTransfer

LocalBankTransfer · object

The account details if PayoutMethodType is LocalBankTransfer, depending on the Currency. One of:

CAD

CAD · object

Hide properties

AccountNumber · string

Format: 7–35 digits (pattern: ^\\d{7,35}$)

The account number of the Canadian account.

InstitutionNumber · string

Format: 3 digits (pattern: ^\\d{3}$)

The institution number of the Canadian account.

BranchCode · string

Format: 5 digits (pattern: ^\\d{5}$)

The branch code of the Canadian account.

BankName · string

Length: 1–50

The bank name of the Canadian account.

CHF

CHF · object

Hide properties

IBAN · string

Format: A valid IBAN (pattern: ^[a-zA-Z]{2}\\d{2}\\s*(\\w{4}\\s*){2,7}\\w{1,4}\\s*$)

The IBAN of the account.

CZK

CZK · object

Hide properties

IBAN · string

Format: A valid IBAN (pattern: ^[a-zA-Z]{2}\\d{2}\\s*(\\w{4}\\s*){2,7}\\w{1,4}\\s*$)

The IBAN of the account.

DKK

DKK · object

Hide properties

IBAN · string

Format: A valid IBAN (pattern: ^[a-zA-Z]{2}\\d{2}\\s*(\\w{4}\\s*){2,7}\\w{1,4}\\s*$)

The IBAN of the account.

EUR

EUR · object

Hide properties

IBAN · string

Format: A valid IBAN (pattern: ^[a-zA-Z]{2}\\d{2}\\s*(\\w{4}\\s*){2,7}\\w{1,4}\\s*$)

The IBAN of the account.

GBP

GBP · object

Hide properties

AccountNumber · string

Format: 8 digits (pattern: ^\\d{8}$)

The account number of the UK account.

SortCode · string

Format: 6 digits (pattern: ^\\d{6}$)

The sort code of the UK account.

HUF

HUF · object

Hide properties

IBAN · string

Format: A valid IBAN (pattern: ^[a-zA-Z]{2}\\d{2}\\s*(\\w{4}\\s*){2,7}\\w{1,4}\\s*$)

The IBAN of the account.

NOK

NOK · object

Hide properties

IBAN · string

Format: A valid IBAN (pattern: ^[a-zA-Z]{2}\\d{2}\\s*(\\w{4}\\s*){2,7}\\w{1,4}\\s*$)

The IBAN of the account.

PLN

PLN · object

Hide properties

IBAN · string

Format: A valid IBAN (pattern: ^[a-zA-Z]{2}\\d{2}\\s*(\\w{4}\\s*){2,7}\\w{1,4}\\s*$)

The IBAN of the account.

RON

RON · object

Hide properties

IBAN · string

Format: A valid IBAN (pattern: ^[a-zA-Z]{2}\\d{2}\\s*(\\w{4}\\s*){2,7}\\w{1,4}\\s*$)

The IBAN of the account.

SEK

SEK · object

Hide properties

IBAN · string

Format: A valid IBAN (pattern: ^[a-zA-Z]{2}\\d{2}\\s*(\\w{4}\\s*){2,7}\\w{1,4}\\s*$)

The IBAN of the account.

USD

USD · object

Hide properties

AccountNumber · string

Format: 8–12 alphanumeric characters (pattern: ^[0-9a-zA-Z]{8,12}$)

The account number of the US account.

ABA · string

Format: 9 digits (pattern: ^\\d{9}$)

The ABA routing number of the US account.

FFC · string

Format: 8-12 digits then FFC then a space then a sting of characters up to 140 total length (pattern: ^(?=.{0,140}$)[0-9]{8,12}/FFC [0-9a-zA-Z/\\-?:().,'+ ]+$)

FFC transfer information for the US account.

RecipientVerificationOfPayee · object

Information about the Verification of Payee (VOP) check performed on the Recipient. Because VOP only applies to SEPA local schemes, this object is returned null if the Recipient’s Currency is not EUR or its PayoutMethod is not LocalBankTransfer.

Show child attributes

RecipientVerificationId · string

The unique identifier of the VOP check. This value may be null if the check could not be performed.

RecipientVerificationCheck · string

Possible values: MATCH, CLOSE_MATCH, NO_MATCH, MATCH_NOT_POSSIBLE

The result of the VOP check:

• MATCH – The account is valid and the account name matches the IBAN.
• CLOSE_MATCH – The account is valid but the name doesn’t match exactly.
• NO_MATCH – This account likely belongs to a different owner.
• MATCH_NOT_POSSIBLE – The check could not be completed.

RecipientVerificationMessage · string

The explanation of the RecipientVerificationCheck:

• If MATCH, then Account name fully matches account identifier.
• If CLOSE_MATCH, then Account name partially matches account identifier. Name returned by check: {Name}. Payment made to this account may not reach its intended counterparty.
• If NO_MATCH, then Account name does not matches account identifier. Payment made to this account may not reach its intended counterparty.
• If MATCH_NOT_POSSIBLE, then Account name does not matches account identifier. Payment made to this account may not reach its intended counterparty.

RecipientVerificationPayeeSuggestedName · string

The name returned by the check in case of a CLOSE_MATCH result, which can be used to re-register the Recipient. This property is not returned on the check performed on a Payout request, even if the result is CLOSE_MATCH.

VOP: ACTIVE, EUR, local, PAYOUT

{
    "Id": "rec_01K6DDEMYPH2NHC0F25BQFJCTK",
    "Status": "PENDING",
    "CreationDate": 1759239427,
    "DisplayName": "EuroCorp EUR FR account",
    "PayoutMethodType": "LocalBankTransfer",
    "RecipientType": "Business",
    "Currency": "EUR",
    "Country": "FR",
    "UserId": "user_m_01K5Y4XQA9HESYF8S9V70K16XH",
    "Tag": "Created using the Mangopay API Postman collection",
    "RecipientScope": "PAYOUT",
    "BusinessRecipient": {
        "BusinessName": "EuroCorp",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "île-de-France",
            "PostalCode": "75003",
            "Country": "FR"
        }
    },
    "LocalBankTransfer": {
        "EUR": {
            "IBAN": "FR7630001007941234567890185",
            "BIC": "BDFEFRPPCCT"
        }
    },
    "RecipientVerificationOfPayee": {
        "RecipientVerificationId": "9cd39426-d2b0-4f70-b79f-e54af433626f",
        "RecipientVerificationCheck": "MATCH",
        "RecipientVerificationMessage": "Account name fully matches account identifier."
    }
}

REST

// GET has no body parameters