Retrieve Card Payment Status

GET /payments/card/status-query/{reference_id}

Description

This` endpoint allows you to query the status of a card payment transaction using its unique reference ID. By making a GET request to this endpoint with the relevant parameters, you can retrieve real-time information about the current status of the specified card payment.

Required Headers

	Type	Description
apiKey	string	(Required). Wallet API key for authentication. Include in the request header.
Authorization	string	(Required). Authentication token. Include in the request header using the "Bearer" scheme. Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2NGQ2Nm...

Path Parameters

Name	Type	Description
reference_id*	string	(Required) Unique reference ID of the card payment transaction. Include in the request path.

Response Code: 200 - OK

Description

The HTTP status code 200 indicates a successful response from the server. This response is typically returned when a requested operation has been successfully processed.

StartFragment

Response Field

Field	Type	Description
status	boolean	Indicates the overall success of the operation.
statusCode	integer	Represents the specific status code for the response.
message	string	Provides additional information about the response.
data	object	Contains the main data payload of the response.
errors	array	An array containing error details if issues occurred.
- message	string	Describes the error.
- descriptiveMessage	string	Provides a more detailed and descriptive message about the error.

Example

<response>
  <status>true</status>
  <statusCode>0</statusCode>
  <message>string</message>
  <data></data>
  <errors>
    <error>
      <message>string</message>
      <descriptiveMessage>string</descriptiveMessage>
    </error>
  </errors>
</response>

Method: GET

>http://20.87.230.105/platform/wallets/payments/ussd/status-query/transaction_123

Headers

Content-Type	Value
apiKey	{{apiKey}}

🔑 Authentication bearer

Param	value	Type
token	{{accessCode}}	string