ACME Payments documentation is a draft & work in progress. Updates may be published periodically.
TABLE OF CONTENTS
- Sale Payment
- Charge Object
- SaleRequest Object
- SaleResponse Object
- Sample Request Body
- Sample Response Body
Sale Payment
This API is used in order to charge a customer for a set amount.
This API depends on having a Token and a Charge object.
Once you have a token, you can use the sale API to charge the customer. After completing the sale you can use the Refund API in order to cancel the transaction.
POST v2/payment/{mid}/saleRequest Parameters
The merchant id of the seller performing the sale.
Request Body
Include a SaleRequest object as the body of the request.
Sample Request
POST https://sandX-api.acmeticketing.net/v2/payment/987-654-321/sale
Response
Returns a SaleResponse object.
SaleRequest Object
| Name | Type | Description | Required |
|---|---|---|---|
| token | string | Either a single use or a multi use token | Required |
| charge | Charge object (see below) | The charge object for this sale. The amount is required | Required |
Charge Object
| Name | Type | Description | Required |
|---|---|---|---|
| amount | number | The amount of money the sale or refund is for. | Required |
| customerPresent | boolean | True if the customer is part of the checkout flow during this payment, false otherwise. | Optional, true is default. |
SaleResponse Object
| Name | Type | Description |
|---|---|---|
| orderId | number | The order to which the charge is being applied. |
| paymentId | string | Unique identifier for this payment |
Sample Request Body
{
"token" : "123-456-789",
"charge": {
"amount" : 50.00,
"customerPresent" : false
}
}Sample Response Body
Successful Payment
{
"paymentId": "tx_123-abc-456",
"orderId" : 123456
}