Revoke a charge

Cancel a charge that should no longer accept payment.

DELhttps://api.raims.com/v1/charges/{id}

Revokes a charge by public identifier. Use this request when the charge should no longer accept payment. It must belong to the company and environment of your API key. The record and history remain available for lookup; revocation does not refund or return paid amounts.

Cancellation may depend on bank confirmation. If the request remains pending or ends without a conclusive result, track the same charge through the individual lookup before trying again. Consider the charge canceled only after confirmation.

See the differences between Sandbox and Production and how to track confirmation in Revoke a charge.

Path Params

idstringrequired

The charge's public identifier in Raims, received when creating or listing charges.

Up to 100 characters

Responses

For common errors, see HTTP response codes.

Updated 13 hours ago

Language

Credentials

Header

cURL Request

curl --request DELETE \
  --url https://api.raims.com/v1/charges/%7Bid%7D \
  --header 'accept: application/json'

Response

Click Try it to send a request and see the response here. Or choose an example:

application/json

Revoke a charge

Path Params

Responses

200OK

202Accepted

400Bad Request

404Not Found

409Conflict