Sign in

v1

latestOpenAPI 3.1.02026-07-2414085.2 KB

Capture an authorization

Please note, If the outer successful field is false, it means the capture was rejected at the gateway level and the errors array needs to be looked at to confirm why it failed.

post/purchases/{id}/capture

Path parameters

idstring required

id of the purchase

Headers

Content-Typestring

application/json

Request body

amountinteger required

Amount of the purchase in the smallest unit of for the currency.

metadataobject
addendum_dataobject

Response

200

OR

Example response

{
  "successful": true,
  "response": {
    "authorization": "283293",
    "id": "071-P-18DBFFCO",
    "card_number": "512345XXXXXX2346",
    "card_holder": "Jim Smith",
    "card_expiry": "2023-05-01",
    "card_token": "fke86c5u",
    "card_type": "MasterCard",
    "card_category": "Credit",
    "card_subcategory": "Standard",
    "amount": 1000,
    "decimal_amount": 10,
    "successful": true,
    "message": "Approved",
    "reference": "c10de1d9590fca1d893380c6e039ae71",
    "currency": "AUD",
    "transaction_id": "071-P-18DBFFCO",
    "settlement_date": "2017-06-21",
    "transaction_date": "2017-06-21T15:02:46+10:00",
    "response_code": "00",
    "captured": true,
    "captured_amount": 1000,
    "rrn": "071P18DBFFCO",
    "cvv_match": "M"
  }
}