Skip to main content
POST
Refund Payment

Headers

Abp-TenantId
string
required

Your unique Merchant ID assigned by CommercePay.

Authorization
string
required

Your API credentials used for authentication (typically a Bearer token).

cap-signature
string
required

A unique security hash used to verify the integrity of the request body. See Generate Signature for how to generate this.

Body

transactionNumber
string | null
required

Unique CAP Transaction Number

Maximum string length: 24
reason
string | null
required

A description for refund.

Example:

"Purchase wrong item"

timestamp
integer<int64>
required

new Date().getTime()

Example:

1621851652617

amount
integer<int32> | null

Please take note: The Amount parameter only accepts integer units. For example, 1000 is equivalent to 10.00 for the backend.Show all...

Example: 100

[Please pass the required amount if issuing a partial refund; ignore this attribute if issuing a full refund.]

Response

object | null

Success

tenantId
integer
transactionNumber
string
refundTransactionNumber
string
referenceCode
string
amount
integer
currencyCode
string
refundStatus
integer
responseMessage
string
paymentSessionNumber
string
refundPaymentList
object