Update Payment Credential

The Update Payment Credential endpoint enables you to update an existing payment credential for an alias.

To update a payment credential, make a PUT request to the Update Payment Credential endpoint, with the ID of the payment credential in paymentCredentialId.

For example:

https://uat-api.thredd.com/ads/api/v1/paymentCredentials/{paymentCredentialId}

The body of the request will depend on whether you're updating a CARD type payment credential or a BANK type payment credential. The requests below are examples for updating a CARD and BANK payment type:

{
    "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"
        }
    }
}

{
    "paymentType": "BANK",
    "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"
        }
    }
}

If successful, a 204 response is returned.

📘
More Information

To view this endpoint in the API Explorer, see Update Payment Credential

To view descriptions for this endpoint, see Update Payment Credential - Field Descriptions.

Updated 2 days ago

Did this page help you?