Skip to main content
Create DCC Rate Offer

Authorizations

Authorization
string
header
required

JWT authentication with PKI certificates. Token must include x5c header with certificate chain and digest claim for request body validation.

Headers

X-Correlation-ID
string

Optional correlation ID for request tracing

x-acquirer-id
string
required

3-letter alphabetic acquirer identifier (must match the Acquirer ID used to generate the CSR)

Pattern: ^[A-Z]{3}$
Example:

"ABC"

x-card-acceptor-id
string
required

Numeric card acceptor code (merchant ID), 1-16 digits

Pattern: ^[0-9]{1,16}$
Example:

"998877"

Body

application/json

DCC rate offer request containing transaction details, payment info, and order information

transactionType
enum<string>
required

Type of transaction being processed

Available options:
PURCHASE,
REFUND,
CASH_ADVANCE,
REVERSAL,
PREAUTHORIZATION,
INCREMENTAL_AUTHORIZATION,
COMPLETE_AUTHORIZATION
Example:

"PURCHASE"

paymentDetails
object
required

Payment card and transaction entry details

orderDetails
object
required

Order details including amount, fee, and currency

referenceCode
string

Optional unique reference code for the transaction (Currently used for traceability in the logs, recommended to include)

Example:

"TXN-2025-001234"

terminalInformation
object

Terminal information for POS and ATM transactions

Example:

Response

Successfully created DCC rate offer

Response containing the DCC rate offer details including exchange rates, amounts, and offer status

id
string<uuid>
required

Unique identifier for this specific rate offer (used for tracking and acceptance)

Example:

"550e8400-e29b-41d4-a716-446655440000"

transactionType
enum<string>
required

Type of transaction this offer applies to

Available options:
PURCHASE,
REFUND,
CASH_ADVANCE,
REVERSAL,
PREAUTHORIZATION,
INCREMENTAL_AUTHORIZATION,
COMPLETE_AUTHORIZATION
Example:

"PURCHASE"

baseAmount
string
required

Transaction amount in the base (merchant) currency

Example:

"100.0"

foreignAmount
string
required

Transaction amount converted to the cardholder's foreign currency

Example:

"110.5"

exchangeRate
object
required

Detailed exchange rate information including base/foreign currencies, rate, margins, and expiry

issueAt
string<date-time>
required

Timestamp when this rate offer response was generated

Example:

"2025-10-08T14:30:00Z"

referenceCode
string

Optional Reference code from the original request (Currently used for traceability in the logs, recommended to include)

Example:

"TXN-2025-001234"

foreignFeeAmount
string

Optional fee amount in the foreign currency

Example:

"2.75"

foreignTotalAmount
string

Total amount in foreign currency (foreignAmount + foreignFeeAmount). If not provided, it can be computed from foreignAmount and foreignFeeAmount

Example:

"113.25"

offerText
string

Ready-to-use text for DCC offer presentation with resolved exchange rates and amounts. Server-side processed for immediate display.

Example:

"Accept currency conversion at rate 1.1050? You will pay 110.50 USD instead of 100.00 EUR."

receiptText
string

Ready-to-use text for receipt display with resolved exchange rates and amounts. Server-side processed for immediate display.

Example:

"Currency conversion applied: 100.00 EUR = 110.50 USD at rate 1.1050"