Transfer card

POST /api/v1/cards/:unique_id/transfer write:transfer

Records a custody or ownership change for one of your cards without creating a shipment — for OTC or peer-to-peer transfers where the card stays in the warehouse. Holder strings are free-form and defined by you; we do not interpret them. A replay with the same idempotency_key returns the ORIGINAL transfer with the same 201 as the first call, so send one on every write. A card.transferred event is written to your activity log on success.

Try it POST /api/v1/cards/CARD-EXAMPLE-1/transfer write

These inputs are shared across all docs pages, so an id entered here carries over.

request body
object · 3 keys
{
  "to_holder": "demo-holder",
  "note": "docs demo transfer",
  "idempotency_key": "docs-transfer-CARD-EXAMPLE-1"
}
response

Not run yet. Press Run to make a live call against https://service.rip.fun (through this demo's server-side proxy; the API key never reaches the browser).

curl (tracks the inputs above)
curl -X POST 'https://service.rip.fun/api/v1/cards/CARD-EXAMPLE-1/transfer' \
  -H 'X-API-Key: rip_…' \
  -H 'Content-Type: application/json' \
  -d '{"to_holder":"demo-holder","note":"docs demo transfer","idempotency_key":"docs-transfer-CARD-EXAMPLE-1"}'

Request fields

FieldTypeRequiredDescription
to_holderstringyesNew holder, up to 255 chars
from_holderstringPrevious holder, up to 255 chars
notestringFree-form note, up to 512 chars
idempotency_keystringUp to 128 chars. Unique per account; a replay returns the original record (201, not 409). Use a token your own system can regenerate deterministically

Response fields (data)

FieldDescription
transfer.id / tenant_card_idTransfer row + the card it applies to
transfer.from_holder / to_holder / noteWhat you submitted
transfer.idempotency_key / api_key_id / created_atReplay token, the key that wrote it, timestamp

Errors

StatusCodeWhen
400to_holder requiredto_holder missing or invalid
404not foundcard not part of your account

See Errors for the response envelope and the full code list.