Confirm

Confirm payment deposit

post

Confirm a payment deposit by providing the transaction reference and blockchain transaction hash. This endpoint initiates the processing of the payment after the deposit has been verified on the blockchain.

Authorizations

ServiceKey

X-Service-KeystringRequired

Your Switch API service key. Contact us at [e-mail] to obtain your service key.

Body

application/json

referencestring · uuidRequired

The unique transaction reference identifier

Example: 550e8400-e29b-41d4-a716-446655440000

hashstringRequired

The blockchain transaction hash for the deposit

Example: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef

Responses

200

Payment confirmation initiated successfully

application/json

400

Bad request - validation error or invalid parameters

application/json

post

/confirm

HTTPcURLJavaScriptPython

POST /confirm HTTP/1.1
Host: api.onswitch.xyz
X-Service-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "reference": "550e8400-e29b-41d4-a716-446655440000",
  "hash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"
}

{
  "success": true,
  "status": 200,
  "message": "Payment confirmed successfully",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "data": {
    "reference": "550e8400-e29b-41d4-a716-446655440000",
    "status": "PENDING"
  }
}