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 the latest status of the transaction

get

/{ptxid}/getstatus

Path parameters

ptxidstringrequired

Parent txid of the transaction

Query parameters

hashstringrequired

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://uat.txshield.payshield.ai/api/v1/index.php/{ptxid}/getstatus?hash=text'

200

default

200

{
  "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"
}

Lookup result

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

post

/{ptxid}/requery

Path parameters

ptxidstringrequired

Parent txid of the transaction

Query parameters

sidintegerrequired

sid of site

rcodestringrequired

Rcode of the sid

referencestring

Reference

postback_urlstring

url to which a postback should be sent

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://uat.txshield.payshield.ai/api/v1/index.php/{ptxid}/requery?sid=1&rcode=text'

200

default

200

{
  "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"
}

Lookup result

request to continue transaction submission with auth

post

/{ptxid}/sendauth

Path parameters

ptxidstringrequired

Parent txid of the transaction

Body

authtypestring · enumrequired

The authentication method.

Options: SMS, PASSWORD

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

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://uat.txshield.payshield.ai/api/v1/index.php/{ptxid}/sendauth' \
  --header 'Content-Type: multipart/form-data' \
  --form 'authtype=SMS' \
  --form 'authvalue=text' \
  --form 'miscdata=text' \
  --form 'hash=text'

200

default

200

{
  "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"
}

Lookup result

request to resend the auth

get

/{ptxid}/resendauth

Path parameters

ptxidstringrequired

Parent txid of the transaction

Query parameters

hashstringrequired

md5(sid+rcode)

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://uat.txshield.payshield.ai/api/v1/index.php/{ptxid}/resendauth?hash=text'

200

default

200

{
  "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"
}

Lookup result

get access token

post

/gettoken

Body

usernamestringrequired

Username

passwordstringrequired

Password

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://uat.txshield.payshield.ai/api/v2/index.php/gettoken' \
  --header 'Content-Type: application/json' \
  --data '{
    "username": "text",
    "password": "text"
  }'

200

default

200

{
  "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"
}

Lookup result

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

/txprocess/transaction/{parentxid}/processrefund

Authorizations

Path parameters

parentxidintegerrequired

Parent Transaction Id to get the tx_Action list

Body

application/x-www-form-urlencodedapplication/json

amountnumber

currencystring

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://uat.txshield.payshield.ai/api/v3/txprocess/transaction/{parentxid}/processrefund' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'amount=1&currency=text'

200

401

500

200

{
  "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"
}

Successfully refunded response