Skip to main content

Cancel a Transaction

Given a transactionId, makes a request to cancel a pending transaction.

Headers

    Content-Type String - (Required)
    application-json

    Accept String - (Required)
    application-json

    Authorization String - (Required)
    Bearer {ACCESS_TOKEN} (See Authentication)

Parameters

    transactionId String - (Required)
    ID of the transaction to void.

Returns

    transactionId String
    Your transaction ID.

    status enum
    CANCELED, TRANSACTION_STATUS_CHANGE_IN_PROCESS, INVALID_REQUEST or TRANSACTION_ALREADY_SUBMITTED - indicates if the cancellation was initiated successfully

    created datetime
    Timestamp when transaction was created.

    updated datetime
    Timestamp when transaction was updated.

Post Request

POST - /v1/payments/{TRANSACTION_ID}/cancel
PUT Request
1curl --location --request PUT '{API_BASE_URL}/v1/payments/{transactionId}/cancel' \
2--header 'Content-Type: application/json' \
3--header 'Accept: application/json' \
4--header 'Authorization: Bearer {ACCESS_TOKEN}'

Response Body

Reponse
1{
2	"transactionId": "78907890-7890-7890-7890-789078907890",
3	"status": "CANCELED",
4	"created": "2022-03-03T12:20:00Z",
5	"updated": "2022-03-05T16:20:00Z"
6}