SchemaPayment FeaturesCards

Verify DCC eligibility

View as MarkdownOpen in Claude
> **Important:** There are restrictions on which merchants can use this method. For more information, go to [Dynamic Currency Conversion](https://docs.payroc.com/knowledge/card-payments/dynamic-currency-conversion). Use this method to check if a card is eligible for Dynamic Currency Conversion (DCC) and to retrieve the conversion rate for a transaction amount. DCC provides a customer with the option to use their card's currency instead of the merchant's currency, for example, in Ireland, an American customer can pay in US dollars instead of Euros. The request includes the following: - **Payment method** - Card information, a secure token, or digital wallet. - **Transaction information** - Amount and currency of the transaction in the merchant's currency. If the card is eligible for DCC, our gateway returns the transaction amount in the card's currency and a dccOffer object that contains information about the conversion rate. The dccOffer object contains the following fields that you need when you [run a sale](https://docs.payroc.com/api/schema/card-payments/payments/create) or [unreferenced refund](https://docs.payroc.com/api/schema/card-payments/refunds/create-unreferenced-refund) with DCC: - fxAmount - fxCurrency - fxRate - markup - accepted - offerReference

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
channelenumRequired
Channel that the merchant used to receive payment details for the transaction.
Allowed values:
processingTerminalIdstringRequired4-50 characters
Unique identifier that we assigned to the terminal.
baseAmountlongRequired

Total amount of the transaction in the merchant’s currency. The value is in the currency’s lowest denomination, for example, cents.

baseCurrencyenumRequired

Currency of the transaction. The value for the currency follows the ISO 4217 standard.

paymentMethodobjectRequired

Polymorphic object that contains payment details.

The value of the type parameter determines which variant you should use:

  • card - Payment card details
  • secureToken - Secure token details
  • digitalWallet - Digital wallet details
operatorstringOptional1-50 characters
Operator who ran the transaction.

Response

Successful request. Returns the currency conversion rate for the transaction.
processingTerminalIdstring4-50 characters
Unique identifier that we assigned to the terminal.
baseAmountlong

Total amount of the transaction in the local currency. The value is in the currency’s lowest denomination, for example, cents.

baseCurrencyenum

Currency of the transaction. The value for the currency follows the ISO 4217 standard.

inquiryResultobject

Object that indicates if the customer’s card is eligible for Dynamic Currency Conversion (DCC).

cardInfoobjectRead-only
Object that contains information about the card.
operatorstring0-50 characters
Operator who ran the transaction.
dccOfferobject

Object that contains information about the dynamic currency conversion (DCC) offer.

For more information about DCC, go to Dynamic Currency Conversion.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
406
Not Acceptable Error
409
Conflict Error
415
Unsupported Media Type Error
500
Internal Server Error