Manage Payment Instrument

The Manage Payment Instrument endpoint enables you to update existing payment instrument details, specifically the instruments billing address, created from the Enroll Payment Instrument endpoint.

You can manage a payment instrument by making a PUT request to the Manage Payment Instrument endpoint. For example:

{{base-url}}/ctp/api/v1/paymentinstrument

The Manage Payment Instrument request replaces the whole payment instrument object, so all fields are required in the request body. See the below example of a request.

{
 "customerReferenceId": "1234",
 "pubToken": "275797862", 
 "billingAddress": {
    "city": "San Francisco",
    "state": "CA",
    "country": "USA",
    "postalCode": 94105,
    "addressLine1": "1000 Market Street",
    "addressLine2": "Building 56",
    "addressLine3": "Suite 102"
  }
}

If successful, a 202 response is returned with a unique requestTraceId when the card network is VISA, and a unique srcCorrelationId when the card network is Mastercard.

{
  "requestTraceId": "351562ba-83cf-11ee-b962-0242ac120002"
}

{
  "srcCorrelationId": "b17b686c-4759-4ade-a3b1-6b29c61b6774"
}

📘

Information

• To view this endpoint in the API Explorer, see Manage Payment Instrument.
• To view information on the fields for this endpoint, see Manage Payment Instrument - Field Descriptions.