API Reference
Login to SandboxCreate Account

Add a Shipping Address

post
https://api-test.qualpay.com/platform/vault/customer//shipping

Adds a shipping address to a profile in Customer Vault. The response includes a unique shipping_id, which can be used to manage the shipping_address.

Path Params
string
required

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

Body Params

Shipping Address

string
required

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

string
required

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

string

Format: Variable length, up to 64 AN
Description: Business name of the shipping address, if applicable.

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.

boolean

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

string

Format: Variable length, up to 128 AN
Description: Shipping address line 1.

string

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

string

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

string

Format: Fixed length, 3 AN
Description: Shipping state.

string

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

string

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

string

Format: Fixed length, 10 AN
Description: Shipping zip code.

string

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

Responses

Updated 6 months ago

Language
Credentials
Basic
base64
:
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago