Miscellaneous
Confirm deposit
curl --request POST \
--url https://api.onswitch.xyz/confirm \
--header 'Content-Type: application/json' \
--header 'x-service-key: <api-key>' \
--data '
{
"reference": "550e8400-e29b-41d4-a716-446655440000",
"hash": "0x9be818c30cbe52dc3b36f05e631f0de74542967054d0821dc8bd660ba9c2de7e"
}
'{
"success": true,
"message": "Payment confirmed successfully",
"timestamp": "2024-01-01T00:00:00.000Z",
"data": {
"reference": "550e8400-e29b-41d4-a716-446655440000",
"status": "PROCESSING"
}
}Confirm deposit
Confirm a payment deposit by providing the transaction reference. This endpoint initiates the processing of the payment after the deposit has been verified on the blockchain.
POST
/
confirm
Confirm deposit
curl --request POST \
--url https://api.onswitch.xyz/confirm \
--header 'Content-Type: application/json' \
--header 'x-service-key: <api-key>' \
--data '
{
"reference": "550e8400-e29b-41d4-a716-446655440000",
"hash": "0x9be818c30cbe52dc3b36f05e631f0de74542967054d0821dc8bd660ba9c2de7e"
}
'{
"success": true,
"message": "Payment confirmed successfully",
"timestamp": "2024-01-01T00:00:00.000Z",
"data": {
"reference": "550e8400-e29b-41d4-a716-446655440000",
"status": "PROCESSING"
}
}Authorizations
Service key for API authentication
Body
application/json
The unique transaction reference identifier
Example:
"550e8400-e29b-41d4-a716-446655440000"
Blockchain transaction hash for the deposit. Required when confirming OFFRAMP payments, optional for other payment types.
Example:
"0x9be818c30cbe52dc3b36f05e631f0de74542967054d0821dc8bd660ba9c2de7e"
Response
Payment confirmation initiated successfully
⌘I