API Reference

Create a customer

POST/customers

Body Parameters

first_namestring

last_namestring

referencestring

email_addressstring(optional)

ip_addressstring(optional)

addressobject(optional)

address.addressstring

Street number and name

address.citystring

address.statestring

address.postcodestring

address.countrystring

cardobject(optional)

card.card_holderstring

card.card_numberstring(optional)

card.expiry_datestring(optional)

card.cvvstring(optional)

card_tokenstring(optional)

A card token can be sent through in lieu of the card data in the card array

bank_accountobject(optional)

The customer's bank account.

bank_account.account_namestring(optional)

Account name to be used for direct entry.

bank_account.account_numberstring(optional)

Bank account number. 6-9 digits for an Australian bank account, or 8-10 digits for a New Zealand bank account

bank_account.bsbstring(optional)

BSB number - this will be in the format of ###-### for an Australian bank account, or ###### for a New Zealand bank account

bank_account.account_typestring(optional)

"AU" or "NZ" for Australian or New Zealand bank account. Defaults to "AU" if not provided.

Request

curl

curl -u TEST:TEST https://gateway.pmnts-sandbox.io/v1.0/customers -d'  
{  
  "first_name": "Harrold",  
  "last_name": "Humphries",  
  "reference": "jsoie33789",  
  "email_address": "hhump@gmail.com",  
  "ip_address": "180.200.33.181",  
  "card": {  
  "card_holder": "Harrold Humphries Senior",  
  "card_number": "5123456789012346",  
  "expiry_date": "05/2023",  
  "cvv": "123"  
  },  
  "address": {  
  "address": "1 Harriet Road",  
  "city": "Kooliablin",  
  "state": "NSW",  
  "postcode": "2222",  
  "country": "Australia"  
  }  
}'

Response

201Result

json

{
  "successful":true,
  "response":{
  "id":"071-C-D1LXAHM7",
  "email":"hhump@gmail.com",
  "reference":"jsoie33789",
  "first_name":"Harrold",
  "last_name":"Humphries",
  "created_at":"2018-06-07T15:07:52+10:00",
  "address":{
    "address":"1 Harriet Road",
    "city":"Kooliablin",
    "state":"NSW",
    "postcode":"2222",
    "country":"Australia"
  },
  "card_token":"fke87c9q",
  "card_number":"512345XXXXXX2346",
  "bank_account":null,
  "metadata":null
  },
  "errors":[],
  "test":true
}