refund

POST 
/v1/orders/:id/refund

refund

Request

Path Parameters

id stringrequired
Example: 01904432-1f40-7c4d-a5ac-b738be2e532b

application/json

Body

amount integer

integer | min:1

Responses

200

refunds 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 string

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",
      "response_code": "string",
      "retrieval_reference": "string",
      "stan": "string",
      "auth_code": "string",
      "created_at": "string"
    }
  ]
}

Example

{
  "reauthorized_order_id": null,
  "agreement": null,
  "id": "01904432-1eee-7526-bcbd-4ce1711f325a",
  "merchant": {
    "id": "01904432-1ee9-7b8d-878c-90eceb671a89",
    "name": "Merchant 21",
    "arabic_name": "الإسم العربي",
    "merchant_id": "60021"
  },
  "currency": "SAR",
  "amount": 409402,
  "captured_amount": 409402,
  "refunded_amount": 409402,
  "voided_amount": 0,
  "description": "Earum optio quisquam nulla.",
  "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": 9,
    "year": 2026
  },
  "airline": {
    "reference": "582971014"
  },
  "sub_merchant": {
    "id": "3e5f1f697148f6d6791694e556b318",
    "registered_name": "Schiller, Koepp and Koch",
    "trading_name": "Hilll-Toy",
    "email": "shanel@cronin.test"
  },
  "transactions": [
    {
      "id": "01904432-1ef0-78d1-aae5-2d84ee64344a",
      "status": "approved",
      "type": "capture",
      "source_type": "merchant",
      "reverse_reason": null,
      "justification": null,
      "reversed_transaction_id": null,
      "message": "APPROVED",
      "response_code": "00",
      "retrieval_reference": "932759261218",
      "stan": "611400",
      "auth_code": "860790",
      "created_at": "2024-06-23T08:24:13Z"
    },
    {
      "id": "01904432-1f02-7176-a9fa-5d259b4675cc",
      "status": "approved",
      "type": "refund",
      "source_type": "merchant",
      "reverse_reason": null,
      "justification": null,
      "reversed_transaction_id": null,
      "message": "APPROVED",
      "response_code": "00",
      "retrieval_reference": "241750000001",
      "stan": "000001",
      "auth_code": null,
      "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...