View a Recipient

GET

/v2.01/:ClientId/recipients/:RecipientId

GET

/v2.01/:ClientId/recipients/:RecipientId

curl https://api.sandbox.mangopay.com/v2.01/{ClientId}/recipients/{RecipientId} \
     -H "Authorization: Bearer <token>"

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

Fetch a Recipient or legacy Bank Account based on its ID

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

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.

RecipientIdstringRequired

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

Response

Success

International Individualobject

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

International Businessobject

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

Local Individualobject

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

Local Businessobject

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