> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zapyd.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Mock Payout Status [Sandbox Only]
> Sandbox only. Simulates payout order status changes so you can test your offramp flow.
Add the Zapyd "Mock Payout Status" call (`PATCH /pos/api/v1/payout/mock-payout-status`) to my backend. Sandbox only. Simulates payout order status changes so you can test your offramp flow.
* Sandbox: `PATCH https://sandbox.zapyd.com/pos/api/v1/payout/mock-payout-status`
* Production: none, sandbox only
JSON body:
* `payout_id` (string, uuid, required): Zapyd payout ID.
* `payout_status` (string, required): Target status: SUCCESS, FAILED or REFUNDED (sandbox only).
Success: HTTP 200, `{status: true, message, data}`. `data`: `payout_id`, `payout_status`.
Every endpoint can also return 401 `AUTH_*` (signature, timestamp or key: fix, don't retry), and 429 or 5xx (retry with backoff).
Rules:
* Sandbox only: it doesn't exist in production. Keep it behind a sandbox-only flag or in test code.
* Works only on payouts in `PROCESSING`. Sends the same `PAYOUT` webhook production would.
Signing (every request):
* Headers: `X-API-KEY`, `X-TIMESTAMP` (Unix seconds, within 300 s of server time; generate per request) and `X-SIGNATURE`.
* `X-SIGNATURE` = Base64(HMAC-SHA256(key = API secret, message = apiKey + "|" + timestamp + "|" + canonicalBody)). Base64 of the raw digest, not hex.
* canonicalBody: the JSON body with keys sorted at every nesting level, no whitespace (separators `,` and `:`), and every non-ASCII character escaped as lowercase `\uXXXX` (Python `json.dumps(body, sort_keys=True, separators=(",", ":"))`). Requests with no body (GET, DELETE) sign `{}`. Query parameters are not signed.
* Send the exact canonicalBody string you signed as the request body, with `Content-Type: application/json`.
* Test vector: key `3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d`, secret `test-secret-do-not-use`, timestamp `1735689600`. Signing `{}` gives `6sCtVSRQjU9+2/af8gdwUAvY1l6Ii6ENcbRfanPkhY0=`. Body `{"customer_id":"78c99d71-f28f-47a9-8302-93b286efbe0e","amount":100.5,"currency":"INR","meta":{"note":"Café","b":2,"a":1}}` gives `l+DvQrzlKbsOSxSYOdWoWHEehcFRZfDJPKlLDkm2cSI=`.
Deliver:
1. A typed `mockPayoutStatus` function in this codebase's language and HTTP client. Reuse an existing Zapyd client and signer, or write one small shared client.
2. Config from `ZAPYD_API_KEY`, `ZAPYD_API_SECRET` and `ZAPYD_BASE_URL`. The secret stays on the server, never in a browser or app.
3. Return `data`. When `status` is false, throw an error with the HTTP status, `err_code`, `message` and `errors`. Don't show raw errors to end users.
4. Retry only 429 and 5xx: exponential backoff from 1 s, capped at 30 s, at most 5 attempts.
5. Amounts as strings. Types for every field above.
6. Tests: the signer against the test vector, and this call against sandbox.
Reference: `https://docs.zapyd.com/api-reference-exchange/endpoint/payout/order/mock-payout-status.md`
This endpoint is available only in the **Sandbox environment** and allows you to simulate payout status changes for testing purposes.
This endpoint only works for payouts that are currently in the **`PROCESSING`** state. Attempting to change the status of payouts in other states will not have any effect.
## OpenAPI
````yaml PATCH /payout/mock-payout-status
openapi: 3.1.0
info:
title: Zapyd API
description: API for Zapyd - Customer, Payout, and Webhook services
license:
name: MIT
version: 1.0.0
servers:
- url: https://sandbox.zapyd.com/pos/api/v1
description: Payout API Base URL
variables:
base_url:
default: https://sandbox.zapyd.com
- url: https://sandbox.zapyd.com/cms/api/v1
description: Customer API Base URL
variables:
base_url:
default: https://sandbox.zapyd.com
security:
- ApiKeyAuth: []
TimestampAuth: []
SignatureAuth: []
tags:
- name: Customer
description: Customer related operations
x-displayName: Customer
x-traitTag: true
- name: Payout
description: Payout related operations
- name: Webhooks
description: Webhook related operations
- name: Widget
description: Hosted buy/sell widget session initialization
paths:
/payout/mock-payout-status:
patch:
tags:
- Payout
description: Mock Payout Status [Sandbox Environment Only]
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- payout_id
- payout_status
properties:
payout_id:
type: string
format: uuid
example: 4e6f1b20-a73c-11ec-b909-0242ac120002
description: Zapyd payout ID
payout_status:
type: string
example: SUCCESS
enum:
- SUCCESS
- FAILED
- REFUNDED
description: 'Target status: SUCCESS, FAILED or REFUNDED (sandbox only)'
responses:
'200':
description: Payout Status updated successfully
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: true
message:
type: string
example: Success
data:
type: object
properties:
payout_id:
type: string
format: uuid
example: 4e6f1b20-a73c-11ec-b909-0242ac120002
payout_status:
type: string
example: SUCCESS
'500':
description: Internal Server Error
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Internal Server Error
data:
type: 'null'
err_code:
type: string
example: SYS_INTERNAL_ERROR
errors:
type: string
example: Unexpected error occurred. Please try again later.
servers:
- url: https://sandbox.zapyd.com/pos/api/v1
description: Payout API Base URL
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-KEY
description: API Key for authentication
TimestampAuth:
type: apiKey
in: header
name: X-TIMESTAMP
description: Current timestamp in seconds since epoch
SignatureAuth:
type: apiKey
in: header
name: X-SIGNATURE
description: HMAC SHA256 signature of the request encoded in Base64
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.