v1

latestOpenAPI 3.1.02026-07-2414085.2 KB

Create a purchase using a network token passthrough

post/purchases/

Headers

Content-Typestring

application/json

Request body

amountinteger required

A positive integer representing how much to charge, in the smallest currency unit (eg., 100 to charge $1.00, or 100 to Charge ¥100, a zero decimal currency)

referencestring required

Reference of the transaction. Max length 255 characters.

customer_ipstring required

RFC791-compliant IP address

currencystring required

Three letter ISO currency code, in UPPERCASE

card_numberstring required

DPAN or network scheme token

card_holderstring required

Name of the card holder

card_expirystring

The token expiry - format: MM/YYYY

cryptogramstring

Cryptogram value - 28 characters

network_ecistring

ECI value associated with network cryptogram (required for VTS on MPGS only)

testboolean

Indicates if this is a test transaction

metadataobject

addendum_datastring

captureboolean

Indicates if this purchase should be captured (true), or authorized only (false). Defaults to true

Response

200

successfulboolean

testboolean

Example response

{
  "successful": true,
  "response": {
    "authorization": "295229",
    "id": "071-P-HEJJINFO",
    "card_number": "555555XXXXXX5555",
    "card_holder": "Valued Cardholder",
    "card_expiry": "2027-02-28",
    "card_token": "qwer9876",
    "card_type": "MasterCard",
    "card_category": "Credit",
    "card_subcategory": "Standard",
    "amount": 110,
    "decimal_amount": 1.1,
    "successful": true,
    "message": "Approved",
    "reference": "fd792da68ea1b8a1ba791a0efc6f73b4",
    "currency": "USD",
    "transaction_id": "071-P-HEJJINFO",
    "settlement_date": "2018-07-06",
    "transaction_date": "2018-07-06T10:31:05+10:00",
    "response_code": "00",
    "captured": true,
    "captured_amount": 110,
    "rrn": "071PHEJJINFO",
    "cvv_match": "M"
  },
  "test": true
}