Get SoftPOS Transaction Status — API

Retrieves the current status of a SoftPOS transaction using transactionId, orderId, or rrn. Supports Merchant, Partner, and Super Admin access and returns the transaction status or documented validation and not-found errors.

1. Overview

Retrieves the current status of a SoftPOS transaction using a supported transaction identifier.

The request must include at least one of the following identifiers: transactionId, orderId, or rrn. If multiple identifiers are provided, the API processes the lookup in the following priority order:

  1. transactionId
  2. orderId
  3. rrn

Access Level: MERCHANT, PARTNER, SUPER_ADMIN

2. Endpoint Details

PropertyValue
HTTP MethodGET
Endpoint/api/v1/transactions/softpos/status
Base URLhttps://app-api.edfapay.com
Content-TypeNot required for a GET request without a body
Acceptapplication/json

3. Authentication

Include the API key in the request header:

HeaderValue
X-API-KEYYOUR_API_KEY
Acceptapplication/json

4. Query Parameters

At least one of the following query parameters must be provided.

ParameterTypeRequiredDescriptionExample
transactionIdString (UUID)ConditionalUnique transaction identifier.b08e4f9d-35cc-4230-8a2e-06ca74a09a2e
orderIdStringConditionalMerchant-provided order identifier. Supports string values or UUIDs.TEST-1234
rrnStringConditionalRetrieval Reference Number associated with the transaction.150812091314

Important: At least one identifier is required. If multiple identifiers are provided, the API uses the priority described in the Overview section.

5. Request Example

cURL

curl --request GET \
  --url 'https://app-api.edfapay.com/api/v1/transactions/softpos/status?transactionId=b08e4f9d-35cc-4230-8a2e-06ca74a09a2e' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Accept: application/json'

Using orderId

curl --request GET \
  --url 'https://app-api.edfapay.com/api/v1/transactions/softpos/status?orderId=TEST-1234' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Accept: application/json'

Using rrn

curl --request GET \
  --url 'https://app-api.edfapay.com/api/v1/transactions/softpos/status?rrn=150812091314' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Accept: application/json'

6. Responses

6.1 HTTP 200 — Success

Description: SoftPOS transaction status retrieved successfully.

The exact successful response schema is not shown in the provided API reference. Refer to the live Swagger response schema for the transaction status fields and their data types.

6.2 HTTP 400 — Invalid Request Parameters

Description: The request contains invalid parameters or cannot be processed.

Example response:

{
  "code": 400,
  "message": "Error invalid request exception, something wrong",
  "errorCode": "400",
  "data": null
}

6.3 HTTP 404 — Transaction Not Found

Description: The requested transaction could not be found.

Example response:

{
  "code": 0,
  "message": "string",
  "errorCode": "string",
  "data": {}
}

The values shown above are Swagger example placeholders, not guaranteed runtime values.

7. Implementation Notes

  • Provide at least one supported transaction identifier.
  • Use the correct identifier format, particularly for transactionId, which must be a UUID.
  • Use URL encoding when query parameter values contain special characters.
  • Handle 400 Bad Request and 404 Not Found responses appropriately.
  • Do not treat a successful HTTP response alone as proof that the payment succeeded; inspect the returned transaction status when available.

8. Summary

This endpoint allows authorized Merchant, Partner, and Super Admin users to retrieve the current status of a SoftPOS transaction using its transaction ID, order ID, or Retrieval Reference Number (RRN).


Did this page help you?