Transaction - ptxid

Most of the following API's will require a PTXID(Parent Transaction ID) and are based around handling transactions once they have been created. For information on how to create a transaction via a REST call, see the SID Section

get

Get the latest status of the transaction

Path parameters

ptxidstringRequired

Parent txid of the transaction

Query parameters

hashstringRequired

md5 hash of sid and rcode(this is a new version)

Responses

200

Lookup result

application/json

tidstringOptional

tid sent through with the transaction

txidinteger · int64Optional

Transaction id

parent_txidinteger · int64Optional

Each Transaction has a unique id. The parent transaction is the transaction that groups all transaction together.

statusstringOptional

Has the value "OK" for a successful transaction, "EXC" for a failed transaction, "PEND" for a transaction in progress.

tx_actionstringOptional

The state change txaction, e.g. "PAYMENT", "REFUND"

amountnumberOptional

The amount of the transaction

currencystringOptional

The currency of the transaction

referencestringOptional

Merchant reference

ref1stringOptional

your reference 1

ref2stringOptional

your reference 2

ref3stringOptional

your reference 3

ref4stringOptional

your reference 4

vrfystringOptional

This is a sha256 hash so the data can be verified. Generate sha256 hash of the string of sid;rcode;txid;status;amount;currency;txaction

default

unexpected error

application/json

get/{ptxid}/getstatus

GET /api/v1/index.php/{ptxid}/getstatus?hash=text HTTP/1.1
Host: uat.txshield.payshield.ai
Accept: */*

{
  "tid": "text",
  "txid": 1,
  "parent_txid": 1,
  "status": "text",
  "tx_action": "text",
  "amount": 1,
  "currency": "text",
  "reference": "text",
  "ref1": "text",
  "ref2": "text",
  "ref3": "text",
  "ref4": "text",
  "vrfy": "text"
}

post

Requery the status of the transaction from gateway[Gateway dependant]

Path parameters

ptxidstringRequired

Parent txid of the transaction

Query parameters

sidintegerRequired

sid of site

rcodestringRequired

Rcode of the sid

referencestringOptional

Reference

postback_urlstringOptional

url to which a postback should be sent

Responses

200

Lookup result

application/json

tidstringOptional

tid sent through with the transaction

txidinteger · int64Optional

Transaction id

parent_txidinteger · int64Optional

Each Transaction has a unique id. The parent transaction is the transaction that groups all transaction together.

statusstringOptional

Has the value "OK" for a successful transaction, "EXC" for a failed transaction, "PEND" for a transaction in progress.

tx_actionstringOptional

The state change txaction, e.g. "PAYMENT", "REFUND"

amountnumberOptional

The amount of the transaction

currencystringOptional

The currency of the transaction

referencestringOptional

Merchant reference

ref1stringOptional

your reference 1

ref2stringOptional

your reference 2

ref3stringOptional

your reference 3

ref4stringOptional

your reference 4

vrfystringOptional

This is a sha256 hash so the data can be verified. Generate sha256 hash of the string of sid;rcode;txid;status;amount;currency;txaction

default

unexpected error

application/json

post/{ptxid}/requery

POST /api/v1/index.php/{ptxid}/requery?sid=1&rcode=text HTTP/1.1
Host: uat.txshield.payshield.ai
Accept: */*

{
  "tid": "text",
  "txid": 1,
  "parent_txid": 1,
  "status": "text",
  "tx_action": "text",
  "amount": 1,
  "currency": "text",
  "reference": "text",
  "ref1": "text",
  "ref2": "text",
  "ref3": "text",
  "ref4": "text",
  "vrfy": "text"
}

post

request to continue transaction submission with auth

Path parameters

ptxidstringRequired

Parent txid of the transaction

Body

authtypestring · enumRequired

The authentication method.

Possible values:

authvaluestringRequired

The authentication value, either the SMS Code or Password.

miscdatastringRequired

Additional data required for processing. eg) Name|Card Number

hashstringRequired

md5(sid+rcode)

Responses

200

Lookup result

application/json

tidstringOptional

tid sent through with the transaction

txidinteger · int64Optional

Transaction id

parent_txidinteger · int64Optional

Each Transaction has a unique id. The parent transaction is the transaction that groups all transaction together.

statusstringOptional

Has the value "OK" for a successful transaction, "EXC" for a failed transaction, "PEND" for a transaction in progress.

tx_actionstringOptional

The state change txaction, e.g. "PAYMENT", "REFUND"

amountnumberOptional

The amount of the transaction

currencystringOptional

The currency of the transaction

referencestringOptional

Merchant reference

ref1stringOptional

your reference 1

ref2stringOptional

your reference 2

ref3stringOptional

your reference 3

ref4stringOptional

your reference 4

vrfystringOptional

This is a sha256 hash so the data can be verified. Generate sha256 hash of the string of sid;rcode;txid;status;amount;currency;txaction

default

unexpected error

application/json

post/{ptxid}/sendauth

POST /api/v1/index.php/{ptxid}/sendauth HTTP/1.1
Host: uat.txshield.payshield.ai
Content-Type: multipart/form-data
Accept: */*
Content-Length: 69

{
  "authtype": "SMS",
  "authvalue": "text",
  "miscdata": "text",
  "hash": "text"
}

{
  "tid": "text",
  "txid": 1,
  "parent_txid": 1,
  "status": "text",
  "tx_action": "text",
  "amount": 1,
  "currency": "text",
  "reference": "text",
  "ref1": "text",
  "ref2": "text",
  "ref3": "text",
  "ref4": "text",
  "vrfy": "text"
}

get

request to resend the auth

Path parameters

ptxidstringRequired

Parent txid of the transaction

Query parameters

hashstringRequired

md5(sid+rcode)

Responses

200

Lookup result

application/json

tidstringOptional

tid sent through with the transaction

txidinteger · int64Optional

Transaction id

parent_txidinteger · int64Optional

Each Transaction has a unique id. The parent transaction is the transaction that groups all transaction together.

statusstringOptional

Has the value "OK" for a successful transaction, "EXC" for a failed transaction, "PEND" for a transaction in progress.

tx_actionstringOptional

The state change txaction, e.g. "PAYMENT", "REFUND"

amountnumberOptional

The amount of the transaction

currencystringOptional

The currency of the transaction

referencestringOptional

Merchant reference

ref1stringOptional

your reference 1

ref2stringOptional

your reference 2

ref3stringOptional

your reference 3

ref4stringOptional

your reference 4

vrfystringOptional

This is a sha256 hash so the data can be verified. Generate sha256 hash of the string of sid;rcode;txid;status;amount;currency;txaction

default

unexpected error

application/json

get/{ptxid}/resendauth

GET /api/v1/index.php/{ptxid}/resendauth?hash=text HTTP/1.1
Host: uat.txshield.payshield.ai
Accept: */*

{
  "tid": "text",
  "txid": 1,
  "parent_txid": 1,
  "status": "text",
  "tx_action": "text",
  "amount": 1,
  "currency": "text",
  "reference": "text",
  "ref1": "text",
  "ref2": "text",
  "ref3": "text",
  "ref4": "text",
  "vrfy": "text"
}

post

get access token

Body

usernamestringRequired

Username

passwordstringRequired

Password

Responses

200

Lookup result

application/json

tidstringOptional

tid sent through with the transaction

txidinteger · int64Optional

Transaction id

parent_txidinteger · int64Optional

Each Transaction has a unique id. The parent transaction is the transaction that groups all transaction together.

statusstringOptional

Has the value "OK" for a successful transaction, "EXC" for a failed transaction, "PEND" for a transaction in progress.

tx_actionstringOptional

The state change txaction, e.g. "PAYMENT", "REFUND"

amountnumberOptional

The amount of the transaction

currencystringOptional

The currency of the transaction

referencestringOptional

Merchant reference

ref1stringOptional

your reference 1

ref2stringOptional

your reference 2

ref3stringOptional

your reference 3

ref4stringOptional

your reference 4

vrfystringOptional

This is a sha256 hash so the data can be verified. Generate sha256 hash of the string of sid;rcode;txid;status;amount;currency;txaction

default

unexpected error

application/json

post/gettoken

POST /api/v2/index.php/gettoken HTTP/1.1
Host: uat.txshield.payshield.ai
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "username": "text",
  "password": "text"
}

{
  "tid": "text",
  "txid": 1,
  "parent_txid": 1,
  "status": "text",
  "tx_action": "text",
  "amount": 1,
  "currency": "text",
  "reference": "text",
  "ref1": "text",
  "ref2": "text",
  "ref3": "text",
  "ref4": "text",
  "vrfy": "text"
}

processrefund

processrefund uses your Bearer token for Authentication and takes in JSON data. If the transaction is still a PREAUTH that hasn't been settled, the transaction will be VOID instead. It should be noted that you can't do a partial VOID, a VOID is for the full transaction amount. You can however do a partial refund.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

parentxidintegerRequired

Parent Transaction Id to get the tx_Action list

Body

amountnumberOptional

currencystringOptional

Responses

200

Successfully refunded response

application/json

sidintegerOptional

statusstringOptional

parent_txidintegerOptional

txidintegerOptional

tx_actionstringOptional

amountany ofOptionalExample: 0

stringOptional

or

numberOptional

currencystringOptional

tidstringOptional

ref1stringOptional

ref2stringOptional

ref3stringOptional

ref4stringOptional

commentstringOptional

descriptorstringOptional

pay_methodstringOptional

401

Unauthorized

application/json

500

Error

application/json

post/txprocess/transaction/{parentxid}/processrefund

POST /api/v3/txprocess/transaction/{parentxid}/processrefund HTTP/1.1
Host: uat.txshield.payshield.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 30

"amount=1&currency='text'"

{
  "sid": 1,
  "status": "text",
  "parent_txid": 1,
  "txid": 1,
  "tx_action": "text",
  "amount": 0,
  "currency": "text",
  "tid": "text",
  "ref1": "text",
  "ref2": "text",
  "ref3": "text",
  "ref4": "text",
  "comment": "text",
  "descriptor": "text",
  "pay_method": "text"
}