Add a Non-Default Payment Instrument Using Instrument
Identifier
This section shows you how to add a non-default payment instrument using instrument
identifier.
Endpoint
Test:
POST
https://apitest.cybersource.com
/tms/v2/customers/{customerTokenId}
/payment-instruments/{paymentInstrumentTokenId}
Production:
POST
https://api.cybersource.com
/tms/v2/customers/{customerTokenId}
/payment-instruments/{paymentInstrumentTokenId}
Production in India:
POST
https://api.in.cybersource.com
/tms/v2/customers/{customerTokenId}
/payment-instruments/{paymentInstrumentTokenId}
The is the customer token ID returned in
the is the payment instrument
token ID you want to retrieve. For more information, see Create a Customer and Create a Customer Payment Instrument.
{customerTokenId}
id
field when you created the customer token. The
{paymentInstrumentTokenId}
Required Fields for Adding a Non-Default Payment Instrument Using Instrument
Identifier
- customerTokenId
- Include the ID of the customer token you want to retrieve in the URL path.
- paymentInstrumentTokenId
- Include the ID of the payment instrument token you want to retrieve in the URL path.
Related Information
Optional Fields for Adding a Non-Default Payment Instrument Using Instrument
Identifier
- bankAccount.type
- billTo.address1
- billTo.address2
- billTo.aminstrativeArea
- billTo.company
- billTo.country
- billTo.email
- billTo.firstName
- billTo.lastName
- billTo.locality
- billTo.phoneNumber
- billTo.postalCode
- buyerInformation.companyTaxID
- buyerInformation.currency
- buyerInformation.dateOfBirth
- buyerInformation.personalIdentification.id
- buyerInformation.personalIdentification.issuedBy.administrativeArea
- buyerInformation.personalIdentification.type
- card.expirationMonth
- card.expirationYear
- card.issueNumber
- card.startMonth
- card.startYear
- card.type
- card.useAs
- card.tokenizedInformation.requestorID
- card.tokenizedInformation.transactionType
- default
- Set value totrueif default, otherwise set value tofalse.
- instrumentIdentifier.id
- Set the value to the ID of the instrument identifier token.
- processingInformation.billPaymentProgramEnabled
- merchantInformation.merchantDescriptor.alternateName
Related Information
REST Example: Adding a Non-Default Payment Instrument Using Instrument Identifier
Request
{ "default": false, "card": { "expirationMonth": "12", "expirationYear": "2031", "type": "001" }, "billTo": { "firstName": "John", "lastName": "Doe", "company": "Visa", "address1": "1 Market St", "locality": "san francisco", "administrativeArea": "CA", "postalCode": "94105", "country": "US", "phoneNumber": "4158880000", "email": "test@cybs.com" }, "instrumentIdentifier": { "id": "{{tms-instrumentIdentifier-id}}" } }
Response to a Successful Request
{ "_links": { "self": { "href": "/tms/v2/customers/F45FB3E443AC3C57E053A2598D0A9CFF/payment-instruments/F45FE3A5DAD6CF8CE053A2598D0AA1EF" }, "customer": { "href": "/tms/v2/customers/F45FB3E443AC3C57E053A2598D0A9CFF" } }, "id": "F45FE3A5DAD6CF8CE053A2598D0AA1EF", "default": false, "state": "ACTIVE", "card": { "expirationMonth": "12", "expirationYear": "2031", "type": "001" }, "billTo": { "firstName": "John", "lastName": "Doe", "company": "Visa", "address1": "1 Market St", "locality": "san francisco", "administrativeArea": "CA", "postalCode": "94105", "country": "US", "email": "test@cybs.com", "phoneNumber": "4158880000" }, "instrumentIdentifier": { "id": "7030000000012931531" }, "metadata": { "creator": "testrest" }, "_embedded": { "instrumentIdentifier": { "_links": { "self": { "href": "/tms/v1/instrumentidentifiers/7030000000012931531" }, "paymentInstruments": { "href": "/tms/v1/instrumentidentifiers/7030000000012931531/paymentinstruments" } }, "id": "7030000000012931531", "object": "instrumentIdentifier", "state": "ACTIVE", "card": { "number": "489537XXXXXX1531" }, "issuer": { "paymentAccountReference": "V0010013019326121921451482293" }, "processingInformation": { "authorizationOptions": { "initiator": { "merchantInitiatedTransaction": { "previousTransactionId": "123456789619999" } } } }, "metadata": { "creator": "testrest" } } } }