Planned for development. Updates may be published periodically.
TABLE OF CONTENTS
- Capture of an Authorization
- CaptureRequest Object
- CaptureResponse Object
- Sample Request Body
- Sample Response Body
Capture of an Authorization
This API is used to complete the payment after an authorization has been completed.
This API depends on the Authorization API and the Charge Object.
POST v1/payment/{mid}/captureRequest Parameters
The merchant id of the seller performing the capture.
Request Body
Include a CaptureRequest object as the body of the request.
Sample Request
POST https://sand10-api.acmeticketing.net/v1/payment/987-654-321/capture
Response
Returns an CaptureResponse object.
CaptureRequest Object
| Name | Type | Description | Required |
|---|---|---|---|
| authorizationId | string | ACME’s authorization id, corresponding to the AuthorizationResponse. | Required |
| charge | Charge | The charge object must contain the amount. The amount must be less than or equal to the authorized amount. | Required |
CaptureResponse 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
{
"authorizationId": "abc-123",
"charge": {
"amount" : 5000,
"customerPresent" : false
}
}Sample Response Body
{
"orderId" : 123456
}