Forex

Get FX rates #

Use the Forex (FX) rates API to get the indicative foreign exchange rates that Payfac uses to process payments for card payouts or scheme acquiring. You can query the rates and the related source of rates (for example, Visa, Mastercard).

Authorizations

bearer

#
HTTP: bearer #

HTTP Authorization Scheme: bearer

Bearer format: JWT

query Parameters #
product requiredstring Enum:”card_payouts””scheme_acquiring”The Payfac Forex product to return rates for.
sourcer equiredstring Enum:”visa””mastercard”The source of provided rates.
currency_pairs requiredstring Example: currency_pairs=GBPEUR,USDNOK,JPNCADComma-separated list of currency pairs.
processing_channel_idr equiredstring^(pc)_(\w{26})$ Example: processing_channel_id=pc_vxt6yftthv4e5flqak6w2i7rimThe processing channel identifier.
header Parameters #
Authorization requiredstring
Responses #
200 Rates retrieved successfully
Response Schema: application/json #
productrequiredstring Enum:”card_payouts””scheme_acquiring”The Checkout.com Forex product.
sourcerequiredstring Enum:”visa””mastercard”The source of provided rates.
requiredArray of objects (ForexRateDto) List of FX rates with Checkout.com margin applied.
invalid_currency_pairsArray of stringsList of currency pairs that Checkout.com was unable to provide rates for.

401 Unauthorized

403 Forbidden. The client is not enabled for the requested product
Response Schema: application/json #
request_idrequiredstringThe unique request identifier.
error_typerequiredstringThe error type.
error_codesrequiredArray of stringsThe error codes.
422 Invalid data was sent
Response Schema: application/json #
request_idrequiredstringThe unique request identifier.
error_typerequiredstringThe error type.
error_codesrequiredArray of stringsThe error codes.
429 Too many requests or duplicate requests detected
Response Schema: application/json #
request_idrequiredstringThe unique request identifier.
error_typerequiredstringThe error type.
error_codesrequiredArray of stringsThe error codes.

502 Bad gateway

Leave a Reply

Your email address will not be published. Required fields are marked *

Scroll to Top