API Reference

Void a purchase

POST/purchases/void?id={id}

Query Parameters

idstring(optional)

ID of the purchase to be voided

Request

curl

curl https://gateway.pmnts-sandbox.io/v1.0/purchases/void\?id\=071-P-AK1MSTA2 -u TEST:TEST -X POST

Response

200Result

json

{
  "successful": true,
  "response": {
  "authorization": "283293",
  "id": "071-P-AK1MSTA2",
  "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": 10000,
  "decimal_amount": 100.0,
  "successful": true,
  "message": "Voided",
  "reference": "c10de1d9590fca1d893380c6e039ae71",
  "currency": "AUD",
  "transaction_id": "071-P-AK1MSTA2",
  "settlement_date": "2017-06-21",
  "transaction_date": "2017-06-21T15:02:46+10:00",
  "response_code": "00",
  "captured": true,
  "captured_amount": 10000,
  "rrn": "071PAK1MSTA2",
  "cvv_match": "M",
  "metadata": {},
  "addendum_data": {}
  },
  "errors": []
}

422Result

json

{
  "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": 10000,
  "decimal_amount": 100.0,
  "successful": false,
  "message": "Not Voided",
  "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": 10000,
  "rrn": "071P18DBFFCO",
  "cvv_match": "M",
  "metadata": {},
  "addendum_data": {}
  },
  "errors": []
}