Recipients

Get recipient amount limits

This operation fetches amount limits for recipient.

get/v2/recipients/{id}/limits

Request

  • Base URL
    https://api.sandbox.payall.com
  • Auth
    OAuth 2
    Client credentials
    Token URL: /v2/oauth/token

Path parameters

idstring uuid required

The ID of the recipient for which to provide payment limits

Query parameters

payment_type'B2B' | 'B2P' | 'P2B' | 'P2P' required
countrystring iso-3166-alpha-2 required
Example:GB

Country for the payment. ISO-3166-1 alpha-2 value. Hint: It is GB, not UK.

instrument_category'BankAccount' | 'MobileWallet' | 'CashPickup' | 'Card' required
currencystring iso-4217 required
Example:EUR

The currency for which the limit should be provided. If there is no limit set in specified currency then limit will be returned in the base currency set for this account. Currency format ISO-4217

Response

Recipient amount limits

Example response

{
  "minimum": {
    "currency": "EUR",
    "value": 10023
  },
  "maximum": {
    "currency": "EUR",
    "value": 10023
  }
}

Changes

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