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"
}
'import requests
url = "https://sandbox.dollarpe.xyz/pos/api/v1/payout/mock-payout-status"
payload = {
"payout_id": "4e6f1b20-a73c-11ec-b909-0242ac120002",
"payout_status": "SUCCESS"
}
headers = {
"X-API-KEY": "<api-key>",
"X-TIMESTAMP": "<api-key>",
"X-SIGNATURE": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'X-API-KEY': '<api-key>',
'X-TIMESTAMP': '<api-key>',
'X-SIGNATURE': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({payout_id: '4e6f1b20-a73c-11ec-b909-0242ac120002', payout_status: 'SUCCESS'})
};
fetch('https://sandbox.dollarpe.xyz/pos/api/v1/payout/mock-payout-status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.dollarpe.xyz/pos/api/v1/payout/mock-payout-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'payout_id' => '4e6f1b20-a73c-11ec-b909-0242ac120002',
'payout_status' => 'SUCCESS'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>",
"X-SIGNATURE: <api-key>",
"X-TIMESTAMP: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.dollarpe.xyz/pos/api/v1/payout/mock-payout-status"
payload := strings.NewReader("{\n \"payout_id\": \"4e6f1b20-a73c-11ec-b909-0242ac120002\",\n \"payout_status\": \"SUCCESS\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("X-TIMESTAMP", "<api-key>")
req.Header.Add("X-SIGNATURE", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://sandbox.dollarpe.xyz/pos/api/v1/payout/mock-payout-status")
.header("X-API-KEY", "<api-key>")
.header("X-TIMESTAMP", "<api-key>")
.header("X-SIGNATURE", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"payout_id\": \"4e6f1b20-a73c-11ec-b909-0242ac120002\",\n \"payout_status\": \"SUCCESS\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.dollarpe.xyz/pos/api/v1/payout/mock-payout-status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["X-TIMESTAMP"] = '<api-key>'
request["X-SIGNATURE"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payout_id\": \"4e6f1b20-a73c-11ec-b909-0242ac120002\",\n \"payout_status\": \"SUCCESS\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Success",
"data": {
"payout_id": "4e6f1b20-a73c-11ec-b909-0242ac120002",
"payout_status": "SUCCESS"
}
}{
"success": false,
"message": "Internal Server Error",
"err_code": "SYS_INTERNAL_ERROR",
"errors": "Unexpected error occurred. Please try again later.",
"data": null
}Order
Mock Payout Status [Sandbox Only]
Simulates payout order status transitions in the sandbox environment for testing your off-ramp flow.
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"
}
'import requests
url = "https://sandbox.dollarpe.xyz/pos/api/v1/payout/mock-payout-status"
payload = {
"payout_id": "4e6f1b20-a73c-11ec-b909-0242ac120002",
"payout_status": "SUCCESS"
}
headers = {
"X-API-KEY": "<api-key>",
"X-TIMESTAMP": "<api-key>",
"X-SIGNATURE": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'X-API-KEY': '<api-key>',
'X-TIMESTAMP': '<api-key>',
'X-SIGNATURE': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({payout_id: '4e6f1b20-a73c-11ec-b909-0242ac120002', payout_status: 'SUCCESS'})
};
fetch('https://sandbox.dollarpe.xyz/pos/api/v1/payout/mock-payout-status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.dollarpe.xyz/pos/api/v1/payout/mock-payout-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'payout_id' => '4e6f1b20-a73c-11ec-b909-0242ac120002',
'payout_status' => 'SUCCESS'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>",
"X-SIGNATURE: <api-key>",
"X-TIMESTAMP: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.dollarpe.xyz/pos/api/v1/payout/mock-payout-status"
payload := strings.NewReader("{\n \"payout_id\": \"4e6f1b20-a73c-11ec-b909-0242ac120002\",\n \"payout_status\": \"SUCCESS\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("X-TIMESTAMP", "<api-key>")
req.Header.Add("X-SIGNATURE", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://sandbox.dollarpe.xyz/pos/api/v1/payout/mock-payout-status")
.header("X-API-KEY", "<api-key>")
.header("X-TIMESTAMP", "<api-key>")
.header("X-SIGNATURE", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"payout_id\": \"4e6f1b20-a73c-11ec-b909-0242ac120002\",\n \"payout_status\": \"SUCCESS\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.dollarpe.xyz/pos/api/v1/payout/mock-payout-status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["X-TIMESTAMP"] = '<api-key>'
request["X-SIGNATURE"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payout_id\": \"4e6f1b20-a73c-11ec-b909-0242ac120002\",\n \"payout_status\": \"SUCCESS\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Success",
"data": {
"payout_id": "4e6f1b20-a73c-11ec-b909-0242ac120002",
"payout_status": "SUCCESS"
}
}{
"success": false,
"message": "Internal Server Error",
"err_code": "SYS_INTERNAL_ERROR",
"errors": "Unexpected error occurred. Please try again later.",
"data": null
}Mock Payout Status [Sandbox Only]
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
API Key for authentication
Current timestamp in seconds since epoch
HMAC SHA256 signature of the request encoded in Base64
Body
application/json
⌘I

