reseller
POST /v1/reseller/client-wallets/top-ups/{topUpId}/refunds
Send a deposit back to the card it came from.
인증
Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 reseller.manage 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.
조직 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