Payouts

List canonical banks and Mobile Money operators

With a test API key, country=GH, currency=GHS, and type=bank or type=mobile_money returns the matching XRPay simulated destination. Its test_mode field is true; no real bank or Mobile Money operator is implied or contacted. Live keys never return simulator institutions.

get/api/v1/payout-institutions

Request

  • Base URL: https://api.xrpay.it
  • URL: https://api.xrpay.it/api/v1/payout-institutions
  • Auth: HTTP bearer

Query parameters

countrystring
currencystring
type'bank' | 'mobile_money'

Response

Canonical institution list

object'list' required

Changes

No recorded changes to this operation across all 1 revision of this API.