Transition a settlement request status (sandbox only)
curl --request PATCH \
--url https://api-sandbox.superbank.co/v0/sandbox/settlement-requests/{id}/status \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"status": "SETTLEMENT_COMPLETED"
}
'import requests
url = "https://api-sandbox.superbank.co/v0/sandbox/settlement-requests/{id}/status"
payload = { "status": "SETTLEMENT_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: 'SETTLEMENT_COMPLETED'})
};
fetch('https://api-sandbox.superbank.co/v0/sandbox/settlement-requests/{id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Sandbox
Transition a settlement request status (sandbox only)
Simulate a settlement request status transition. Triggers outbound webhooks and realtime updates.
PATCH
/
v0
/
sandbox
/
settlement-requests
/
{id}
/
status
Transition a settlement request status (sandbox only)
curl --request PATCH \
--url https://api-sandbox.superbank.co/v0/sandbox/settlement-requests/{id}/status \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"status": "SETTLEMENT_COMPLETED"
}
'import requests
url = "https://api-sandbox.superbank.co/v0/sandbox/settlement-requests/{id}/status"
payload = { "status": "SETTLEMENT_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: 'SETTLEMENT_COMPLETED'})
};
fetch('https://api-sandbox.superbank.co/v0/sandbox/settlement-requests/{id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Authorizations
Path Parameters
Settlement request ID
Body
application/json
The target settlement request status
Available options:
REQUEST_STARTED, REQUEST_EXPIRED, REQUEST_CANCELED, REQUEST_COMPLETED, REQUEST_REFUNDED, FUNDS_SENT, FUNDS_RECEIVING_LATE, SETTLEMENT_SENT, SETTLEMENT_COMPLETED, AWAITING_PAYIN_RECONCILIATION, PAYIN_CANCELED, PAYIN_UNDER_REVIEW, PAYIN_FAILED, PAYIN_AMOUNT_MISMATCH, PAYOUT_CANCELED, PAYOUT_UNDER_REVIEW, PAYOUT_FAILED Example:
"SETTLEMENT_COMPLETED"
Reason for failure (when transitioning to a failure status)
Example:
"Payment rejected by provider"
Response
Settlement request status transitioned