Update a Customer

put

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

Updates a Customer Vault profile. You can send the entire resource or just the fields that need updating. When updating array fields (billing_cards or shipping_addresses), include the entire array in the request body.

Path Params

customer_id

string

required

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

Body Params

Customer

customer_first_name

string

Format: Variable length, up to 32 AN
Description: Customer's first name.
Conditional Requirement: Either customer name or customer firm name is required.

customer_last_name

string

Format: Variable length, up to 32 AN
Description: Customer's last name.
Conditional Requirement: Either customer name or customer firm name is required.

customer_firm_name

string

Format: Variable length, up to 64 AN
Description: Customer's business name, if applicable.
Conditional Requirement: Either customer name or customer firm name is required.

customer_phone

string

Format: Variable length, up to 16 AN
Description: Customer's phone number.

customer_email

string

Format: Variable length, up to 64 AN
Description: Customer's email address.

reference_id

string

Format: Variable length, up to 128 AN
Description: A merchant-provided value that will be stored with the Customer Vault data for merchant reference.

comments

string

Format: Variable length, up to 128 AN
Description: Comments.

shipping_addresses

array of objects

Description: An array of shipping addresses.

shipping_addresses

billing_cards

array of objects

Description: An array of billing cards.

billing_cards

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

Language

Credentials

Basic

base64

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Request Validation Failed

500Internal Error