Collection TSC

A merchant can use this endpoint to accept customer payments, confirm successful collections, track transaction histories, reconcile accounts, and integrate with order management systems for smooth payment processing.

POST https://subsidiary.dev.mypaygate.co/collection/v1/check-status

The Collections Status Check API provides programmatic access to collection records, offering real-time insights into collection status (pending, resolved, disputed, etc.)

Sample Payload Object

{
  "requestHeader": {
      "clientId": "",
      "requestType": "GH-Collections"
  },
  "transactionReference": "abc12893323",
  "transactionCountry": "GH"
}

Headers

Header Name	Value
Content-Type	application/json
x-module	Base_64(TransactionReference)
x-business	Base_64(merchant public key)
x-app	api

Sample Request (POST)

curl --location 'https://subsidiary.dev.mypaygate.co/collection/v1/check-status' --header 'Accept: application/json' --header 'X-module: YWJjMTI4OTMzMjM=' --header 'X-business: UEstMS1lOWEyZmM0NDgxMTg0NjU1LVQzbUpCRzU4blExNGlHOGFrOXZ1dGpQVzdERmxDZ0RW' --header 'Content-Type: application/json' --header 'X-app: xxx' --data '{
  "requestHeader": {
      "clientId": "",
      "requestType": "GH-Collections"
  },
  "transactionReference": "abc12893323",
  "transactionCountry": "GH"
}'

Sample Response

200 OK

{
  "serverResponse": {
      "responseDetails": {
          "responseMessage": "PENDING",
          "responseCode": "09"
      }
  }
}

400 Bad Request

{
  "timestamp": "2025-08-11T20:56:41.477+00:00",
  "status": 400,
  "error": "Bad Request",
  "path": "/collection/v1/check-status"
}