Skip to main content
POST
Create Refund for a Payment

Headers

ApiKey
string
required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantId
string
required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment
enum<string>
required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Available options:
live,
sandbox

Path Parameters

id
string
required

Body

application/json
amount
number
required

The amount to refund

Example:

100

reasonCode
string
required

The reason for the refund

Example:

"customer_request"

reasonDetails
string
required

The details of the reason for the refund

Example:

"Customer requested a refund"

Response

id
number
required

The payment refund record id

Example:

2