FAfatzebra

Capture an authorization

Changed on

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

Request

  • Base URL
    https://gateway.pmnts-sandbox.io/v1.0
  • URL
    https://gateway.pmnts-sandbox.io/v1.0/purchases/{id}/capture
  • Auth
    HTTP basic

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

successfulboolean

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"
  }
}

Changes

  • a62ddbae3800Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the new optional request property

    • info

      removed subschema #1 subschema #2 from the response body oneOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status