Skip to main content
PATCH
/
payout
/
mock-payout-status
cURL
curl --request PATCH \
  --url https://sandbox.dollarpe.xyz/pos/api/v1/payout/mock-payout-status \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-SIGNATURE: <api-key>' \
  --header 'X-TIMESTAMP: <api-key>' \
  --data '
{
  "payout_id": "4e6f1b20-a73c-11ec-b909-0242ac120002",
  "payout_status": "SUCCESS"
}
'
{
  "status": true,
  "message": "Success",
  "data": {
    "payout_id": "4e6f1b20-a73c-11ec-b909-0242ac120002",
    "payout_status": "SUCCESS"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.dollarpe.xyz/llms.txt

Use this file to discover all available pages before exploring further.

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.

Authorizations

​
X-API-KEY
string
header
required

API Key for authentication

​
X-TIMESTAMP
string
header
required

Current timestamp in seconds since epoch

​
X-SIGNATURE
string
header
required

HMAC SHA256 signature of the request encoded in Base64

Body

application/json
​
payout_id
string<uuid>
required
Example:

"4e6f1b20-a73c-11ec-b909-0242ac120002"

​
payout_status
string
required
Example:

"SUCCESS"

Response

Payout Status updated successfully

​
status
boolean
Example:

true

​
message
string
Example:

"Success"

​
data
object