Payment Status

PUT /api/v1/Payments/:trxnId/status

Description

This endpoint is used to retrieve the status of a money transfer transaction.

Headers:

• No specific headers are required.

Path Parameters:

• version: The version of the API.

• trxnId: The transaction ID of the money transfer transaction.

URL:

• GET: /api/v1/Payments/{trxnId}/status

Response:

• 200: Success, returns the status of the transaction.

Error Codes:

• 400: Bad request, the request is not valid.

• 404: Not found, the transaction ID does not exist or is invalid.

• 500: Internal server error, something went wrong while processing the request.

Example Request URL:

GET /api/v1.0/Payments/trxn123/status

Example Response:

HTTP/1.1 200 OK
{
  "status": "Success",
  "amount": 100.0,
  "description": "Payment for services",
  "senderAccountId": "abc123",
  "recipientAccountId": "xyz789",
  "transactionDate": "2024-02-16T12:00:00Z"
}

Notes:

• The response includes the status, amount, description, sender account ID, recipient account ID, and transaction date.

• The status can be one of the following: "Success", "Pending", "Failed".

• This endpoint can be useful for retrieving information about a specific transaction, including its status and details.

Method: GET

/api/v1/Payments/:trxnId/status

Headers

Content-Type	Value
Accept	text/plain

Response: 200

{
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": {
    "id": "<uuid>",
    "status": "<string>",
    "amount": "<double>",
    "fee": "<double>",
    "narration": "<string>"
  }
}