Status

This endpoint returns the information about an order.

POST - Sandbox

https://sandbox.paypaygateway.com/fn-execute/payment/status

POST - Production

https://api.paypaygateway.com/fn-execute/payment/status

Header Parameters

Parameter	Description	Type	R/O
Authorization	Authorization header containing your Secret Key	string	R
mid	mid header containing your merchant ID	string	O

Body Parameters

You can query an order by either its transactionId or the referenceNo you supplied when creating it. At least one of the two is required. If both are provided, transactionId takes precedence.

Parameter	Description	Type	R/O
transactionId	Transaction ID	string	O*
referenceNo	The reference number you sent when creating the order	string	O*

* One of transactionId or referenceNo must be provided.

// By transaction ID
{
  "transactionId": "10025261";
}

// By reference number
{
  "referenceNo": "order-4821";
}

Responses

200

{
  "status": "successful",
  "code": "2004",
  "messagetype": "transaction",
  "message": {
      "transactionId": "10025261"
      "status": "SUCCESS",
      "date": "2023-07-18T11:21:41",
      "amount": 1171,
      "currency": "USD",
      "message": "ok"
  }
}

Parameter	Description	Type
status	Response status	string
code	Response code	string
messagetype	Response message type	string
transactionId	Transaction ID	string
status	Transaction status	string
date	Date of transaction	string
amount	Amount to charge, in the minor unit of your selected currency. All currencies are standardized to 100 units. For example, an amount of 100 in EUR is equal to 1€	number
currency	Code of the currency	string
message	Transaction message	string

400

{
  "status": "failure",
  "code": "1019",
  "messagetype": "transaction",
  "message": {
    "error": "Transaction id is required"
  }
}

Parameter	Description	Type
status	Response status	string
code	Response code	string
messagetype	Response message type	string
error	Message error	string

400

{
  "status": "failure",
  "code": "1012",
  "messagetype": "transaction",
  "message": {
    "error": "Transaction not found"
  }
}

Parameter	Description	Type
status	Response status	string
code	Response code	string
messagetype	Response message type	string
error	Message error	string