The time at which this data payload was valid. When sending events in realtime, this will usually be 'now'. This is used to merge data that arrives out-of-order.
A unix timestamp preferably as an
integer count of milliseconds since 1970-01-01T00:00 UTC
(nanoseconds are also accepted).
|
An eventType should identify what event in your system triggered this API call.
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]*$
|
The unique identifier of the customer. If your system allows anonymous
checkout then we recommend making this the customer's email address.
|
A temporary ID for a customer when the real account ID has yet to be
minted. This must eventually be sent in conjunction with a real customer
ID to migrate the data into the full customer account.
|
The payment method being registered by the customer.
One of the following:
|
|
card: A credit or debit card.
Show definition
|
Vault card payment method indicator.
One of:
card, creditcard, or debitcard.
|
A unique identifier for this payment method, specific to this customer. Two
customers should not use the same paymentMethodId.
|
The card network or scheme, such as visa or mastercard. Ravelin will identify the scheme on your behalf if you send the cardBin, which should be preferred.
|
A unique identifier for the physical card, shared between customers. Used
to link cards in Connect. Must not be a hash of the PAN.
If you use multiple PSPs who each generate their own equivalent of an
instrumentId, you should consider prefixing their values to indicate
their origin to avoid collisions. Common examples include Stripe's
fingerprint,
or Braintree's
unique_number_identifier).
|
The full Primary Account Number of the card. Used by Ravelin to generate the instrumentId for this card.
If specified, you do not need to provide instrumentId, cardBin or cardLastFour.
Only PCI DSS SAQ-D certified merchants should submit the PAN to Ravelin. You must not send requests
containing this field to api.ravelin.com, and must instead use pci.ravelin.com.
Please see our PCI DSS documentation for more information.
|
The first six or eight digits of the card number/PAN. The Bank Identification
Number (BIN), recently more commonly known as the Issuer
Identification Number (IIN).
Given the BIN, Ravelin will populate the issuer, country of issuance,
and card type on your behalf.
|
The last four digits of the card number/PAN. Please note this will be truncated to the last two digits when an eight digit BIN is provided.
|
The card issuer, who the true cardholder will report fraud to. Ravelin
will identify the issuer on your behalf if you send the cardBin,
which should be preferred.
|
Whether this is a prepaid debit card. Ravelin will identify whether
the card is prepaid on your behalf if you send the cardBin which
should be preferred.
|
The country that the card was issued in. Ravelin will identify the
country of issuance on your behalf if you send the cardBin, which
should be preferred.
A ISO 3166-1 Alpha 3
or Alpha 2 country
code.
|
The expiry month of the card.
|
The expiry year of the card.
|
The e-Wallet to which the customer associated the card.
One of:
applepay, googlepay, samsungpay, amazonpay, or visacheckout.
|
|
|
The address of the registered cardholder, as used to pass
AVS
checks. It is common to have fewer location details for this address,
but provide what you have.
|
|
|
The postal or zip code. If provided without latitude or longitude, Ravelin will perform coarse geolocation in some countries.
|
The latitude of the location.
|
The longitude of the location.
|
The name of the person that will accept delivery of goods to this address.
|
The street address of the location.
|
The street address of the location.
|
The neighbourhood of the location.
|
The zone of the location.
|
|
|
The state/county of the location.
|
The PO box number related to the location.
|
Custom data that is relevant to your domain. This can be any json object.
Please include any details that you think are relevant to fraud that our
schema does not capture.
|
The geohash of the location.
|
|
Whether this payment method is a corporate card.
|
Whether this payment method is a virtual card.
|
Whether the card was successfully registered with your gateway/PSP.
|
The time that the card was saved to the customer's account. (Not the card start date.)
A unix timestamp preferably as an
integer count of milliseconds since 1970-01-01T00:00 UTC
(nanoseconds are also accepted).
|
The time at which the payment method was last verified by the customer.
An example mechanism would be a random amount charged to the
customer's card that they can confirm the amount of.
A unix timestamp preferably as an
integer count of milliseconds since 1970-01-01T00:00 UTC
(nanoseconds are also accepted).
|
Whether the card has been compromised.
|
The reason why the card is considered compromised.
One of:
cloned, databreach, found, lost, stolen, frozen, defrosted, or uncompromised.
|
Custom data that is relevant to your domain. This can be any json object.
Please include any details that you think are relevant to fraud that our
schema does not capture.
|
active
boolean
optional
deprecated
Whether this card is still saved to the customer's account.
|
banned
boolean
optional
deprecated
Whether this card has been banned.
|
The nickname the customer has given the payment method.
|
The card network or scheme, such as visa or mastercard. Ravelin
will identify the cardType on your behalf if you send the cardBin,
which should be preferred.
|
|
|
paymentMethodCipher: An encrypted payment method, containing the full card details encrypted via a
Ravelin SDK.
Show definition
|
Client-side encrypted card payment method indicator.
Only:
paymentMethodCipher.
|
The card ciphertext produced by the Ravelin SDK card encryption.
This field constitutes cardholder data, and submission of this field therefore requires PCI DSS
SAQ-A or SAQ-AEP certification. You must not send requests containing this field to
api.ravelin.com, and must instead use pci.ravelin.com.
Please see our PCI DSS documentation for more information.
|
The AES Key ciphertext produced by the Ravelin SDK card encryption.
|
The algorithm used to generate the ciphertexts.
|
A unique identifier for this payment method, specific to this customer. Two
customers should not use the same paymentMethodId.
|
The version of the Ravelin SDK that performed this encryption.
|
The index of the public RSA key used to encrypt the card.
|
An identifier for the public key used during encryption.
|
|
Show definition
|
|
|
The postal or zip code. If provided without latitude or longitude, Ravelin will perform coarse geolocation in some countries.
|
The latitude of the location.
|
The longitude of the location.
|
The name of the person that will accept delivery of goods to this address.
|
The street address of the location.
|
The street address of the location.
|
The neighbourhood of the location.
|
The zone of the location.
|
|
|
The state/county of the location.
|
The PO box number related to the location.
|
Custom data that is relevant to your domain. This can be any json object.
Please include any details that you think are relevant to fraud that our
schema does not capture.
|
The geohash of the location.
|
|
When the payment method was added to the customer's account. Note: this is not the card start date.
A unix timestamp preferably as an
integer count of milliseconds since 1970-01-01T00:00 UTC
(nanoseconds are also accepted).
|
The version of the ravelinjs library that performed this encryption.
|
|
|
cash: The customer is paying in cash, or a cash-based payment method.
Show definition
|
Indicator of a cash payment, or cash-based payment method (e.g. paysafecard).
Only:
cash.
|
The name of the cash-based payment service used, if applicable.
|
|
|
bankaccount: Bank Accounts.
Show definition
|
|
|
A unique identifier for this payment method, specific to this customer. Two
customers should not use the same paymentMethodId.
|
The type of transfer: whether the customer is initiating the payment, or you are withdrawing funds from the customer's bank account based on an agreement to initiate payments on their behalf. Use "push" for a customer-initiated payment (e.g. a bank transfer) and "pull" for a merchant-initiated payment (e.g. Direct Debit).
One of:
push, or pull.
|
The name of the payment scheme or instrument used for the transfer of funds.
|
IBAN (International Bank Account Number)
Following the ISO 13616:2007 standard.
|
|
|
|
Show definition
|
|
|
The postal or zip code. If provided without latitude or longitude, Ravelin will perform coarse geolocation in some countries.
|
The latitude of the location.
|
The longitude of the location.
|
The name of the person that will accept delivery of goods to this address.
|
The street address of the location.
|
The street address of the location.
|
The neighbourhood of the location.
|
The zone of the location.
|
|
|
The state/county of the location.
|
The PO box number related to the location.
|
Custom data that is relevant to your domain. This can be any json object.
Please include any details that you think are relevant to fraud that our
schema does not capture.
|
The geohash of the location.
|
|
The type of the account.
One of the following:
SAVINGS: A savings account, which is designed to help customers save money and earn interest.CURRENT: A checking account, which is designed for frequent transactions and typically has low or no interest rates.
|
The name of the account owner.
|
The type of customer or entity that the account is associated with, whether it's an individual or a business.
One of the following:
PERSONAL: A bank account owned and used by an individual for personal transactions. Can include joint accounts.BUSINESS: A bank account owned by a company or organisation for business transactions.
|
Code assigned by central bank to identify bank that account is associated with.
Multiple bank code formats are supported.
|
Name of bank which account belongs to.
|
BIC - business identifier code for banks and other institutions.
Following the ISO9362 standard.
|
The account number issued by the bank.
|
The nickname for the payment method that the customers gives, if applicable.
|
The time that the card was saved to the customer's account. (Not the card start date.)
A unix timestamp preferably as an
integer count of milliseconds since 1970-01-01T00:00 UTC
(nanoseconds are also accepted).
|
Custom data that is relevant to your domain. This can be any json object.
Please include any details that you think are relevant to fraud that our
schema does not capture.
|
|
|
paypal: PayPal payments.
Show definition
|
|
|
A unique identifier for this payment method, specific to this customer. Two
customers should not use the same paymentMethodId.
|
|
|
|
|
The address of the account holder. It is common to have fewer location
details for this address, but provide what you have.
|
|
|
The postal or zip code. If provided without latitude or longitude, Ravelin will perform coarse geolocation in some countries.
|
The latitude of the location.
|
The longitude of the location.
|
The name of the person that will accept delivery of goods to this address.
|
The street address of the location.
|
The street address of the location.
|
The neighbourhood of the location.
|
The zone of the location.
|
|
|
The state/county of the location.
|
The PO box number related to the location.
|
Custom data that is relevant to your domain. This can be any json object.
Please include any details that you think are relevant to fraud that our
schema does not capture.
|
The geohash of the location.
|
|
The time that the card was saved to the customer's account. (Not the card start date.)
A unix timestamp preferably as an
integer count of milliseconds since 1970-01-01T00:00 UTC
(nanoseconds are also accepted).
|
The time at which the payment method was last verified by the customer.
An example mechanism would be a random amount charged to the
customer's card that they can confirm the amount of.
A unix timestamp preferably as an
integer count of milliseconds since 1970-01-01T00:00 UTC
(nanoseconds are also accepted).
|
The nickname for the payment method that the customer gives, if applicable.
|
|
|
|
|
Custom data that is relevant to your domain. This can be any json object.
Please include any details that you think are relevant to fraud that our
schema does not capture.
|
banned
boolean
optional
deprecated
If the payment method has been banned
|
active
boolean
optional
deprecated
Whether the payment method is active for use by this account
|
|
|
credit: This payment method type should be used for any payments made using credit that a customer has with the merchant.
Show definition
|
Credit payment indicator.
Only:
credit.
|
A unique identifier for this payment method, specific to this customer. Two
customers should not use the same paymentMethodId.
|
The name of the store credit scheme used as a payment method, if applicable.
|
When the payment method was added to the customer's account.
A unix timestamp preferably as an
integer count of milliseconds since 1970-01-01T00:00 UTC
(nanoseconds are also accepted).
|
A unix timestamp preferably as an
integer count of milliseconds since 1970-01-01T00:00 UTC
(nanoseconds are also accepted).
|
Custom data that is relevant to your domain. This can be any json object.
Please include any details that you think are relevant to fraud that our
schema does not capture.
|
|
|
invoice: This payment method should be used whenever the merchant provides credit to the customer.
Show definition
|
Invoice payment indicator.
Only:
invoice.
|
A unique identifier for this payment method, specific to this customer. Two
customers should not use the same paymentMethodId.
|
The name of the invoice or 'buy now, pay later' scheme used, if applicable.
|
When the payment method was added to the customer's account.
A unix timestamp preferably as an
integer count of milliseconds since 1970-01-01T00:00 UTC
(nanoseconds are also accepted).
|
A unix timestamp preferably as an
integer count of milliseconds since 1970-01-01T00:00 UTC
(nanoseconds are also accepted).
|
The nickname for the payment method that the customers gives, if applicable.
|
|
Show definition
|
|
|
The postal or zip code. If provided without latitude or longitude, Ravelin will perform coarse geolocation in some countries.
|
The latitude of the location.
|
The longitude of the location.
|
The name of the person that will accept delivery of goods to this address.
|
The street address of the location.
|
The street address of the location.
|
The neighbourhood of the location.
|
The zone of the location.
|
|
|
The state/county of the location.
|
The PO box number related to the location.
|
Custom data that is relevant to your domain. This can be any json object.
Please include any details that you think are relevant to fraud that our
schema does not capture.
|
The geohash of the location.
|
|
The email address used by the customer to register an invoice or 'buy now, pay later' payment method.
|
Custom data that is relevant to your domain. This can be any json object.
Please include any details that you think are relevant to fraud that our
schema does not capture.
|
|
|
wallet: A digital wallet payment method.
Show definition
|
Vault card payment method indicator.
Only:
wallet.
|
A unique identifier for this payment method, specific to this customer. Two
customers should not use the same paymentMethodId.
|
The name of the digital wallet scheme or electronic payment service.
|
The card network or scheme of the card used within a wallet payment method,
such as visa or mastercard. Ravelin will identify the cardScheme on your behalf
if you send the cardBin, which should be preferred.
|
A unique identifier for the physical card, shared between customers. Used
to link cards in Connect. Must not be a hash of the PAN.
If you use multiple PSPs who each generate their own equivalent of an
instrumentId, you should consider prefixing their values to indicate
their origin to avoid collisions. Common examples include Stripe's
fingerprint,
or Braintree's
unique_number_identifier).
|
The full Primary Account Number of the card. Used by Ravelin to generate the instrumentId for this card.
If specified, you do not need to provide instrumentId, cardBin or cardLastFour.
Only PCI DSS SAQ-D certified merchants should submit the PAN to Ravelin. You must not send requests
containing this field to api.ravelin.com, and must instead use pci.ravelin.com.
Please see our PCI DSS documentation for more information.
|
The first six digits of the card number/PAN. The Bank Identification
Number (BIN), recently more commonly known as the Issuer
Identification Number (IIN).
Given the BIN, Ravelin will populate the issuer, country of issuance,
and card type on your behalf.
|
The last four digits of the card number/PAN.
|
The card network or scheme, such as visa or mastercard. Ravelin
will identify the cardType on your behalf if you send the cardBin,
which should be preferred.
|
The card issuer, who the true cardholder will report fraud to. Ravelin
will identify the issuer on your behalf if you send the cardBin,
which should be preferred.
|
Whether this is a prepaid debit card. Ravelin will identify whether
the card is prepaid on your behalf if you send the cardBin which
should be preferred.
|
The country that the card was issued in. Ravelin will identify the
country of issuance on your behalf if you send the cardBin, which
should be preferred.
A ISO 3166-1 Alpha 3
or Alpha 2 country
code.
|
The expiry month of the card.
|
The expiry year of the card.
|
|
|
The address of the registered cardholder, as used to pass
AVS
checks. It is common to have fewer location details for this address,
but provide what you have.
|
|
|
The postal or zip code. If provided without latitude or longitude, Ravelin will perform coarse geolocation in some countries.
|
The latitude of the location.
|
The longitude of the location.
|
The name of the person that will accept delivery of goods to this address.
|
The street address of the location.
|
The street address of the location.
|
The neighbourhood of the location.
|
The zone of the location.
|
|
|
The state/county of the location.
|
The PO box number related to the location.
|
Custom data that is relevant to your domain. This can be any json object.
Please include any details that you think are relevant to fraud that our
schema does not capture.
|
The geohash of the location.
|
|
Whether the card was successfully registered with your gateway/PSP.
|
The time that the card was saved to the customer's account. (Not the card start date.)
A unix timestamp preferably as an
integer count of milliseconds since 1970-01-01T00:00 UTC
(nanoseconds are also accepted).
|
The time at which the payment method was last verified by the customer.
An example mechanism would be a random amount charged to the
customer's card that they can confirm the amount of.
A unix timestamp preferably as an
integer count of milliseconds since 1970-01-01T00:00 UTC
(nanoseconds are also accepted).
|
Custom data that is relevant to your domain. This can be any json object.
Please include any details that you think are relevant to fraud that our
schema does not capture.
|
active
boolean
optional
deprecated
Whether this card is still saved to the customer's account.
|
banned
boolean
optional
deprecated
Whether this card has been banned.
|
The nickname the customer has given the payment method.
|
|
|
fromTransaction: Refer to the payment method used by a named transaction.
For usage examples, see
Saving payment methods after checkout
and Associating refunds with payment methods.
Show definition
|
|
|
The transaction ID to look up the payment method from.
|
The gateway that the transaction was processed through.
|
The gateway ref provided by the gateway for the transaction.
|
|
|
|
|
directdebit: Direct Debits.
Show definition
|
|
|
A unique identifier for this payment method, specific to this customer. Two
customers should not use the same paymentMethodId.
|
|
|
The type of direct debit scheme.
One of:
autogiro, bacs, becs, becsnz, betalingsservice, or sepa.
|
IBAN (International Bank Account Number)
Following the ISO 13616:2007 standard.
|
|
|
|
Show definition
|
|
|
The postal or zip code. If provided without latitude or longitude, Ravelin will perform coarse geolocation in some countries.
|
The latitude of the location.
|
The longitude of the location.
|
The name of the person that will accept delivery of goods to this address.
|
The street address of the location.
|
The street address of the location.
|
The neighbourhood of the location.
|
The zone of the location.
|
|
|
The state/county of the location.
|
The PO box number related to the location.
|
Custom data that is relevant to your domain. This can be any json object.
Please include any details that you think are relevant to fraud that our
schema does not capture.
|
The geohash of the location.
|
|
The name of the account owner.
|
Code assigned by central bank to identify bank that account is associated with.
Multiple bank code formats are supported.
|
Name of bank which account belongs to.
|
BIC - business identifier code for banks and other institutions.
Following the ISO9362 standard.
|
The account number issued by the bank.
|
The unique reference issued for the direct debit mandate.
|
A URL to access the direct debit mandate agreement.
|
The nickname for the payment method that the customers gives, if applicable.
|
Custom data that is relevant to your domain. This can be any json object.
Please include any details that you think are relevant to fraud that our
schema does not capture.
|
|
|
banktransfer: Bank Transfers.
Show definition
|
|
|
A unique identifier for this payment method, specific to this customer. Two
customers should not use the same paymentMethodId.
|
One of:
bancontact, eps, giropay, ideal, inghomepay, sofort, or sepa.
|
IBAN (International Bank Account Number)
Following the ISO 13616:2007 standard.
|
|
|
|
Show definition
|
|
|
The postal or zip code. If provided without latitude or longitude, Ravelin will perform coarse geolocation in some countries.
|
The latitude of the location.
|
The longitude of the location.
|
The name of the person that will accept delivery of goods to this address.
|
The street address of the location.
|
The street address of the location.
|
The neighbourhood of the location.
|
The zone of the location.
|
|
|
The state/county of the location.
|
The PO box number related to the location.
|
Custom data that is relevant to your domain. This can be any json object.
Please include any details that you think are relevant to fraud that our
schema does not capture.
|
The geohash of the location.
|
|
The name of the account owner.
|
Code assigned by central bank to identify bank that account is associated with.
Multiple bank code formats are supported.
|
Name of bank which account belongs to.
|
BIC - business identifier code for banks and other institutions.
Following the ISO9362 standard.
|
The account number issued by the bank.
|
The nickname for the payment method that the customers gives, if applicable.
|
The time that the card was saved to the customer's account. (Not the card start date.)
A unix timestamp preferably as an
integer count of milliseconds since 1970-01-01T00:00 UTC
(nanoseconds are also accepted).
|
Custom data that is relevant to your domain. This can be any json object.
Please include any details that you think are relevant to fraud that our
schema does not capture.
|
|
|
Others - deprecated.
Show definition
|
Other method type indicator.
One of:
voucher, bitcoin, transfer, paysafe, cheque, or edenred.
|
A unique identifier for this payment method, specific to this customer. Two
customers should not use the same paymentMethodId.
|
When the payment method was added to the customer's account.
A unix timestamp preferably as an
integer count of milliseconds since 1970-01-01T00:00 UTC
(nanoseconds are also accepted).
|
A unix timestamp preferably as an
integer count of milliseconds since 1970-01-01T00:00 UTC
(nanoseconds are also accepted).
|
Custom data that is relevant to your domain. This can be any json object.
Please include any details that you think are relevant to fraud that our
schema does not capture.
|
The nickname for the payment method that the customers gives, if applicable.
|
banned
boolean
optional
deprecated
If the payment method has been banned
|
active
boolean
optional
deprecated
Whether the payment method is active for use by this account
|
|
|
Removal: Used for marking a saved payment method as removed from the account.
Show definition
|
A unique identifier for this payment method, specific to this customer. Two
customers should not use the same paymentMethodId.
|
False to indicate the payment method has been deactivated.
Only:
false.
|
|
The device used by the customer to trigger this update.
|
The ID of the device used by the customer to trigger this update.
|
The IP address of the device connecting to your services. Used in fraud and account-takeover detection.
When extracting this IP address, consider X-Forwarded-For.
|
|
|
The browser user-agent string, if the device represents a web browser - window.navigator.userAgent.
|
|
|
The operating system that the device is running.
|
One of:
computer, phone, or tablet.
|
|
|
The geolocated position of the device.
|
|
|
The postal or zip code. If provided without latitude or longitude, Ravelin will perform coarse geolocation in some countries.
|
The latitude of the location.
|
The longitude of the location.
|
The name of the person that will accept delivery of goods to this address.
|
The street address of the location.
|
The street address of the location.
|
The neighbourhood of the location.
|
The zone of the location.
|
|
|
The state/county of the location.
|
The PO box number related to the location.
|
Custom data that is relevant to your domain. This can be any json object.
Please include any details that you think are relevant to fraud that our
schema does not capture.
|
The geohash of the location.
|
|
Custom data that is relevant to your domain. This can be any json object.
Please include any details that you think are relevant to fraud that our
schema does not capture.
|
The name of the web browser being used, if applicable. Prefer userAgent.
|
Whether Javascript is enabled on the web browser.
|
Whether cookies are enabled on the web browser.
|
The resolution of the screen on the device in the format XxY
|
|
The ID of the device used by the customer to trigger this update.
|