Transition a payment status (sandbox only)
curl --request PATCH \
--url https://api-sandbox.superbank.co/v0/sandbox/payments/{id}/status \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"status": "COMPLETED"
}
'import requests
url = "https://api-sandbox.superbank.co/v0/sandbox/payments/{id}/status"
payload = { "status": "COMPLETED" }
headers = {
"X-Api-Key": "<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>', 'Content-Type': 'application/json'},
body: JSON.stringify({status: 'COMPLETED'})
};
fetch('https://api-sandbox.superbank.co/v0/sandbox/payments/{id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Sandbox
Transition a payment status (sandbox only)
Simulate a payment status transition. Triggers outbound webhooks and realtime updates.
PATCH
/
v0
/
sandbox
/
payments
/
{id}
/
status
Transition a payment status (sandbox only)
curl --request PATCH \
--url https://api-sandbox.superbank.co/v0/sandbox/payments/{id}/status \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"status": "COMPLETED"
}
'import requests
url = "https://api-sandbox.superbank.co/v0/sandbox/payments/{id}/status"
payload = { "status": "COMPLETED" }
headers = {
"X-Api-Key": "<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>', 'Content-Type': 'application/json'},
body: JSON.stringify({status: 'COMPLETED'})
};
fetch('https://api-sandbox.superbank.co/v0/sandbox/payments/{id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Authorizations
Path Parameters
Payment ID
Body
application/json
The target payment status
Available options:
AWAITING_FUNDS, PENDING, PROCESSING, SENT, COMPLETED, CANCELED, FAILED, EXPIRED, REFUNDED, SCHEDULED, UNDER_REVIEW Example:
"COMPLETED"
Reason for failure (required when status is FAILED)
Example:
"Insufficient funds"
Response
Payment status transitioned