Update a Payment Method

put

https://api-test.qualpay.com/platform/vault/customer/{customer_id}/billing

Updates a specified payment method for a profile in Customer Vault. Include the complete billing record in the request.

Path Params

customer_id

string

required

The customer ID, returned as the customer_id value in an 'Add a Customer' response.

Body Params

Customer

card_id

string

required

Format: Fixed length, 32 AN
Description: The card ID of the payment method you want to update.

exp_date

string

Format: Fixed length, 4 N, MMYY format
Description: Expiration date of cardholder’s card number. Use this field to update the card’s expiration date.

cvv2

string

Format: Variable length, up to 4 N
Description: CVV2 or CID value from the signature panel on the back of the cardholder's card. If present during a request where the verify flag is set to true, this value is sent to the issuer for validation. This field will not be stored in Vault.

billing_first_name

string

Format: Variable length, up to 32 AN
Description: Billing first name.

billing_last_name

string

Format: Variable length, up to 32 AN
Description: Billing last name.

billing_firm_name

string

Format: Variable length, up to 64 AN
Description: Business name on the billing card, if applicable.

billing_email

array of strings

Format: Variable length, up to 128 AN
Description: An array of billing email addresses.

billing_email

billing_addr1

string

Format: Variable length, up to 128 AN
Description: Billing street address. This address will also be used for AVS verification if AVS verification is enabled.

billing_addr2

string

Format: Variable length, up to 128 AN
Description: Billing address line 2.

billing_city

string

Format: Variable length, up to 64 AN
Description: Billing city.

billing_state

string

Format: Variable length, up to 3 AN
Description: Billing state.

billing_zip

string

Format: Variable length, up to 10 AN
Description: Billing zip code. This zip code will also be used for AVS verification if AVS verification is enabled.

billing_zip4

string

Format: Fixed length, 4 N
Description: Billing zip+4 code, if applicable.

billing_country

string

Format: Variable length, up to 128 AN
Description: Billing country.

billing_country_code

string

Format: Fixed length, 3 AN
Description: ISO numeric country code for the billing address. Refer to Country Codes for a list of country codes.

verify

boolean

Description: Set this field to true if a card_number or card_id should be verified by the issuer before adding to Customer Vault. When this field is set to true, the payment method is updated in Customer Vault regardless of whether verification succeeds.
Default: false

primary

boolean

Description: Set this field to true if this should be the primary payment method.
Default: false

merchant_id

int64

Format: Variable length, up to 16 AN
Description: Identifies the merchant to whom this request applies. Optional field, applicable only if the request is sent on behalf of another merchant.
Conditional Requirement: Required if this request is on behalf of another merchant.

Responses

200Success

400Request Validation Failed

500Internal Error