Recipients

View the schema for a Recipient

Changed on

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

get/v2.01/{ClientId}/recipients/schema

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/recipients/schema
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

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

Query parameters

PayoutMethodTypestring required

Allowed values: LocalBankTransfer, InternationalBankTransfer

The payout method.

Currencystring required

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.

Countrystring required

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

The destination country of the payout method.

RecipientTypestring required

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

Changes

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e731ec4a85bRevision changes
    • info

      api operation id view_recipient_schema removed and replaced with recipients_view_recipient_schema