Refund a payment

post

https://sandbox.comcarde.com/v1/payments/{paymentId}/refund

Initiates a new refund against a previously captured payment

Path Params

paymentId

string

required

The unique identifier for the payment.

This can be sourced from the paymentId field in the response we sent to you when creating the payment or payout.

Body Params

Details of the refund to be initiated.

amount

int64

1 to 999999999999999

Amount to be refunded on this transaction, or null for full refund. In the lowest denomination of the currency of the payment. This means that 1234 in GBP represents £12.34.

merchantTransactionId

string

length between 1 and 50

Your unique identifier that can be used when a connection issue occurs and you don't receive a paymentId. This is an optional field that can be used when querying GET v1/payments, GET v1/payouts or GET v1/payments/{paymentId}/refunds. We will validate the uniqueness of the merchantTransactionId value per retail channel. If a payment/payout/refund is created with merchantTransactionId abc, no other payment/payout/refund can be created with abc.

The merchantTransactionId is a contract between BR-DGE and a merchant. This field will not be mapped downstream to any PSP.

In the event that you provide a merchantTransactionId in the second (or third) leg of a 3DS payment, we will ignore this value and will only use the value provided in the initial request.

customerRefundCode

string

length ≤ 255

You may provide your own code to be used in refunds, which will be provided to the PSP if it is supported. Each PSP may have different validation requirements for this code.

Responses

401

Unauthorized request.

Callback

201Refund request completed successfully.

202Pending

409Indicates a request conflict.