PrimeXPay API Documentation

Endpoint: Check PayIn Status

URL: https://primexpay.in/api/merchant/check-payin-status

Method: POST

Content-Type: application/json

Request Body

Required JSON fields (any one of txnId or custRefNo):

  • authEmail (string) - Merchant Email
  • apiKey (string) - Merchant API Key
  • txnId (string) - Transaction ID
  • custRefNo (string) - Customer Reference Number

Example Request:

{
  "authEmail": "auth@merchant.com",
  "apiKey": "YourAPIKey",
  "txnId": "TXN1234567890"
}

Success Response

{
  "success": true,
  "message": "Transaction found.",
  "txnId": "TXN1234567890",
  "custRefNo": "REF11223344",
  "status": "success",
  "amount": "100.00",
  "netAmount": "98.00",
  "utr": "123456789UTR",
  "failureReason": null,
  "createdAt": "2024-11-08T09:19:03.431Z"
}

Error Codes

  • 400 - Missing API key or email / Missing txnId or custRefNo
  • 401 - Invalid credentials
  • 404 - Transaction not found
  • 500 - Internal server error

Endpoint: Check Payout Status

URL: https://primexpay.in/api/merchant/check-payout-status

Method: POST

Content-Type: application/json

Request Body

Required JSON fields (any one of txnId or custRefNo):

  • authEmail (string) - Merchant Email
  • apiKey (string) - Merchant API Key
  • txnId (string) - Payout Transaction ID
  • custRefNo (string) - Customer Reference Number

Example Request:

{
  "authEmail": "auth@merchant.com",
  "apiKey": "YourAPIKey",
  "custRefNo": "REF998877"
}

Success Response

{
  "success": true,
  "message": "Transaction found.",
  "txnId": "PAYOUT_TXN_123456",
  "custRefNo": "REF998877",
  "status": "pending",
  "amount": "1000.00",
  "netAmount": "990.00",
  "utr": null,
  "failureReason": null,
  "createdAt": "2024-11-08T10:00:00.000Z"
}

Error Codes

  • 400 - Missing API key or email / Missing txnId or custRefNo
  • 401 - Invalid credentials
  • 404 - Transaction not found
  • 500 - Internal server error