Recipients

View payout methods

Changed on

See payout methods available to your platform by currency and country

get/v2.01/{ClientId}/recipients/payout-methods

Request

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

Path parameters

ClientIdstring required

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

Query parameters

Currencystring required

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 payout method.

Countrystring required

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

The destination country of the payout method.

Response

Success

AvailablePayoutMethodsstring[]

Possible values: LocalBankTransfer, InternationalBankTransfer

The payout methods available for the currency and country combination.

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_payout_methods removed and replaced with recipients_view_payout_methods