On This Page

{#jumplink-list}  
[Markdown](/docs/vas/en-us/intelligent-commerce/developer/all/rest/intelligent-commerce/intelligent-commerce-retrieve-credentials-intro.md)  
Filter  
FILTER BY TAG

pilot

Retrieve Payment Credentials {#intelligent-commerce-retrieve-credentials-intro}
===============================================================================

Use the information in this section to retrieve a customer's tokenized payment credentials. During checkout, your agents display a list of the customer's tokenized cards. When the customer chooses the card they want to pay with, your agents send a *retrieve payment credentials* request. After retrieving the customer's tokenized card, your agents can use your payment system to complete the transaction.

Endpoints
---------

Send a POST request to one of these endpoints. The *{instructionID}* is the instruction ID from the create a purchase request.  
**Production:** `POST ``https://api.visaacceptance.com``/acp/v1/instructions/`*{instructionID}*`/credentials`  
**Test:** `POST ``https://apitest.visaacceptance.com``/acp/v1/instructions/`*{instructionID}*`/credentials`

Required Fields for Retrieving Payment Credentials {#intelligent-commerce-retrieve-credentials-req-fields}
==========================================================================================================

clientCorrelationId
:

paymentInformation.instrumentIdentifier.id
:

tokenizedCard.number
:

transactionData\[\].clientReferenceInformation.code
:

transactionData\[\].merchantInformation.merchantDescriptor. country
:

transactionData\[\].merchantInformation.merchantDescriptor.url
:

transactionData\[\].merchantInformation.merchantName
:

transactionData\[\].orderInformation.amountDetail.currency
:

transactionData\[\].orderInformation.amountDetail.totalAmount
:

Additional Information
----------------------

For complete descriptions of the request fields, see the [Retrieve payment credentials](https://apihub.visa.com/cybs/internal/Spec-Branches/DOCRSTAPI_1374_acp_api_spec/acp_rest.md#operation/retrievePaymentCredentials "") section in the `Intelligent Commerce` API Hub.

Optional Fields for Retrieving Payment Credentials {#intelligent-commerce-retrieve-credentials-opt-fields}
==========================================================================================================

transactionData\[\].acquirerInformation.merchantId
:

transactionData\[\].agreementInformation\[\].id
:

transactionData\[\].deliveryMethod
:

transactionData\[\].merchantInformation.domainName
:

transactionData\[\].merchantInformation.language
:

transactionData\[\].merchantLocale
:

transactionData\[\].merchantOrderId
:

transactionData\[\].orderInformation.amountDetail. discountAmount
:

transactionData\[\].orderInformation.amountDetail.order. handlingAmount
:

transactionData\[\].orderInformation.amountDetail.order. shippingAmount
:

transactionData\[\].orderInformation.amountDetail. settlementAmount
:

transactionData\[\].orderInformation.amountDetail. settlementcurrency
:

transactionData\[\].orderInformation.amountDetail. subTotalAmount
:

transactionData\[\].orderInformation.amountDetail. taxAmount
:

transactionData\[\].paymentOptions.dpaDynamicDataTtlMinutes
:

transactionData\[\].paymentOptions.dynamicDataType
:

transactionData\[\].paymentServiceproviderName
:

transactionData\[\].products\[\].additionalInfo\[\].key
:

transactionData\[\].products\[\].additionalInfo\[\].value
:

transactionData\[\].products\[\].policies.cancellationPolicy
:

transactionData\[\].products\[\].policies.discountAndPromotions
:

transactionData\[\].products\[\].policies.disputePolicy
:

transactionData\[\].products\[\].policies.propertyName
:

transactionData\[\].products\[\].policies.refundPolicy
:

transactionData\[\].products\[\].policies.shippingPolicy
:

transactionData\[\].products\[\].policies.termsAndConditions
:

transactionData\[\].products\[\].productId
:

transactionData\[\].products\[\].productName
:

transactionData\[\].products\[\].productUrl
:

transactionData\[\].products\[\].quantity
:

transactionData\[\].products\[\].transactionAmount.discount
:

transactionData\[\].products\[\].transactionAmount.shippingAndHandling
:

transactionData\[\].products\[\].transactionAmount.subTotal
:

transactionData\[\].products\[\].transactionAmount.tax
:

transactionData\[\].products\[\].transactionAmount.transactionAmount
:

transactionData\[\].products\[\].transactionAmount.transactionCurrencyCode
:

transactionData\[\].products\[\].unitPrice.amount
:

transactionData\[\].products\[\].unitPrice.currency
:

transactionData\[\].shippingAddress.addressId
:

transactionData\[\].shippingAddress.city
:

transactionData\[\].shippingAddress.countryCode
:

transactionData\[\].shippingAddress.createTime
:

transactionData\[\].shippingAddress. deliveryContactDetails. contactEmailAddress
:

transactionData\[\].shippingAddress. deliveryContactDetails. contactFullName
:

transactionData\[\].shippingAddress.deliveryContactDetails.contactPhoneNumber.countryCode
:

transactionData\[\].shippingAddress. deliveryContactDetails. contactPhoneNumber. numberIsVoiceOnly
:

transactionData\[\].shippingAddress. deliveryContactDetails. contactPhoneNumber. phoneNumber
:

transactionData\[\].shippingAddress. deliveryContactDetails. instructions
:

transactionData\[\].shippingAddress.lastUsedTime
:

transactionData\[\].shippingAddress.line1
:

transactionData\[\].shippingAddress.line2
:

transactionData\[\].shippingAddress.line3
:

transactionData\[\].shippingAddress.name
:

transactionData\[\].shippingAddress.state
:

transactionData\[\].shippingAddress.zip
:

transactionData\[\].transactionType
:

Example: Retrieving Payment Credentials {#intelligent-commerce-retrieve-credentials-ex-rest}
============================================================================================

Request

```
{
  "clientCorrelationId": "retrievePaymentCredentialsRequest",
  "paymentInformation": {
    "instrumentIdentifier": {
      "id": "7019989999909760770"
    }
  },
  "tokenizedCard": {
    "number": "15602cf86c70b8b63297134292ec5801"
  },
  "transactionData": [
    {
      "clientReferenceInformation": {
        "code": "transactionDatatransactionReferenceId"
      },
      "agreementInformation": [
        {
          "id": "d48ac10b-58cc-4372-a567-0e02b2c3d489"
        }
      ],
      "acquirerInformation": {
        "merchantId¹": "transactionDatamerchantId"
      },
      "transactionType": "PURCHASE",
      "orderInformation": {
        "amountDetail": {
          "totalAmount": "100",
          "currency": "USD",
          "settlementAmount": "transactionDatatransactionAmounttransactionAmount",
          "settlementcurrency": "USD",
          "subTotalAmount": "100",
          "taxAmount": "100",
          "discountAmount": "100",
          "order": {
            "shippingAmount": "13",
            "handlingAmount": "transactionDatatransactionAmountshippingAndHandling"
          }
        }
      },
      "paymentServiceproviderName": "",
      "merchantOrderId": "d48ac10b-58cc-4372-a567-0e02b2c3d489",
      "shippingAddress": {
        "addressId¹": "",
        "name": "",
        "line1¹": "123 Main St",
        "line2": "Apt 1",
        "line3": "",
        "city¹": "San Francisco",
        "state¹": "CA",
        "countryCode": "US",
        "zip¹": "94105",
        "createTime": "1735690745",
        "lastUsedTime": "1735690745",
        "deliveryContactDetails": {
          "contactFullName": "",
          "contactEmailAddress": "",
          "contactPhoneNumber": {
            "countryCode": "",
            "phoneNumber": "",
            "numberIsVoiceOnly": "true"
          },
          "instructions": ""
        }
      },
      "merchantInformation": {
        "merchantName": "John Doe",
        "merchantDescriptor": {
          "country": "US",
          "url": "transactionDatashippingAddressmerchantUrl"
        },
        "domainName": "transactionDatamerchantDomain",
        "language": "en_US"
      },
      "deliveryMethod": "ADDRESS_ON_FILE",
      "paymentOptions": {
        "dpaDynamicDataTtlMinutes": "10080",
        "dynamicDataType": "TAVV"
      },
      "merchantLocale": "en_US",
      "products": [
        {
          "productId": "1234",
          "productName": "Balloons",
          "quantity": "10",
          "unitPrice": {
            "currency": "USD",
            "amount": "100.00"
          },
          "transactionAmount": {
            "transactionAmount": "100.00",
            "transactionCurrencyCode": "USD",
            "subTotal": "10.00",
            "tax": "1.10",
            "shippingAndHandling": "6.00",
            "discount": "6.00"
          },
          "productUrl": "",
          "policies": {
            "termsAndConditions": "",
            "cancellationPolicy": "",
            "refundPolicy": "",
            "disputePolicy": "",
            "shippingPolicy": "",
            "discountAndPromotions": "",
            "propertyName": ""
          },
          "additionalInfo": [
            {
              "key": "color",
              "value": "red"
            }
          ]
        }
      ]
    }
  ]
}
```

Response to a Successful Request

```
{
  "clientCorrelationId": "3e1b7943-6567-4965-a32b-5aa93d057d35",
  "transactionId": "1-5C8B7367EC00114ddb4b-f06a-0bff-7430-18d285223901",
  "status": "COMPLETED"
}
```

RELATED TO THIS PAGE