Update Payment Credential

Update an existing Payment Credential for an existing Alias.

The request requires the paymentCredentialId as a path parameter in valid GUID format.

Sample request:

PUT ads/api/v1/paymentCredentials/{paymentCredentialId}
{
    "paymentType": "CARD",
    "cardInfo": {
        "nameOnCard": "Alex Miller",
        "issuerName": "Bank A",
        "cardType": "Visa Platinum",
        "expirationDate": "2030-01",
        "externalId": "63421837-d597-4f0f-89e4-930c1a7b9e85",
        "currencyCode": "USD",
        "preferredFor": [ { "type": "RECEIVE" } ],
        "billingAddress": {
            "country": "USA",
            "addressLine1": "1000 Market Street",
            "addressLine2": "Suite 101",
            "buildingNumber": "56",
            "city": "San Francisco",
            "minorSubdivisionCode": "CA",
            "streetName": "12",
            "postalCode": "94105",
            "state": "CA"
        }
    },
    "bankInfo": {
        "accountName": "Alex Miller",
        "accountNumber": "411*****455***42",
        "accountNumberType": "DEFAULT",
        "accountType": "SAVING",
        "bankName": "Bank A",
        "bankCode": "173",
        "branchCode": "123456",
        "bankCodeType": "ABA",
        "bic": "AAAABBCC123",
        "countryCode": "USA",
        "currencyCode": "USD",
        "externalId": "63421837-d597-4f0f-89e4-930c1a7b9e85",
        "address": {
            "country": "USA",
            "addressLine1": "1000 Market Street",
            "addressLine2": "Suite 101",
            "buildingNumber": "56",
            "city": "San Francisco",
            "minorSubdivisionCode": "CA",
            "streetName": "12",
            "postalCode": "94105",
            "state": "CA"
        },
        "preferredFor": [ { "type": "RECEIVE" } ]
    }
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

Documentation

For more information on this endpoint, see Update Payment Credential.

Path Params
string
required

The unique identifier assigned to a payment credential

Body Params

Update Payment Credential request

Represents a request to update a payment credential, identified by its unique payment credential ID.

string
required
length ≥ 1

Payment type for the credential. Allowed values: "CARD", "BANK".
CARD

cardInfo
object

Card information to update.

bankInfo
object

Bank information to update.

Responses
204

Updated

Language
URL
LoadingLoading…
Response
Choose an example:
application/json