PApayall
Exchange

Request exchange rate information.

The exchange rate can be later used to initiate a new payment. Obtaining the exchange rate before payment is optional.

post/v2/exchange-rates

Request

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

Request body

source_account_idstring uuid

ID of the account to use as source of funds.

Provide either source or target amount to receive the opposite value.

source_currencystring iso-4217

Currency of the source amount.

This field is required only if both source_amount and source_account_id are NOT provided. This is useful if you're not using currency exchange markup based on payer segmentation (ie high volume business payers having different rates than individuals).

recipient_instrument_idstring

Represents recipient's payment instrument id of already existent entity.

This field is for backward compatibility and will be removed in the future. Please use payment_instrument_category instead.

payment_instrument_category'BankAccount' | 'MobileWallet' | 'CashPickup' | 'Card'
payment_type'B2B' | 'B2P' | 'P2B' | 'P2P'
target_currencystring iso-4217
destination_countrystring iso-3166-alpha-2 required

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

Example request

{
  "source_currency": "EUR",
  "source_amount": {
    "currency": "EUR",
    "value": 10023
  },
  "target_amount": {
    "currency": "EUR",
    "value": 10023
  },
  "target_currency": "GBP",
  "destination_country": "GB"
}

Response

Created

idstring uuid
expiration_datestring date-time

Exchange rate is valid until this date and time.

Example response

{
  "source_amount": {
    "currency": "EUR",
    "value": 10023
  },
  "target_amount": {
    "currency": "EUR",
    "value": 10023
  }
}

Changes

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