Rest API - singletx

post

https://uat.txshield.payshield.ai/api/v1/index.php/{sid}/singletx

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Rest implementation of TxHandler allows you to send single transaction in xml, json or form url encoded format. It is not useful for any payment method that requires user interaction. Click REST API to see the rest api endpoints that are available.

Path Params

sid

string

required

Site ID. Provided by txShield.

Form Data

hash

string

required

md5 hash of sid+timestamp+amounttotal+currency+rcode e.g. md5('22'.'1234568995265421'.'17.00'.'USD'.'222b6c')

timestamp

string

required

timestamp value used in the hash e.g. 1234568995265421

tid

string

Merchant reference

card_type

string

required

Which paymethod to use. Look at the "getPaymentOptions" API call to see what paymethods are available and what payment fields need completeting.

card_no

string

The card number

card_ccv

string

The card 3/4 digit verification code

card_exp_month

string

2 digit for the month. Please have leading zeroes e.g. 05

card_exp_year

string

4 digit year i.e. 2016

card_name

string

The name printed on the card

firstname

string

required

First name of the customer.

lastname

string

required

Last name of the customer.

string

required

Email of the customer.

phone

string

Phone of the customer. Please not most payment providers require this.

address

string

Billing street address

suburb_city

string

Billing suburb or city

state

string

Billing state, 2 letter code for US/Canada. Australia should use 2/3 letter codes.

country

string

Billing country, ISO 3166 2 digit code.

postcode

string

Billing postcode/zipcode.

shipping_address

string

Shipping street address

shipping_suburb_city

string

Shipping suburb or city

shipping_state

string

Shipping state, 2 letter code for US/Canada. Australia should use 2/3 letter codes.

shipping_country

string

Shipping country, ISO 3166 2 digit code.

shipping_postcode

string

Shipping postcode/zipcode.

item_quantity

array of strings

required

The Cart quantities for each line item

item_quantity*

item_name

object

item_description

object

item_amount_unit

object

amount_shipping

double

The Cart shipping amount

amount_coupon

double

The Cart discount amount

amount_tax

double

The Cart tax amount

currency

string

required

Transaction currency, ISO 3 letter code

tx_action

string

Transaction action eg, PAYMENT, PREAUTH

postback_url

string

The URL of the page to recieve the postback.

Responses

200200

201201

400400