Refund Payment

post https://api.exactpaysandbox.com/payments/{payment_id}/refund

Process a refund against the specified payment.

Path Params

payment_id

string

required

The id of the payment being acted on.

Body Params

amount

int32

required

0 to 999999999

Amount in smallest currency unit, eg: cents, including all surcharges, taxes etc.

fee_amount

int32

0 to 999999999

This is assumed to already be included in the amount.

surcharge_amount

int32

0 to 999999999

This is assumed to already be included in the amount. (Available for Elavon processing only)

authorization

string

required

The authorization value for the payment you are operating on.

terminal

object

required

Which terminal to process the transaction through. Terminal determines currency and language.

reference

object

Merchant defined values which can be used to internally identify the transaction.

soft_descriptor

object

Override business information which would normally appear on a customer's statement, making it easier for customers to identify transactions.

options

object

Responses

Language

Credentials

Basic

base64

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.exactpaysandbox.com/payments/payment_id/refund \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Payment was created.

400Bad Request When there are errors in the payload

403Access Denied Credentials supplied do not grant access to the requested resource.

defaultUnspecified error.