Refund Pre-Order

This endpoint initiates a refund for a previously completed transaction associated with a specific pre-order. The process is asynchronous, meaning the API confirms receipt of the refund request, and the actual processing of the refund occurs in the background.

MethodoptionalPOST

The HTTP method used for this endpoint.

Endpoint URIoptionalstring

/pa-payment-services-public/v1/pre-order/refund/{pre_order_id}

Descriptionoptionalstring

Submits a request to refund a specified amount for a successful payment.

Path Parameters

pre_order_idrequiredstring

The unique identifier of the pre-order for which the refund is being requested.

Headers: See Common Headers

AuthorizationrequiredBearer Token

The JWT access_token for authenticating the API call.

Content-Typerequiredstring

Must be set to application/json.

Request Body

amountrequirednumber

The specific amount to be refunded. This can be a partial or full amount of the original transaction.

REQUEST

{
    "amount": 50.00
}

Response (202 Accepted)

A successful response indicates that the refund request has been accepted for processing.

keystring

A key indicating the status of the request (e.g., "request_received").

messagestring

A message confirming that the refund request has been received and is being processed.

action_idstring

A unique identifier for the refund action.

RESPONSE

{
    "key": "request_received",
    "message": "Refund request has been received and is being processed",
    "action_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}