perform_extend

POST 
/v1/orders/:id/extend

perform_extend

Request

Path Parameters

id stringrequired
Example: 0191f5a7-440d-7f83-bfd5-09c907cfc2a6

application/json

Body

amount integerrequired
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-43df-7e76-9886-2d3180a464d0",
  "merchant": {
    "id": "0191f5a7-43db-7987-b9e8-5f1cb1ca12a7",
    "acquirer_id": "0191f5a7-43d8-7e70-a50e-3540c93b04c7",
    "name": "Merchant 46",
    "arabic_name": "الإسم العربي",
    "merchant_id": "60046",
    "rule_precedence": "merchant"
  },
  "currency": "SAR",
  "amount": 216506,
  "captured_amount": 0,
  "refunded_amount": 0,
  "voided_amount": 0,
  "description": "Quidem sed qui dicta.",
  "created_at": "2024-09-15T12:27:45Z",
  "updated_at": "2024-09-15T12:27:45Z",
  "source": {
    "type": "card",
    "issuer": null,
    "card_type": null,
    "category": null,
    "country_alpha2": null,
    "scheme": "mastercard",
    "first_digits": "55555555",
    "last_digits": "4444",
    "month": 6,
    "year": 2027
  },
  "reauthorized_order_id": null,
  "airline": {
    "reference": "5748552876"
  },
  "sub_merchant": {
    "id": "b23fb0db8cd2425b7eaad895262dd7",
    "registered_name": "Bogisich, Walsh and Goldner",
    "trading_name": "Jast, Thompson and Emard",
    "email": "filiberto.turner@kirlin-gleason.test"
  },
  "agreement": null,
  "transactions": [
    {
      "id": "0191f5a7-43e1-78ee-969a-153dc7ef048f",
      "status": "initiated",
      "type": "authorize",
      "source_type": "merchant",
      "reverse_reason": null,
      "justification": null,
      "reversed_transaction_id": null,
      "message": "INITIATED",
      "response_code": null,
      "retrieval_reference": "737811327028",
      "stan": "731277",
      "auth_code": "262738",
      "amount": 108253,
      "refunded_amount": 0,
      "created_at": "2024-09-15T12:27:45Z"
    },
    {
      "id": "802e92e2-e375-430d-9c86-404f2238b4a6",
      "status": "approved",
      "type": "extension",
      "source_type": "merchant",
      "reverse_reason": null,
      "justification": null,
      "reversed_transaction_id": null,
      "message": "APPROVED",
      "response_code": "00",
      "retrieval_reference": "242590000001",
      "stan": "000001",
      "auth_code": "882420",
      "amount": 108253,
      "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 0."
    ]
  }
}

Loading...