Release an authorization

Changed on

Void an authorization partially or completely

delete/purchases/{id}

Request

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

Path parameters

idstring required

id of the purchase

Headers

Content-Typestring

application/json

Request body

amountinteger

The new amount for the authorisation (where the amount is being increased from the original authorized value). If this field is not provided, the original amount will be used.

metadatastring
extendboolean

Indicates if an authorization extension should be processed

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": 10100,
    "decimal_amount": 101,
    "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",
    "rrn": "071P18DBFFCO",
    "cvv_match": "M"
  }
}

Changes