Capturing an Authorization (Card Present)

Modified on Thu, 22 Feb at 5:06 PM

Capture

This API endpoint is called in order to complete a transaction that was initiated with an EMV device using triPOS by Worldpay.

You will need your MerchantID {mid} and PaymentKey {x-acme-payment-key} to complete the authorization, if you do not have these, please contact your ACME account manager.

This API takes an existing authorization, typically generated via the triPOS library and an EMV device, and captures (completes the authorization).

POST v1/payment/{mid}/cp/capture/{authorizationId}

Request Parameters

The merchantId {mid} and the {authorizationId},

Request Body

Include a CaptureRequest object as the body of the request.

Sample Request

POST https://sandX-api.acmepayments.net/v1/12345/cp/capture/98765

Sample Request Body

{
  "externalId" : "ABC123",
 "externalTransactionId" : 13579
}

Response
Returns a SaleResponse object.

Sample Response Body

Successful Authorization Response

Token generation is optional, token maintenance and lifecycle are documented here: https://developers.acmepayments.com/a/solutions/articles/33000262269?portalId=33000066026

{
   "saleId" : "sale_34de74b9-e409-4931-8a49-9982f986bd3a",
   "externalId" : "ABC123",
   "token": "9c2bce81-bf56-4ec6-ae76-5e9a476c181c"
}

Failed Capture Transaction

Failed responses vary depending on which trusted party issues a failure. ACME may or may not pass back the code depending on the type of failure encountered. We perform best effort attempts to pass back relevant issuing bank or processor errors.

{
   "message": "Authorization previously completed",
   "errorCode": 10026,
   "type": "AUTHORIZATION_ALREADY_COMPLETED",
   "requestId": "6e360f6a-5d31-11ec-9ceb-064a412857e4"
}

CaptureRequest Object

Name	Type	Description	Required
externalId	string	A value provided by the caller that can be used to lookup this transaction.	Optional
externalTransactionId	number	A numeric value provided by the caller that can be used to lookup this transaction. Must be unique to this capture.	Optional
generateToken	boolean	Default: False Set to True if you desire a Multi Use Token for future transactions against this card	Optional

SaleResponse Object

Name	Type	Description
saleId	string	Unique identifier for this transaction
card	Card Object ›	Not used for this call.
externalId	string	Plain text value provided for this sale.
token	string	Multi Use Token that can be used for future transactions.