Get the balance of a gift card
Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST /paymentMethods/balance call and include the gift card's details inside a paymentMethod object.
Header Parameters
A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
Request Parameters
Shopper account information for 3D Secure 2.
For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.
If you want a BIN or card verification request to use a non-zero value, assign this value to additionalAmount (while the amount must be still set to 0 to trigger BIN or card verification).
Required to be in the same currency as the amount.
This field contains additional data, which may be required for a particular payment request.
The additionalData object consists of entries, each of which includes the key and value.
The amount information for the transaction (in minor units). For BIN or card verification requests, set amount to 0 (zero).
Information about your application. For more details, see Building Adyen solutions.
The address where to send the invoice.
The
billingAddressobject is required in the following scenarios. Include all of the fields within this object.
- For 3D Secure 2 transactions in all browser-based and mobile implementations.
- For cross-border payouts to and from Canada.
The shopper's browser information.
For 3D Secure, the full object is required for web integrations. For mobile app integrations, include the
userAgentandacceptHeaderfields to indicate that your integration can support a redirect in case a payment is routed to 3D Secure 1.
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.
Contains installment settings. For more information, refer to Installments.
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
merchantOrderReferencevalue to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provideretry.orderAttemptNumber,retry.chainAttemptNumber, andretry.skipRetryvalues inPaymentRequest.additionalData.
Additional risk fields for 3D Secure 2.
For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.
Metadata consists of entries, each of which includes a key and a value. Limits:
- Maximum 20 key-value pairs per request. When exceeding, the "177" error occurs: "Metadata size exceeds limit".
- Maximum 20 characters per key.
- Maximum 80 characters per value.
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.
The collection that contains the type of the payment method and its specific information.
The recurring settings for the payment. Use this property when you want to enable recurring payments.
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, orbcmc, 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.
For 3D Secure 2 transactions, schemes require
shopperEmailfor all browser-based and mobile implementations.
The shopper's IP address. In general, 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).
For 3D Secure 2 transactions, schemes require
shopperIPfor all browser-based implementations. 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 combination of a language code and a country code to specify the language to be used in the payment.
Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.
Your reference must not include personally identifiable information (PII), for example 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.
An array of objects specifying how the payment should be split when using either Adyen for Platforms for marketplaces or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone Issuing.
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.
Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to Online payments or Classic integration documentation.
If set to true, you will only perform the 3D Secure 2 authentication, and not the payment authorisation.
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.
Response parameters
After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.