Skip to main content

Get transaction detail by ID

GET /api/v1/Payments/:trnxId/transaction-details

Description​

This endpoint is used to retrieve transaction details of a payment based on its unique transaction ID.

Tags:
Payments

URL:
/api/v{version}/Payments/{trnxId}/transaction-details

ApiKey:
No API key required

Content-Type:
No request body

Path Parameters:
trnxId: string, required, unique identifier of the transaction.

Query Parameters:
None

Response:
Success, returns the transaction details of the payment.

Error Codes:
400: Bad Request
404: Not Found
500: Internal Server Error

Example:

GET /api/v1/Payments/123456789/transaction-details
Accept-Language: en

/api/v1/Payments/:trnxId/transaction-details

Headers​

Content-TypeValue
Accept-Language

Headers​

Content-TypeValue
Accepttext/plain

Response: 200​

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": {
    "id": `<uuid>`,
    "tenantId": `<uuid>`,
    "userId": `<uuid>`,
    "accountId": `<uuid>`,
    "amount": `<double>`,
    "newBalance": `<double>`,
    "previousBalance": `<double>`,
    "reference": `<string>`,
    "externalReference": `<string>`,
    "currency": `<string>`,
    "status": `<string>`,
    "type": `<string>`,
    "senderAccount": `<string>`,
    "recipientAccount": `<string>`,
    "bankName": `<string>`,
    "created": `<string>`,
    "narration": `<string>`,
    "description": `<string>`
  }
}

Response: 400​

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<string>`
}

Response: 404​

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<string>`
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /api/v1/Payments/:trnxId/transaction-details \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!