void

POST 
/v1/orders/:id/void

void

Request

Path Parameters

id stringrequired
Example: 01904432-1e6d-7766-bc65-929086a6385a

application/json

Body

amount integer

integer | min:1

Responses

200

voids an order

application/json

Schema

Schema

id string

merchant

object

id string

name string

arabic_name string

merchant_id string
currency string
amount integer
captured_amount integer
refunded_amount integer
voided_amount integer
description string
created_at string
updated_at string

source

object

type string

scheme string

first_digits string

last_digits string

month integer

year integer
reauthorized_order_id nullable

airline

object

reference string

sub_merchant

object

id string

registered_name string

trading_name string

email string
agreement nullable

transactions

object[]

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

]

Example (from schema)

{
  "id": "string",
  "merchant": {
    "id": "string",
    "name": "string",
    "arabic_name": "string",
    "merchant_id": "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"
    }
  ]
}

Example

{
  "reauthorized_order_id": null,
  "agreement": null,
  "id": "01904432-1e01-74be-aee6-0edfd0185b16",
  "merchant": {
    "id": "01904432-1dfb-7641-b30b-28877b766c6e",
    "name": "Merchant 15",
    "arabic_name": "الإسم العربي",
    "merchant_id": "60015"
  },
  "currency": "SAR",
  "amount": 237762,
  "captured_amount": 0,
  "refunded_amount": 0,
  "voided_amount": 0,
  "description": "Quod odio perspiciatis quam.",
  "created_at": "2024-06-23T08:24:13Z",
  "updated_at": "2024-06-23T08:24:13Z",
  "source": {
    "type": "card",
    "scheme": "visa",
    "first_digits": "42424242",
    "last_digits": "4242",
    "month": 8,
    "year": 2027
  },
  "airline": {
    "reference": "911355908"
  },
  "sub_merchant": {
    "id": "79ace3af90f7bc2f59dccde875ef9f",
    "registered_name": "Armstrong-Bayer",
    "trading_name": "Oberbrunner-Schoen",
    "email": "barton.stark@ryan.example"
  },
  "transactions": [
    {
      "id": "01904432-1e03-7fd3-b537-39534dfc4587",
      "status": "initiated",
      "type": "authorize",
      "source_type": "merchant",
      "reverse_reason": null,
      "justification": null,
      "reversed_transaction_id": null,
      "message": "INITIATED",
      "response_code": null,
      "retrieval_reference": "195473775628",
      "stan": "822819",
      "auth_code": "867080",
      "created_at": "2024-06-23T08:24:13Z"
    },
    {
      "id": "01904432-1e12-7907-8827-f08bce3673d9",
      "status": "failed",
      "type": "void",
      "source_type": "merchant",
      "reverse_reason": null,
      "justification": null,
      "reversed_transaction_id": null,
      "message": "TIMEOUT",
      "response_code": "AE",
      "retrieval_reference": "241750000001",
      "stan": "000001",
      "auth_code": "258195",
      "created_at": "2024-06-23T08:24:13Z"
    }
  ]
}

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

errors

object

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...