LogoLogo
PayShield - Transaction Processing / TxProcess
PayShield - Transaction Processing / TxProcess
  • Overview
  • Transaction Details
    • Transaction Types
    • Payment Methods
    • Transaction Lifecyle / Workflow
  • Integrations & API's
    • Single Transaction API (TxHandler)
    • REST API
      • Site - SID - Payments
      • Transaction - ptxid
      • Merchant Management
      • Fraud Check
      • Payment Refund
    • Field Definitions
    • Responses
    • Testing Data
  • Emulators
    • NMI - API
Powered by GitBook
On this page
  1. Integrations & API's
  2. REST API

Transaction - ptxid

PreviousSite - SID - PaymentsNextMerchant Management

Last updated 5 months ago

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

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.

SID Section
post

get access token

Body
usernamestringRequired

Username

passwordstringRequired

Password

Responses
200
Lookup result
application/json
default
unexpected error
application/json
post
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"
}
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
default
unexpected error
application/json
get
GET /api/v1/index.php/{ptxid}/getstatus 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
default
unexpected error
application/json
post
POST /api/v1/index.php/{ptxid}/requery 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"
}
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
default
unexpected error
application/json
get
GET /api/v1/index.php/{ptxid}/resendauth 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
default
unexpected error
application/json
post
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/{ptxid}/getstatus
  • POST/{ptxid}/requery
  • POST/{ptxid}/sendauth
  • GET/{ptxid}/resendauth
  • POST/gettoken
  • POST/txprocess/transaction/{parentxid}/processrefund
post
Authorizations
Path parameters
parentxidintegerRequired

Parent Transaction Id to get the tx_Action list

Body
amountnumberOptional
currencystringOptional
Responses
200
Successfully refunded response
application/json
401
Unauthorized
application/json
500
Error
application/json
post
POST /api/v3/txprocess/transaction/{parentxid}/processrefund HTTP/1.1
Host: uat.txshield.payshield.ai
Authorization: Bearer JWT
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"
}