Payment Void

A void cancels a payment request that was submitted but not yet processed by the processor. A void request is declined when the payment request has already been sent to the processor

cUrl

POST /v1/payments/:id/void

curl –X POST https://api.firstoken.dev/v1/payments/:id/void' \
--header 'Content-Type: application/json' \
--header 'x-api-key: YOUR API KEY' \
--data '{
    "transaction_info": {
        "type": "payment_void",
        "reference_code": "123456789"
    },
    "device_info": {
        "ip_address": "12.7.8.120"
    }
}'

Params of the request

id: string

A valid payment identifier (transaction_id) received in previous requests.

Attributes of the response

status: string The status is a string result that only has two possible values. "Success, “Error” or "Fail".

message: string The message value represents a short description about the status code.

data: {object} The value of the data represents a set of JSON objects with the transaction’s details:

• transaction_info: {object} The wrapper object of the transaction’s information. Contains:

  • type: string The type of transaction response.

  • reference_code: string

    A reference code for the transaction.

  • transaction_id: string

    Our transaction identifier of the request. It is used in other requests.

  • request_id: string

    The identifier of the request associated with the transaction.

  • status: string

    The status received of the transaction.

  • created_at: ISO Date

    The ISO Date of the request

Example of the JSON response

{
    "status": "success",
    "message": "Payment void successful",
    "data": {
        "transaction_info": {
            "type": "payment_void_response",
            "reference_code": "123456789",
            "transaction_id": "0001709059532202519905",
            "request_id": "7090595336766133304951",
            "status": "Voided",
            "created_at": "2024-02-27T18:45:34Z"
        }
    }
}