API Reference

Create a purchase

POST/purchases

Body Parameters

amountinteger (int32)

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

Reference of the transaction. Max length 255 characters.

customer_ipstring

RFC791-compliant IP address

currencystring· Defaults to AUD

Three letter ISO currency code, in UPPERCASE

card_numberstring

Card number

card_holderstring

Name of the card holder

card_expirystring

Format: MM/YYYY

card_tokenstring(optional)

cvvstring(optional)

CVV card number. (3/4 characters)

metadataobject(optional)

addendum_datastring(optional)

fraudobject(optional)

fraud.device_idstring

The fraud screening service device fingerprint ID. See the Device ID section below for further details

fraud.deviceobject

fraud.device.uidstring

The device identifier such as IMEI in android or identifier for vendor in iOS. Maximum length is 128 characters.

fraud.device.os_typestring(optional)

The operating system running on the user's device (relevant for native app only). For example: android, ios, etc

fraud.device.app_versionstring(optional)

The version of the merchant application which is running on the user's device. Maximum length is 50 characters. For example: '2.0.1'

fraud.device.brandstring(optional)

The user's device brand (relevant for native app only). For example: htc, apple, etc

fraud.device.modelstring(optional)

The model of the user's device (relevant for native app only) Maximum length is 50 characters. For example: 'iPhone X', 'Galaxy 3'.

fraud.customerobject

Details about the customer

fraud.customer.first_namestring

The customer's first name

fraud.customer.last_namestring

The customer's last name

fraud.customer.emailstring

The customer's email address

fraud.customer.date_of_birthstring (date)(optional)

The customer's date of birth, if available

fraud.customer.idstring(optional)

The customer record ID in the merchant database, if available

fraud.customer.address_1string

The customer's primary address line

fraud.customer.address_2string(optional)

The customer's secondary address line (such as building name)

fraud.customer.citystring

The customer's city

fraud.customer.statestring

The customer's state

fraud.customer.post_codestring

The customer's post code

fraud.customer.countrystring

The ISO 8166 alpha-3 country code for the customer

fraud.customer.existing_customerboolean(optional)

Indicates if this customer is already in the merchants records or not

fraud.customer.created_atstring (date)(optional)

The date/time that the customer record was created

fraud.customer.home_phonestring(optional)

The customer's primary phone number. This can be a mobile number, if a home phone number is not provided. Required field for Forter.

fraud.shipping_addressobject(optional)

fraud.shipping_address.first_namestring

The shipping address first name

fraud.shipping_address.last_namestring

The shipping address last name

fraud.shipping_address.emailstring

The shipping address email

fraud.shipping_address.home_phonestring

The shipping address phone number

fraud.shipping_address.address_1string

The shipping address primary address line

fraud.shipping_address.address_2string(optional)

The shipping address secondary address line (such as building name)

fraud.shipping_address.citystring

The shipping address city or suburb

fraud.shipping_address.statestring

The shipping address state

fraud.shipping_address.post_codestring

The shipping address post code

fraud.shipping_address.countrystring

The ISO 3166 alpha-3 country code for the shipping address

fraud.shipping_address.shipping_methodstring

One of the following shipping options: low_cost, same_day, overnight, express, international, pickup, other If none of these options apply choose the closest match.

fraud.recipientsarray of objects

Recipients are only required if the recipient differs from the shipping address, or if the order is being multi-shipped

fraud.recipients[0].titlestring

The recipient title/salutation (e.g. Mr, Mrs, Dr)

fraud.recipients[0].first_namestring

The recipients first name

fraud.recipients[0].last_namestring

The recipients last name

fraud.recipients[0].emailstring

The recipients email address

fraud.recipients[0].address_1string

The recipients primary address line

fraud.recipients[0].address_2string(optional)

The recipients secondary address line (such as building name)

fraud.recipients[0].citystring

The recipients city or suburb

fraud.recipients[0].statestring

The recipients state

fraud.recipients[0].post_codestring

The recipients post code

fraud.recipients[0].countrystring

The recipients country code - ISO 3166 alpha-3

fraud.recipients[0].phone_numberstring(optional)

The recipients phone number

fraud.itemsarray of objects

fraud.items[0].product_codestring

The product code (base level product code)

fraud.items[0].skustring(optional)

The product SKU (the stock keeping unit code, for example size/color variants)

fraud.items[0].descriptionstring

The description of the product. For longer descriptions (greater then 26 chars) truncate item specifics and add the truncated information to the gift_message field

fraud.items[0].qtyinteger (int32)

The quantity of items ordered

fraud.items[0].costnumber (double)

The base-cost for the product

fraud.items[0].line_totalnumber (double)

The line total for the product (cost times quantity)

fraud.items[0].tracking_numberstring(optional)

The shipping tracking number for this item

fraud.items[0].gift_messagestring(optional)

Addendum product description, or gift message

fraud.items[0].part_numberstring(optional)

The manufacturers part number (if applicable)

fraud.items[0].shipping_commentsstring(optional)

Any comments for shipping of the item

fraud.customobject(optional)

fraud.custom.xstring(optional)

Custom data for the fraud screening. This is usually agreed upon and configured with the fraud provider. Please discuss using these fields with Support should you require assistance. x may be numerical or a string.

fraud.websitestring

The URL for the website where the order is being placed.

Request

curl

curl https://gateway.pmnts-sandbox.io/v1.0/purchases -u TEST:TEST -d' 
  { 
  "card_holder": "Jim Smith", 
  "card_number": "5123456789012346", 
  "card_expiry": "05/2023", 
  "cvv": "987", 
  "amount": 1000, 
  "reference": "fd792da68ea1b8a1ba791zzzfc6f73b4", 
  "customer_ip": "111.222.111.123", 
  "currency": "USD", 
  "fraud": { 
    "device_id": "04003h...truncated...y16eGlPDmAXrXEYZfU=",
    "device": {
      "uid": "625400941054585",
      "os_type": "android",
      "app_version": "2.1",
      "brand": "Samsung",
      "model": "Galaxy 3"
    },
    "customer": { 
      "address_1": "23 Smith Road", 
      "city": "Canberra", 
      "country": "AUS", 
      "created_at": "2014-05-28T21:38:51+11:00", 
      "date_of_birth": "1994-05-28", 
      "email": "deny@email.com", 
      "existing_customer": true, 
      "first_name": "James", 
      "home_phone": "0421858999", 
      "id": "ABD123", 
      "last_name": "Smith", 
      "post_code": "2600" 
    }, 
    "items": [ 
      { 
        "cost": 23.3, 
        "description": "Widgets", 
        "line_total": 23.3, 
        "product_code": "9999-A", 
        "qty": 1, 
        "sku": "9999" 
      } 
    ], 
    "recipients": [
      {
        "address_1": "1 Fairfield Road",
        "city": "Austin",
        "country": "USA",
        "email": "james@smith.com",
        "first_name": "James",
        "last_name": "Smith",
        "phone_number": "555-555-55555",
        "post_code": "55555-1234",
        "state": "TX"
      }
    ],
    "shipping_address": {
      "first_name": "James",
      "last_name": "Smith",
      "email": "deny@email.com",
      "home_phone": "0421858999",
      "address_1": "23 Smith Road",
      "city": "Canberra",
      "country": "AUS",
      "state": "NSW",
      "post_code": "2600",
      "shipping_method": "express"
    }, 
    "custom": { 
      "3": "Facebook" 
    }, 
    "website": "http://www.website.com" 
  } 
  }'

Response

200Fraud Declined

json

{
  "successful": true,
  "response": {
  "authorization": "0",
  "id": "071-P-RHN5DC15",
  "card_number": "512345XXXXXX2346",
  "card_holder": "Jim Smith",
  "card_expiry": "2023-05-31",
  "card_token": "pfjeiyx4fk0uko3ev4kd",
  "card_type": "MasterCard",
  "card_category": "Credit",
  "card_subcategory": "Standard",
  "amount": 1000,
  "decimal_amount": 10.0,
  "successful": false,
  "message": "Declined.",
  "reference": "Ud5CfaAlwTKJi2kfsAesdAwvIk2fpJjP",
  "currency": "USD",
  "transaction_id": "071-P-RHN5DC15",
  "settlement_date": null,
  "transaction_date": "2018-10-09T14:01:06+11:00",
  "response_code": "01",
  "captured": false,
  "captured_amount": null,
  "rrn": "0",
  "cvv_match": "U",
  "metadata": {},
  "addendum_data": {},
  "fraud_result": "Deny",
  "fraud_messages": [
    "An attribute associated with an Order matched a pre-configured 'Always Deny' rule."
  ]
  },
  "errors": [],
  "test": true
}