Skip to content

Set a cardholder's billing or delivery address

PUT/v1/cardholders/{id}/addresses/{kind}

Requires an API client bearer token.

Replaces the current address of this kind (billing or delivery). The address it replaces is kept in the history, not overwritten: a recently changed address is itself a risk signal. Sending the address already on file changes nothing and records nothing. Requires an Idempotency-Key header. Emits cardholder.updated naming billing_address or delivery_address — never the address itself.

Parameters

Path parameters

NameRequiredDescription
idrequired
kindrequired

Header parameters

NameRequiredDescription
Idempotency-Keyrequired

Client-chosen. An identical retry with the same key returns the stored response; reusing the key with a different payload returns 409.

Request body

streetstringrequired

The street name, without the building number.

building_numberstring | null

The building or house number as written, such as "221B". Kept apart from the street because address matching (AVS, 3-D Secure risk checks) compares it on its own. Omit it for an address with no number.

line2string | null

Anything else the address needs: flat, floor, building name, care-of.

postal_codestring | null

The postal code as written. Omit it only where the country has none: address matching compares it on its own.

citystringrequired

The city, town or locality.

regionstring | null

The state, province or county, where the country uses one.

countrystringrequired

ISO 3166-1 alpha-2, upper case (GB, DE, US).

Example

curl -X PUT https://api.rigid.fi/v1/cardholders/{id}/addresses/{kind} \
  -H "Authorization: Bearer $RIGID_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "street": "string",
  "city": "string",
  "country": "string"
}'

Responses

200

The address now on file for this kind.

idstring (uuid)required
cardholder_idstring (uuid)required
kind"billing" | "delivery"required
streetstringrequired
building_numberstring | nullrequired
line2string | nullrequired
postal_codestring | nullrequired
citystringrequired
regionstring | nullrequired
countrystringrequired
created_atstringrequired

When this address was set. For the current address: on file since.

400

Validation error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
401

Authentication required

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
403

Forbidden — the caller may not act on this programme, or (code `live_mode_card_read_only`) live mode refuses setting a cardholder address, pending scheme certification

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
404

Cardholder not found

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
409

Idempotency-Key reused with a different payload

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring