This page is for our Classic API (/authorise
) integration. If you are integrating using our Checkout APIs, refer to the Gift cards documentation instead.
Adyen allows you to process payments for gift cards provided by Givex, SVS, and Fiserv (formerly ValueLink).
We also support gift cards from key local gift card providers in several countries. You can process payments with these gift cards, but no other transactions.
Here we explain how you can:
- Make a gift card payment using the /authorise endpoint.
For other gift card transactions you can use our JSON-only Stored Value API. For example, you can issue a new card, check the balance stored on a card, or deactivate a card.
Make a payment
To make a gift card payment:
-
Make a POST request to the /authorise endpoint, specifying the following parameters:
-
amount
: Thecurrency
andvalue
(in minor units) of the transaction.A
value
of 0 will returnadditionalData.currentBalanceValue
with the remaining balance stored on the gift card. -
card.expiryMonth
: Expiry month of the gift card. -
card.expiryYear
: Expiry year of the gift card. -
card.number
: Gift card number. -
card.holderName
: Optional. Name of the shopper that the gift card belongs to. -
card.cvc
: Optional. The PIN code or other type of security code of the gift card. Not all virtual gift cards have a PIN. -
reference
: Your unique reference for this payment. -
selectedBrand
: Brand of the gift card.
{ "amount":{ "currency":"GBP", "value":1000 }, "card":{ "cvc":"1234", "expiryMonth":"10", "expiryYear":"2020", "holderName":"John Smith", "number":"6036283997595793321" }, "reference":"Your Reference Here", "merchantAccount":"TestMerchant", "selectedBrand":"givex" }
<?xml version="1.0" encoding="UTF-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soap:Body> <ns1:authorise xmlns:ns1="http://payment.services.adyen.com"> <ns1:paymentRequest> <amount xmlns="http://payment.services.adyen.com"> <currency xmlns="http://common.services.adyen.com">GBP</currency> <value xmlns="http://common.services.adyen.com">1000</value> </amount> <billingAddress xmlns="http://payment.services.adyen.com" xsi:nil="true" /> <card xmlns="http://payment.services.adyen.com"> <billingAddress xsi:nil="true" /> <cvc>1234</cvc> <expiryMonth>10</expiryMonth> <expiryYear>2020</expiryYear> <holderName>John Smith</holderName> <issueNumber xsi:nil="true" /> <number>6036283997595793321</number> <startMonth xsi:nil="true" /> <startYear xsi:nil="true" /> </card> <reference xmlns="http://payment.services.adyen.com">Your Reference Here</reference> <merchantAccount xmlns="http://payment.services.adyen.com">TestMerchant</merchantAccount> <merchantOrderReference xmlns="http://payment.services.adyen.com" xsi:nil="true" /> <selectedBrand xmlns="http://payment.services.adyen.com">givex</selectedBrand> </ns1:paymentRequest> </ns1:authorise> </soap:Body> </soap:Envelope>
-
Response
You receive a response containing:
resultCode
: Use this to present the payment result to the shopper.pspReference
: Our unique reference for the payment.authCode
: When the payment is authorised successfully, this field holds the authorisation code for the payment. When the payment is not authorised, this field is empty.
{
"pspReference": "8814689190961342",
"resultCode": "Authorised",
"authCode": "83152"
}
For other possible response codes and fields of the payment response, refer to the /authorise
response parameters.