Purchases via Direct Post

Request

When performing a Direct Post purchase the following parameters are required:

Name

Type

Description

card_holder

String

The credit card holders name

card_number

String

The credit card number

expiry_month

Number

The card expiry month, 1 or 2 digits (e.g. 5, 12, 06)

expiry_year

Number

The card expiry year, 4 digits (eg. 2023)

cvv

String

The CVV or Security Code on the back of the card - 3 digits
AMEX Note: this number is printed on the front of an AMEX and is 4 digits in length

In addition to these fields the following hidden fields should also be included:

Name

Type

Description

amount

Number

The purchase amount, as an integer (e.g. AU$100.50 will be 10050)

currency

String

The purchase currency (3-letter ISO-4217 Code)

return_path

String

The URL to redirect the customer to with the response.
This will normally be a URL on the merchants website but it can also be a custom-scheme registered for mobile applications.

reference

String

The purchase reference (e.g. invoice or order number)

verification

String

The verification value. Details on how to calculate this are below.

The URL for the Direct Post form should be:

  • Sandbox: https://gateway.pmnts-sandbox.io/v2/purchases/direct/[MERCHANT USERNAME].json
  • Live: https://gateway.pmnts.io/v2/purchases/direct/[MERCHANT USERNAME].json

Calculating the Verification Value

There are several hidden fields in this form which are submitted to the Gateway from the customers browser. These are:

  • reference - the purchase reference (e.g. invoice or order number)
  • amount - the purchase amount
  • currency - the currency for the transaction
  • return_path - the URL to return the customer to on completion

In order to ensure these values are not changed a verification value is also included, which is determined by the following:

verification = hmac_md5(shared_secret, "INV-21479:100000:AUD:https://merchantswebsite.com/payment/callback");

Response

Upon completion of the request the customer will be redirected back to the merchants website with a number of key/value pairs in the query string. These will be:

r=1&successful=true&amount=100000&currency=AUD&id=071-P-W2MZP0IJ&v=c41844a09c1a14f484e94d3458a13930&token=w5o87fzy&message=Approved&card_holder=Jim+Citizen&card_number=512345XXXXXX2346&card_expiry=03%2F2018&reference=INV-21479&s=-1

Name

Type

Description

r

Number

Response code indicating the outcome of the request - see the list below for details

successful

Boolean

Indication of success of the request, including the purchase being approved

message

String

The response message for the transaction

amount

Number

The amount processed, as an integer

id

String

The Fat Zebra transaction ID

token

String

The credit card token, for reuse later if required

card_holder

String

The card holders name

card_number

String

The masked card number - this can be stored if required

card_expiry

String

The card expiry date - this can be stored if required

reference

String

The Merchant's reference for the transaction

v

String

The verification value used to verify the response integrity - see below for details on verification

errors[]

Array

Any errors related to the request - this will be populated if the response code is 90-999 (e.g. errors[]=Invalid+Card+Number)

Response Codes

The following response codes are used for Direct Post transactions:

Code

Description

1

Successful Transaction

2

Declined Transaction

95

Merchant Username not found

96

Reference not unique - e.g. this transaction has already been processed

97

Validation error - there was an error validating the customers input (e.g. bad card number)

99

Invalid Verification - the verification was not successful indicating the data may have been tampered with

999

Gateway Error - contact support if this error persists

Response Verification

To verify the response hasn't been tampered with the merchants integration should perform the following verification calculation, and compare the result against the value of v:

hmac_md5(shared_secret, "[r]:[successful]:[amount]:[currency]:[id]:[token]")

If these values do not match the response should be considered invalid.

It is also important that a merchant's system be idempotent with handling responses, so that if a customer reloads the page they are redirected to the system will not treat each request as a new order.

Echo Parameters

In addition to the parameters mentioned above we now support echo parameters, which are values returned in the transaction.

To use these simply include them in your form using the following format for the field name echo[your_param_name] and they will be included in the response URI.

As with the extra parameters above, the echo parameters are not included in the verification calculation.

Original Transaction Details for Response Code 96

When a Reference not unique (96) error is returned we are now including the original transaction details which caused this error to be returned. This is helpful for handling double-post situations and removes the need to query the Fat Zebra API for the transaction details.

The transaction details returned include all the values listed above, however they are nested within the existing parameter. (For example: existing[id]=187-P-AJ8HY87K )

This response also includes verification of the response in existing[v] , so you may verify the authenticity of the original transaction before updating your records.