Refund Transaction

To make refund you can use Refund request. Use payment public ID from Payment Platform in the request.

API Endpoint

Request URL:      {{CHECKOUT_HOST}}/api/v1/payment/refund
Request Method:   POST
Request Body:     JSON

{{CHECKOUT_HOST}}

Request Parameters

Parameter	Type	Mandatory, Limitations	Description
merchant_key	String	Required	Key for Merchant identification Example: xxxxx-xxxxx-xxxxx
payment_id	String	Required Up to 255 characters	Transaction ID (public) Example: dc66cdd8-d702-11ea-9a2f-0242c0a87002
amount	String	Optional Format: XX.XX, without leading zeroes	Amount to refund. It is required for particular refund. If amount is not specified the full order amount is settled by default. Example: 0.19
hash	String	Required	Special signature to validate your request to Payment Platform. For details, click here

Response Parameters

Parameter	Type	Mandatory, Limitations	Description
payment_id	String	Required Up to 255 characters	Transaction ID (public) Example: dc66cdd8-d702-11ea-9a2f-0242c0a87002
result	String	Required	Refund request result Example: accepted

Examples

Request

curl --location -g --request POST '{{CHECKOUT_HOST}}/api/v1/payment/refund' \
--data-raw \
'{  
   "merchant_key": "xxxxx-xxxxx-xxxxx",
   "payment_id": "63c781cc-de3d-11eb-a1f1-0242ac130006",
   "amount": "0.10",
   "hash": "{{operation_hash}}"
}'

Response - Refund request accepted

Body

{
  "payment_id": "63c781cc-de3d-11eb-a1f1-0242ac130006",
  "result": "accepted"
}