RequiredRequired fields must be sent. If the data is not sent Ravelin will return an error.
ImportantImportant fields are crucial for performance.
OptionalOptional fields are additional data points that can be shared with the
card schemes, issuers, and Ravelin. These fields may impact performance or dashboard usability.
ConditionalFields that may be required under certain conditions.
This is required if you want to associate the 3D Secure authentication with the customer.
Example:"123-abc-XYZ"
Minimum length: 1
transactionId
string
optional
Enterprise Merchants: the unique identifier for the transaction used on the Checkout endpoint.
PSPs: the unique identifier for the transaction used on the Transaction endpoint.
Required if you want to associate the 3D Secure authentication with the transaction.
Example:"123-abc-XYZ"
transactionStepId
string
optional
The unique identifier for the transaction step within the transaction used only for PSP clients on the Transaction endpoint.
Example:"123-abc-XYZ"
Minimum length: 1
cardScheme
string
optional
The card scheme that will be used to recommend version for co-badged cards.
Required if you want version recommendation for a domestic card scheme (e.g. Cartes Bancaires or eftpos).
Options:
American Express BOV Cashlink Cartes Bancaires eftpos Discover JCB Mastercard Visa
Sandbox Usage:
When testing in sandbox mode, requests are directed to Ravelin's simulated card scheme directory servers, not the actual scheme networks.
To test specific behaviors in the sandbox, use one of the special test values:
Ravelin (simulates the behaviour of an international card scheme like Mastercard or Visa) Ravelin Domestic (simulates the behaviour of a domestic card scheme like Cartes Bancaires or eftpos)
paymentMethodId
string
optional
Individual payment method identifier across the Ravelin platform. For an example of its use in this way, see the Checkout endpoint.
This can be used to associate the 3D Secure authentication with a payment method. The customerId field is also required to create this association.
It must be unique per payment method.
Example:"123-abc-XYZ"
Minimum length: 1
pan
string
conditional
The Primary Account Number (PAN) of the card being used for the transaction.
If EMV Tokenisation is supported, this may be an EMV Payment Token instead of a PAN.
This field is cardholder data. Submission of this field requires PCI DSS SAQ-D certification.