This page is for our Classic API (/authorise
) integration. If you are integrating using our Checkout APIs, refer to the Tokenization documentation instead.
After you store payment details along with an /authorisation
call, you need the recurringDetailReference
to refer to the stored details in other requests.
Request
To retrieve the payment details and their reference number, use the /listRecurringDetails
call. In this call, pass your merchant account and a reference of a shopper, whose payment details were previously stored.
For information on all available fields, see .
The following example demonstrates how to get payment details stored with your TestMerchant account for a shopper 14194858.
{
"merchantAccount":"TestMerchant",
"shopperReference":"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j"
}
<?xml version="1.0"?>
<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:listRecurringDetails xmlns:ns1="http://recurring.services.adyen.com">
<ns1:request>
<ns1:merchantAccount>TestMerchant</ns1:merchantAccount>
<ns1:shopperReference>YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j</ns1:shopperReference>
</ns1:request>
</ns1:listRecurringDetails>
</soap:Body>
</soap:Envelope>
curl https://pal-test.adyen.com/pal/servlet/Recurring/v25/listRecurringDetails \
-d merchantAccount=TestMerchant \
-d shopperReference=YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j
Response
If there are payment details stored for the specified shopperReference
, the response contains one or more RecurringDetail
objects. In this object some fields may be missing or nil, depending on the payment method being used.
The response is different in the following scenarios:
- If the
shopperReference
does not exist, the endpoint returns an empty object. - If the
shopperReference
exists but the request contains a specificcontract
type and a recurring detail for that contract does not exist, thedetails
array is not included in the response.
For information on all fields available in a response, see RecurringDetailsResult.
The following example shows the response if a shopper 14194858 stored the details of their VISA Debit card with a number starting with 492179. In this case, the recurringDetailReference
is equal to 8313147988756818.
{
"creationDate":"2015-07-30T22:54:13+02:00",
"details":[
{
"RecurringDetail":{
"additionalData":{
"cardBin":"492179"
},
"card":{
"expiryMonth":"2",
"expiryYear":"2017",
"holderName":"John Doe",
"number":"0380"
},
"contractTypes": [
"ONECLICK",
"RECURRING"
],
"alias":"H123456789012345",
"aliasType":"Default",
"creationDate":"2015-07-30T22:54:13+02:00",
"firstPspReference":"1314362892522014",
"name": "1132",
"recurringDetailReference":"8313147988756818",
"paymentMethodVariant":"visa",
"variant":"visa"
}
}
],
"shopperReference":"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j"
}
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<ns1:listRecurringDetailsResponse xmlns:ns1="http://recurring.services.adyen.com">
<ns1:result>
<creationDate xmlns="http://recurring.services.adyen.com">2015-07-30T22:54:13+02:00</creationDate>
<details xmlns="http://recurring.services.adyen.com">
<RecurringDetail>
<additionalData>
<entry>
<key xsi:type="xsd:string">cardBin</key>
<value xsi:type="xsd:string">492179</value>
</entry>
</additionalData>
<alias>H123456789012345</alias>
<aliasType>Default</aliasType>
<bank xsi:nil="true"/>
<billingAddress xsi:nil="true"/>
<card>
<billingAddress xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
<cvc xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
<expiryMonth xmlns="http://payment.services.adyen.com">2</expiryMonth>
<expiryYear xmlns="http://payment.services.adyen.com">2017</expiryYear>
<holderName xmlns="http://payment.services.adyen.com">John Doe</holderName>
<issueNumber xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
<number xmlns="http://payment.services.adyen.com">0380</number>
<startMonth xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
<startYear xmlns="http://payment.services.adyen.com" xsi:nil="true"/>
</card>
<contractTypes>
<element>ONECLICK</element>
<element>RECURRING</element>
</contractTypes>
<creationDate>2015-07-30T22:54:13+02:00</creationDate>
<elv xsi:nil="true"/>
<firstPspReference>1314362892522014</firstPspReference>
<name xsi:nil="true"/>
<paymentMethodVariant>visadebit</paymentMethodVariant>
<recurringDetailReference>8313147988756818</recurringDetailReference>
<shopperName xsi:nil="true"/>
<socialSecurityNumber xsi:nil="true"/>
<tokenDetails xsi:nil="true"/>
<variant>visa</variant>
</RecurringDetail>
</details>
<lastKnownShopperEmail xmlns="http://recurring.services.adyen.com">14194858@gmail.com</lastKnownShopperEmail>
<shopperReference xmlns="http://recurring.services.adyen.com">YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j</shopperReference>
</ns1:result>
</ns1:listRecurringDetailsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>