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

GEThttps://uat.txshield.payshield.ai/api/v1/index.php/{ptxid}/getstatus

Path parameters

ptxid*string

Parent txid of the transaction

Query parameters

Response

200default

Lookup result

Body

application/json

tidstring

tid sent through with the transaction

txidinteger (int64)

Transaction id

parent_txidinteger (int64)

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

statusstring

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

tx_actionstring

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

amountnumber

The amount of the transaction

currencystring

The currency of the transaction

referencestring

Merchant reference

ref1string

your reference 1

ref2string

your reference 2

ref3string

your reference 3

ref4string

your reference 4

vrfystring

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

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://uat.txshield.payshield.ai/api/v1/index.php/{ptxid}/getstatus?hash=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

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

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

POSThttps://uat.txshield.payshield.ai/api/v1/index.php/{ptxid}/requery

Path parameters

ptxid*string

Parent txid of the transaction

Query parameters

Response

200default

Lookup result

Body

application/json

tidstring

tid sent through with the transaction

txidinteger (int64)

Transaction id

parent_txidinteger (int64)

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

statusstring

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

tx_actionstring

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

amountnumber

The amount of the transaction

currencystring

The currency of the transaction

referencestring

Merchant reference

ref1string

your reference 1

ref2string

your reference 2

ref3string

your reference 3

ref4string

your reference 4

vrfystring

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

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://uat.txshield.payshield.ai/api/v1/index.php/{ptxid}/requery?sid=0&rcode=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200default

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

request to continue transaction submission with auth

POSThttps://uat.txshield.payshield.ai/api/v1/index.php/{ptxid}/sendauth

Path parameters

ptxid*string

Parent txid of the transaction

Body

multipart/form-data

authtype*enum

The authentication method.

SMSPASSWORD

authvalue*string

The authentication value, either the SMS Code or Password.

miscdata*string

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

hash*string

md5(sid+rcode)

Response

200default

Lookup result

Body

application/json

tidstring

tid sent through with the transaction

txidinteger (int64)

Transaction id

parent_txidinteger (int64)

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

statusstring

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

tx_actionstring

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

amountnumber

The amount of the transaction

currencystring

The currency of the transaction

referencestring

Merchant reference

ref1string

your reference 1

ref2string

your reference 2

ref3string

your reference 3

ref4string

your reference 4

vrfystring

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

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://uat.txshield.payshield.ai/api/v1/index.php/{ptxid}/sendauth', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "authtype": "SMS",
      "authvalue": "text",
      "miscdata": "text",
      "hash": "text"
    }),
});
const data = await response.json();

Response

200default

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

request to resend the auth

GEThttps://uat.txshield.payshield.ai/api/v1/index.php/{ptxid}/resendauth

Path parameters

ptxid*string

Parent txid of the transaction

Query parameters

Response

200default

Lookup result

Body

application/json

tidstring

tid sent through with the transaction

txidinteger (int64)

Transaction id

parent_txidinteger (int64)

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

statusstring

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

tx_actionstring

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

amountnumber

The amount of the transaction

currencystring

The currency of the transaction

referencestring

Merchant reference

ref1string

your reference 1

ref2string

your reference 2

ref3string

your reference 3

ref4string

your reference 4

vrfystring

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

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://uat.txshield.payshield.ai/api/v1/index.php/{ptxid}/resendauth?hash=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

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

get access token

POSThttps://uat.txshield.payshield.ai/api/v2/index.php/gettoken

Body

application/json

username*string

Username

password*string

Password

Response

200default

Lookup result

Body

application/json

tidstring

tid sent through with the transaction

txidinteger (int64)

Transaction id

parent_txidinteger (int64)

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

statusstring

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

tx_actionstring

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

amountnumber

The amount of the transaction

currencystring

The currency of the transaction

referencestring

Merchant reference

ref1string

your reference 1

ref2string

your reference 2

ref3string

your reference 3

ref4string

your reference 4

vrfystring

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

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://uat.txshield.payshield.ai/api/v2/index.php/gettoken', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "username": "text",
      "password": "text"
    }),
});
const data = await response.json();

Response

200default

{
  "tid": "text",
  "txid": 0,
  "parent_txid": 0,
  "status": "text",
  "tx_action": "text",
  "amount": 0,
  "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.

POSThttps://uat.txshield.payshield.ai/api/v3/txprocess/transaction/{parentxid}/processrefund

Authorization

bearerAuth

Path parameters

parentxid*integer

Parent Transaction Id to get the tx_Action list

Body

application/x-www-form-urlencodedapplication/json

amountnumber

currencystring

Response

200401500

Successfully refunded response

Body

application/json

sidinteger

statusstring

parent_txidinteger

txidinteger

tx_actionstring

amountany of

Example: 0

stringnumber

currencystring

tidstring

ref1string

ref2string

ref3string

ref4string

commentstring

descriptorstring

pay_methodstring

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://uat.txshield.payshield.ai/api/v3/txprocess/transaction/{parentxid}/processrefund', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200401500

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