/api/v1/declared-values write:declared_value Submits or updates a declared value for one card (shorthand body) or a batch (items[]). Two outcomes on submit — always read status back: if your account has an auto-accept cap configured, any value at or below it returns ACCEPTED immediately with decided_at and declared_value_effective_at already stamped; values above the cap (and all values if no cap is configured) return PENDING for review, then move to ACCEPTED or REJECTED once a reviewer decides. A single batch can return a mix of both — never assume PENDING; branch on the returned status. Read your cap and threshold from GET /account. Any previously PENDING row for the same card is marked SUPERSEDED. An email goes to your notice address both on submission and on each decision. A declared_value.submitted event is written to your activity log.
PUT /api/v1/declared-values write These inputs are shared across all docs pages, so an id entered here carries over.
{
"unique_id": "CARD-EXAMPLE-1",
"value_cents": 2500,
"submission_key": "docs-declared-CARD-EXAMPLE-1"
}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 -X PUT 'https://service.rip.fun/api/v1/declared-values' \
-H 'X-API-Key: rip_…' \
-H 'Content-Type: application/json' \
-d '{"unique_id":"CARD-EXAMPLE-1","value_cents":2500,"submission_key":"docs-declared-CARD-EXAMPLE-1"}' | Field | Type | Required | Description |
|---|---|---|---|
unique_id | string | yes | Shorthand for a single card (or use items[]) |
value_cents | number | yes | Positive integer cents |
items[] | array | — | Batch form: [{unique_id, value_cents}, …] instead of the shorthand fields |
submission_key | string | — | Idempotency token, up to 128 chars; a replay returns the original rows with 201 |
data)| Field | Description |
|---|---|
declared_values[].id / tenant_card_id / declared_value_cents / currency | The submitted rows |
declared_values[].status | PENDING | ACCEPTED | REJECTED | SUPERSEDED — branch on this, not on an assumption |
declared_values[].decided_at / declared_value_effective_at / decided_by_user_id / reject_reason | Stamped immediately on auto-accept, or once a reviewer decides |
declared_values[].exceeds_threshold | Flags values above your declared-value threshold — extra insurance/handling becomes billable pass-through, invoiced separately. Informational; does not block the submission |
declared_values[].submitted_at / created_at / updated_at | Timestamps |
| Status | Code | When |
|---|---|---|
| 400 | invalid input | empty items, missing unique_id, or non-positive value_cents |
| 404 | card(s) not found | one or more cards not part of your account |
See Errors for the response envelope and the full code list.