Update Transaction

This endpoint allows you to refund, void, or reverse a transaction by passing the transaction_id as a path parameter.
The endpoint also supports partial refunds.

CAUTION

The store must have enough balance to process the refund amounts

Scopes

transactions.read_write- Transactions Read & Write

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Path Params

transaction_id

integer

required

Unique identification number assigned to the Transaction. List of Transaction IDs can be found here

Example:

293485739

Body Params application/json

action

enum<string>

optional

Action to be performed on the transaction; actions from the enum values only are allowed.

Allowed values:

refundvoidreverse

Example:

refund

amount

number

optional

Transaction Amount value.

currency

string

optional

Transaction Amount Currency value.

Example

{
  "action": "refund",
  "amount": 0,
  "currency": "string"
}

Responses

🟢201Progress In-Action

application/json

Body

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

object

optional

message

string

optional

A text or data communication generated by a system or application in response to a request.

code

number

optional

A numerical or alphanumeric identifier used in various systems and protocols to indicate the status or outcome of a specific request.

Example

{
  "status": 201,
  "success": true,
  "data": {
    "message": "Invoice Partially Refunded successfully",
    "code": 201
  }
}

🟠404Not Found

🟠422Error Validation

🟠401Unauthorized

Request

Request samples

Responses