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 required string Enum:”card_payouts””scheme_acquiring”The Payfac Forex product to return rates for. sourcer equired string Enum:”visa””mastercard”The source of provided rates. currency_pairs required string Example: currency_pairs=GBPEUR,USDNOK,JPNCADComma-separated list of currency pairs. processing_channel_idr equired string^(pc)_(\w{26})$ Example: processing_channel_id=pc_vxt6yftthv4e5flqak6w2i7rimThe processing channel identifier.
Authorization required string
Responses #
200 Rates retrieved successfully
Response Schema: application/json #
productrequired string Enum:”card_payouts””scheme_acquiring”The Checkout.com Forex product. sourcerequired string Enum:”visa””mastercard”The source of provided rates.
required Array of objects (ForexRateDto) List of FX rates with Checkout.com margin applied. invalid_currency_pairs Array 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_idrequired stringThe unique request identifier. error_typerequired stringThe error type. error_codesrequired Array of stringsThe error codes.
422 Invalid data was sent
Response Schema: application/json #
request_idrequired stringThe unique request identifier. error_typerequired stringThe error type. error_codesrequired Array of stringsThe error codes.
429 Too many requests or duplicate requests detected
Response Schema: application/json #
request_idrequired stringThe unique request identifier. error_typerequired stringThe error type. error_codesrequired Array of stringsThe error codes.
502 Bad gateway