Get the balance of a gift card

The delay between the authorisation and scheduled auto-capture, specified in hours.

The shopper's date of birth.

Format ISO-8601: YYYY-MM-DD

The date and time the purchased goods should be delivered.

Format ISO 8601: YYYY-MM-DDThh:mm:ss.sssTZD

Example: 2017-07-17T13:42:40.428+01:00

A string containing the shopper's device fingerprint. For more information, refer to Device fingerprinting.

An integer value that is added to the normal fraud score. The value can be either positive or negative.

The merchant category code (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.

The merchant account identifier, with which you want to process the transaction.

This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.

We strongly recommend you send the merchantOrderReference value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide retry.orderAttemptNumber, retry.chainAttemptNumber, and retry.skipRetry values in PaymentRequest.additionalData.

When you are doing multiple partial (gift card) payments, this is the pspReference of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the merchantOrderReferenceinstead.

Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details. Allowed values:

• Subscription – A transaction for a fixed or variable amount, which follows a fixed schedule.
• CardOnFile – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.
• UnscheduledCardOnFile – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.

The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens ("-"). Maximum length: 80 characters.

Some payment methods require defining a value for this field to specify how to process the transaction.

For the Bancontact payment method, it can be set to:

• maestro (default), to be processed like a Maestro card, or
• bcmc, to be processed like a Bancontact card.

The recurringDetailReference you want to use for this payment. The value LATEST can be used to select the most recently stored recurring detail.

A session ID used to identify a payment session.

The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > Required for Visa and JCB transactions that require 3D Secure 2 authentication if you did not include the telephoneNumber.

The shopper's IP address. We recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks).

Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the shopperEmail. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. This field is also mandatory for some merchants depending on your business model. For more information, contact Support.

Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default.

This field has the following possible values:

• Ecommerce - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request.
• ContAuth - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment).
• Moto - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.
• POS - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.

The language for the payment. The value combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code. For example, nl-NL.

When using Drop-in/Components, the specified language appears if your front-end global configuration does not set the locale.

Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.

Your reference must not include personally identifiable information (PII) such as name or email address.

The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters . , ' _ - ? + * /.

The shopper's social security number.

Required for Adyen for Platforms integrations if you are a platform model. This is your reference (on balance platform) or the storeReference (in the classic integration) for the ecommerce or point-of-sale store that is processing the payment.

The shopper's telephone number. The phone number must include a plus sign (+) and a country code (1-3 digits), followed by the number (4-15 digits). If the value you provide does not follow the guidelines, we do not submit it for authentication.

Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the shopperEmail.

Required to trigger the authentication-only flow. If set to true, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorization.Default: false.

The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).

Set to true if the payment should be routed to a trusted MID.

Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.

If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes resultCode and refusalReason values.

For more information, see Refusal reasons.

The result of the cancellation request.

Possible values:

• Success – Indicates that the balance check was successful.
• NotEnoughBalance – Commonly indicates that the card did not have enough balance to pay the amount in the request, or that the currency of the balance on the card did not match the currency of the requested amount.
• Failed – Indicates that the balance check failed.