Skip to main content
POST

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

To test this endpoint you need to make an SALE request first

subMerchantId
string
required

Unique identifier of the submerchant.

transactionId
string
required

Identifier of the settled transaction to refund.

amount
number
required

The amount to refund.

description
string

Free-text description.

referenceId
string

Your own reference for this transaction. Returned in responses and query results for reconciliation.

taxAmountRelease
number

Withheld tax amount to release with this refund.

taxWithHoldRelease
boolean

When true, releases the tax withheld on the original transaction.

metadata
object

metadata is an object that can host as much as 50 key-value pairs, where the keys can be at most 40 char length and can’t include the characters “[“ or “]”, and the values must be strings and cannot exceed 500 chars Learn more about metadata

Response

200 - application/json

Successful refund

data
object

The response payload.

success
boolean

Whether the request was processed successfully. Declines return HTTP 200 with success: false.

message
string

Human-readable result message.

code
string

Machine-readable result code. See the Error Codes reference.

Last modified on July 14, 2026