void

POST 
/v1/orders/:id/void

void

Request

Path Parameters

id stringrequired
Example: 0191f5a7-4339-77cf-a63f-42d78a81f351

application/json

Body

amount integerrequired

Possible values: >= 1

transaction_id string

Responses

200

returns success

application/json

Schema

Schema

id string
merchantobject
id string
acquirer_id string
name string
arabic_name string
merchant_id string
rule_precedence string
currency string
amount integer
captured_amount integer
refunded_amount integer
voided_amount integer
description string
created_at string
updated_at string
sourceobject
type string
issuer nullable
card_type nullable
category nullable
country_alpha2 nullable
scheme string
first_digits string
last_digits string
month integer
year integer
reauthorized_order_id nullable
airlineobject
reference string
sub_merchantobject
id string
registered_name string
trading_name string
email string
agreement nullable
transactionsobject[]

Array [

id string

status string

type string

source_type string

reverse_reason nullable

justification nullable

reversed_transaction_id nullable

message string

response_code nullable

retrieval_reference string

stan string

auth_code string

created_at string

amount integer

refunded_amount integer

]

Example (from schema)

{
  "id": "string",
  "merchant": {
    "id": "string",
    "acquirer_id": "string",
    "name": "string",
    "arabic_name": "string",
    "merchant_id": "string",
    "rule_precedence": "string"
  },
  "currency": "string",
  "amount": 0,
  "captured_amount": 0,
  "refunded_amount": 0,
  "voided_amount": 0,
  "description": "string",
  "created_at": "string",
  "updated_at": "string",
  "source": {
    "type": "string",
    "scheme": "string",
    "first_digits": "string",
    "last_digits": "string",
    "month": 0,
    "year": 0
  },
  "airline": {
    "reference": "string"
  },
  "sub_merchant": {
    "id": "string",
    "registered_name": "string",
    "trading_name": "string",
    "email": "string"
  },
  "transactions": [
    {
      "id": "string",
      "status": "string",
      "type": "string",
      "source_type": "string",
      "message": "string",
      "retrieval_reference": "string",
      "stan": "string",
      "auth_code": "string",
      "created_at": "string",
      "amount": 0,
      "refunded_amount": 0
    }
  ]
}

Example

{
  "id": "0191f5a7-4312-7724-bc7d-40a62a50117f",
  "merchant": {
    "id": "0191f5a7-430e-7ff2-b36c-01b38e0c2434",
    "acquirer_id": "0191f5a7-430b-74f9-90b1-d072feeb1539",
    "name": "Merchant 40",
    "arabic_name": "الإسم العربي",
    "merchant_id": "60040",
    "rule_precedence": "merchant"
  },
  "currency": "SAR",
  "amount": 369454,
  "captured_amount": 0,
  "refunded_amount": 0,
  "voided_amount": 0,
  "description": "Quam qui eum occaecati.",
  "created_at": "2024-09-15T12:27:45Z",
  "updated_at": "2024-09-15T12:27:45Z",
  "source": {
    "type": "apple_pay",
    "issuer": null,
    "card_type": null,
    "category": null,
    "country_alpha2": null,
    "scheme": "mastercard",
    "first_digits": "52974123",
    "last_digits": "1465",
    "month": 12,
    "year": 2025
  },
  "reauthorized_order_id": null,
  "airline": {
    "reference": "2853462810"
  },
  "sub_merchant": {
    "id": "ece4b2d99a8fc555df98361cfcbb2f",
    "registered_name": "Bahringer-Tremblay",
    "trading_name": "Nikolaus and Sons",
    "email": "maryam_gerlach@leannon.test"
  },
  "agreement": null,
  "transactions": [
    {
      "id": "0191f5a7-4313-75e0-8ea3-b936a8879693",
      "status": "initiated",
      "type": "authorize",
      "source_type": "merchant",
      "reverse_reason": null,
      "justification": null,
      "reversed_transaction_id": null,
      "message": "INITIATED",
      "response_code": null,
      "retrieval_reference": "639993450011",
      "stan": "817968",
      "auth_code": "579981",
      "amount": 369454,
      "refunded_amount": 0,
      "created_at": "2024-09-15T12:27:45Z"
    },
    {
      "id": "6abec1c2-a7e9-4bad-8215-38fa25504ede",
      "status": "failed",
      "type": "void",
      "source_type": "merchant",
      "reverse_reason": null,
      "justification": null,
      "reversed_transaction_id": null,
      "message": "ISSUER OR SWITCH IS INOPERATIVE",
      "response_code": "91",
      "retrieval_reference": "242590000001",
      "stan": "000001",
      "auth_code": null,
      "amount": 369454,
      "refunded_amount": 0,
      "created_at": "2024-09-15T12:27:45Z"
    }
  ]
}

400

fails when retries are exhausted

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "string"
}

Example

{
  "message": "Initial request is still processing."
}

401

returns unauthorized

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "string"
}

Example

{
  "message": "Missing authentication information"
}

403

returns forbidden

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "string"
}

Example

{
  "message": "Unauthorized"
}

422

returns unprocessable_entity

application/json

Schema

Schema

message string
errorsobject
amount string[]

Example (from schema)

{
  "message": "string",
  "errors": {
    "amount": [
      "string"
    ]
  }
}

Example

{
  "message": "Data validation failed",
  "errors": {
    "amount": [
      "The value must be greater than or equal to 1."
    ]
  }
}

Loading...