ACME Payments documentation is a draft & work in progress. Updates may be published periodically.
TABLE OF CONTENTS
Refunding a Payment
This API is used to refund a payment after the sale or capture has been completed.
This API depends on the Token API and the Charge Object
POST v1/payment/{mid}/refundRequest Parameters
The merchant id that the authorization
Request Body
Include a RefundRequest object as the body of the request.
Sample Request
POST https://sandX-api.acmeticketing.net/v1/payment/tx_123-456-789/refund
Response
Returns an RefundResponse object.
RefundRequest Object
| Name | Type | Description | Required |
|---|---|---|---|
| paymentId | string | The Payment Id that you are refunding | Required |
| charge | The charge object for the refund. The amount being refunded on the order is required. It cannot be more than is remaining on the order or token if one is provided | Required |
RefundResponse Object
| Name | Type | Description |
|---|---|---|
| paymentId | string | The id of the refund |
| charge | Charge Object | The charge object associated with the refund. The amount refunded will match the input amount as we will error if there is insufficient funds on the order to be refunded to this token otherwise. |
Sample Request Body
{
"paymentId" : "tx_123-456-789",
"charge": {
"amount" : 50.00,
"customerPresent" : false
}
}Sample Response Body
{
"paymentId" : "tx_7882ac7b-2e2a-45c2",
"charge": {
"amount" : 50.00,
"customerPresent" : false
}
}