Assign an in-inventory card to a cardholder

put

https://api.staging.berkeleypayment.com/rest/v1/instant_issuance/cardholders/{id}/assign

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

≥ 1

Cardholder identifier

Query Params

bypass_errors

boolean

Re-submit with true to suppress non-blocking errors (e.g. card_expires_soon) and proceed with the assign. Use a new Idempotency-Key when re-submitting: the key does not cover the query string, so reusing it replays the original error.

Body Params

address1

string

required

length between 1 and 40

Street address line 1 (CA: max 30, US: max 40)

address2

string

length ≤ 30

Street address line 2

city

string

required

length between 1 and 100

City (CA: max 100, US: max 20)

country

int64

enum

required

ISO 3166-1 numeric country code. Only Canada (124) and the USA (840) are supported; any other value is rejected with 422.

Allowed:

date_of_birth

string

^\d{4}-\d{2}-\d{2}$

Birth date in yyyy-MM-dd format. Required unless your program is configured to make it optional; on update, send the current value to keep it.

string

length ≤ 50

Email address (RFC 2822). Required unless the program sets allow_optional_email; on such a program, omitting the field leaves the existing email unchanged and sending an empty string clears it.

external_reference

string

length between 1 and 128

Client correlation identifier. When the company-level enforce_unique_external_reference service configuration is on, this field is required and must be unique within the company. Optional otherwise.

external_tag

string

length ≤ 255

User-defined external reference field

first_name

string

required

length between 1 and 50

Cardholder's first name

last_name

string

required

length between 1 and 50

Cardholder's last name

middle_name

string

length ≤ 50

Cardholder's middle name

phones

array of objects | null

Typed phone numbers, at most one per type (mobile, work, home). When provided, replaces the cardholder's phones in full. Required unless the program sets allow_optional_phone; on such a program, omitting the field leaves the existing phones unchanged and sending an empty array clears them.

phones

postal_code

string

required

length ≥ 1

ZIP/postal code. CA format K1A-1A1; US format 12345 or 12345-1234.

shipping_address

object

Card shipping address. When omitted, the existing shipping address is left unchanged.

shipping_method

string

enum

Shipping method for physical card delivery. Required for physical card programs. Standard method token (standard, courier, express, international). Numeric processor codes are accepted for back-compat and deprecated.

state

string

required

length between 2 and 2

State or province as 2-character abbreviation

Headers

Idempotency-Key

string

length ≤ 255

Optional idempotency key. Replaying within 24h returns the cached response; reusing a key with different parameters returns 400 idempotency_params_error.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

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

application/json

application/problem+json

200OK

defaultError