reseller
POST /v1/reseller/client-wallets/top-ups/{topUpId}/refunds
Send a deposit back to the card it came from.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 reseller.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
您的组织 ID 应填在此处
此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树；发送该参数则将调用范围缩小到一个组织。
您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X POST https://api.zinndigital.com/v1/reseller/client-wallets/top-ups/{topUpId}/refunds \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
⛔ **Back the way it came.** There is deliberately no "refund to wallet" option: a top-up already *is* wallet credit, so crediting it again would be a no-op wearing the name of a remedy, and wallet credit is an opt-in under consumer law rather than something silence can agree to. The balance is debited first and the gateway refund taken second; if the client has already spent the deposit the refund is refused with 422, and if the gateway declines it the balance is put back. Requires `reseller.manage`.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
topUpId (path) | Uuid | 是 | — |
org_id (query) | Uuid | 否 | Which of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred, and an id outside your direct memberships is a 404 r… |
请求正文
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
amount_minor | integer | 否 | Omit to refund everything still refundable on the deposit. |
reason | string | 否 | — |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
quoted_minor | integer | 否 | What the customer asked to add, and what the screen promised them. |
settled_minor | integer | null | 否 | What actually arrived. **`null` = not known yet**, never zero. |
fee_minor | integer | null | 否 | What the provider kept out of the settlement. **`null` = not known**, never zero — recording an unknown as `0` would credit the customer the shortfall. |
credited_minor | integer | 否 | What went into the balance — `settled_minor - fee_minor`. |
shortfall_minor | integer | null | 否 | `quoted_minor - credited_minor`. `null` until the top-up settles. Derived rather than stored: it is a difference between two recorded facts, and a stored copy is a second source… |
purpose | string<general, ai> | 否 | — |
is_auto | boolean | 否 | Whether a standing instruction created this, rather than a person. |
action_url | string | 否 | Where the customer must go to finish paying — a crypto pay-link or an SCA challenge. Losing it strands a pending top-up with no way to complete it. |
id | Uuid | 是 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
amount_minor | integer | 是 | — |
currency | string | 是 | — |
status | string<pending, requires_action, captured, failed> | 是 | ⛔ Credit is written on `captured` only. `pending` (a crypto invoice confirming) and `requires_action` (3-D Secure) both mean the money has not arrived yet. |
refunded_minor | integer | 是 | — |
refundable_minor | integer | 是 | What is left to send back to the card. Zero unless it captured. |
gateway | string | 否 | The provider's driver — `stripe`, `paypal`, `nowpayments`. ⛔ Never a credential and never a merchant-account reference: which account your provider banks with is their commercia… |
error | string | 否 | The gateway's refusal, in words the customer can act on. |
created_at | string | 是 | — |
captured_at | string | null | 否 | — |
此端点可能返回的错误
401 · 403 · 404 · 422 · 429