Get Stored Payment Options

Last changes: 09-04-2019

Send an API 1.26 Get Stored Payment Options request to retrieve a list of stored payment options associated with an Account Number (in the example below KDNR0001). 

Get Stored Payment Options Request

Path:

GET {Base URL}/account/KDNR0001/storedPaymentOptions?partnerReference=DEV-SVR001-DE_CUSTID-T2JJ7BXHQK_CARTID-QV76MFRKVH_XYT7BBF7C2&programCode=COMPANYDE&accnoType=00&localDate=2018-11-14&localTime=095304

Header:

Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: H4sIAAAAAAA{partial omission for brevity}EAN2bJ/6l2XX+A5kJqdP+MwAA

Get Stored Payment Options Response

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
    "accno": "KDNR0001",
    "paymentOptions": [
        {
            "name": "Bank Account",
            "code": "BNKACCT",
            "carrierNumber": "DE8937****3000",
            "reference": "8ac7a4a066f2eab50167007795233f4f",
            "paymentGroup": "Banks",
            "paymentGroupCode": "BANKS",
            "paymentSubGroup": "SEPA",
            "paymentSubGroupCode": "SEPA",
            "validUntilDate": "9999-12-31",
            "validUntilTime": "235959",
            "bankName": "ACME Bank",
            "isVerifiable": true,
            "statusCode": "UNVERIFIED",
            "isDefault": true,
            "billingAddress": {
                "fullName": "Jacob Smith",
                "addr1": "Anystreet 321",
                "city": "Anycity",
                "countryName": "Germany",
                "countryCode": "DE",
                "countryCode3": "DEU",
                "postCode": "12345"
            },
            "mandate": {
                "mandateReference": "446ED8B3F6FD4CC195FB4D6E860E675A",
                "mandateSignedDate": "2018-11-11",
                "mandateSignedTime": "025058",
                "financialInstitutionName": "Volkswagen Payments S.A. (SANDBOX)",
                "financialInstitutionAddr1": "19-21, Route d’Arlon",
                "financialInstitutionCity": "Luxembourg",
                "financialInstitutionState": "Strassen",
                "financialInstitutionCountryName": "Germany",
                "financialInstitutionCountryCode": "DE",
                "financialInstitutionCountryCode3": "DEU",
                "financialInstitutionPostCode": "L-8009",
                "financialInstitutionCreditorIdentifier": "DE98ZZZ09999999999"
            },
            "iconUrl": "https://.../sepa.png"
        },
        {
            "name": "VISA",
            "code": "VISA",
            "carrierNumber": "402400****9550",
            "reference": "8ac7a49f66f2d5ae0167007fa0b17970",
            "paymentGroup": "Cards",
            "paymentGroupCode": "CARDS",
            "paymentSubGroup": "Credit Cards",
            "paymentSubGroupCode": "CRDTCRD",
            "expiryMonth": 4,
            "expiryYear": 2022,
            "validUntilDate": "2022-04-30",
            "validUntilTime": "215959",
            "isVerifiable": true,
            "statusCode": "UNVERIFIED",
            "isDefault": false,
            "billingAddress": {
                "fullName": "Jacob Smith",
                "addr1": "Anystreet 321",
                "city": "Anycity",
                "countryName": "Germany",
                "countryCode": "DE",
                "countryCode3": "DEU",
                "postCode": "12345"
            },
            "iconUrl": "https://.../visa.png"
        }
    ],
    "programCode": "COMPANYDE",
    "partnerReference": "DEV-SVR001-DE_CUSTID-T2JJ7BXHQK_CARTID-QV76MFRKVH_XYT7BBF7C2",
    "localDate": "2018-11-14",
    "localTime": "095304",
    "sysDate": "2018-11-14",
    "sysTime": "085303",
    "responseCode": "0000",
    "responseDescription": "Successful execution"
}

The response includes a list of payment options, each with an individual "reference" return parameter which is used to identify the tokenized payment option. The reference can be used as part of other API methods, by passing it in the request parameter most commonly referred to as "storedPaymentOptionReference" (see section Payment Process). The setting of the default payment option is indicated by the parameter “isDefault” and can be changed as described in section Set Default Payment Option.