Invoice Account Transactions

GET /api/v1/InvoiceAccounts/:accountId/transactions

Description

This endpoint is used to retrieve a list of transactions associated with a specific Invoice Account. It returns a TransactionResponseListPagedResponse object containing the details of the transactions, as well as paging information.

Headers:

• Content-Type: application/json

ApiKey:

• No API key required

Path Parameters:

• version: string, required

• accountId: string, required

Query Parameters:

• pageNumber: integer, optional (default is 1)

• pageSize: integer, optional (default is 10)

URL:

• GET: {{baseUrl API url}}/api/v1/InvoiceAccounts/{accountId}/transactions?pageNumber=1&pageSize=10

Response:

• A TransactionResponseListPagedResponse object containing the details of the transactions, as well as paging information.

Error Codes:

• 400: Bad Request

• 404: Resource not found

• 500: Internal server error

Example Request URL:

GET /api/v1/InvoiceAccounts/98f2d2e5-6140-4f19-9b58-48c5003e92f7/transactions?pageNumber=1&pageSize=10
Content-Type: application/json

Example Response:

HTTP/1.1 200 OK
{
  "totalRecords": 5,
  "pageNumber": 1,
  "pageSize": 10,
  "transactions": [
    {
      "transactionId": "103213db-1735-4a8c-a70a-0c8e3f83c07e",
      "accountId": "98f2d2e5-6140-4f19-9b58-48c5003e92f7",
      "transactionType": "Credit",
      "amount": 100.00,
      "currencyCode": "USD",
      "transactionDate": "2024-02-17T14:45:00Z",
      "description": "Payment received for Invoice #123456"
    },
    {
      "transactionId": "429d6ef6-08f9-4878-8cf8-ae1c82666d88",
      "accountId": "98f2d2e5-6140-4f19-9b58-48c5003e92f7",
      "transactionType": "Debit",
      "amount": 50.00,
      "currencyCode": "USD",
      "transactionDate": "2024-02-16T14:45:00Z",
      "description": "Invoice #654321 payment"
    }
  ]
}

Method: GET

/api/v1/InvoiceAccounts/:accountId/transactions?pageNumber=1&pageSize=10

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
pageNumber	1
pageSize	10

Response: 200

{
  "pageNumber": "<integer>",
  "pageSize": "<integer>",
  "total": "<integer>",
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": [
    {
      "id": "<uuid>",
      "beneficiaryAccount": {
        "accountNumber": "<string>",
        "accountName": "<string>",
        "bank": "<string>"
      },
      "sourceAccount": {
        "accountNumber": "<string>",
        "accountName": "<string>",
        "bank": "<string>"
      },
      "customerName": "<string>",
      "customerEmail": "<string>",
      "customerPhone": "<string>",
      "accountNumber": "<string>",
      "accountName": "<string>",
      "narration": "<string>",
      "amount": "<double>",
      "previousBalance": "<double>",
      "newBalance": "<double>",
      "transactionFee": "<double>",
      "settledAmount": "<double>",
      "transactionType": 0,
      "transactionStatus": 6,
      "transactionSource": 1,
      "transactionReference": "<uuid>",
      "customerId": "<string>",
      "merchantId": "<string>",
      "remarks": "<string>",
      "prevailingRate": "<string>",
      "processingAgentID": "<string>",
      "userTransactionRef": "<string>",
      "transactionDate": "<dateTime>",
      "deleted": "<boolean>",
      "externalReference": "<string>",
      "walletId": "<uuid>",
      "origin": 1,
      "currency": "<string>",
      "externalBankReference": "<string>",
      "originatorName": "<string>",
      "originatorAccountNumber": "<string>",
      "originatorBankName": "<string>"
    },
    {
      "id": "<uuid>",
      "beneficiaryAccount": {
        "accountNumber": "<string>",
        "accountName": "<string>",
        "bank": "<string>"
      },
      "sourceAccount": {
        "accountNumber": "<string>",
        "accountName": "<string>",
        "bank": "<string>"
      },
      "customerName": "<string>",
      "customerEmail": "<string>",
      "customerPhone": "<string>",
      "accountNumber": "<string>",
      "accountName": "<string>",
      "narration": "<string>",
      "amount": "<double>",
      "previousBalance": "<double>",
      "newBalance": "<double>",
      "transactionFee": "<double>",
      "settledAmount": "<double>",
      "transactionType": 1,
      "transactionStatus": 4,
      "transactionSource": 6,
      "transactionReference": "<uuid>",
      "customerId": "<string>",
      "merchantId": "<string>",
      "remarks": "<string>",
      "prevailingRate": "<string>",
      "processingAgentID": "<string>",
      "userTransactionRef": "<string>",
      "transactionDate": "<dateTime>",
      "deleted": "<boolean>",
      "externalReference": "<string>",
      "walletId": "<uuid>",
      "origin": 1,
      "currency": "<string>",
      "externalBankReference": "<string>",
      "originatorName": "<string>",
      "originatorAccountNumber": "<string>",
      "originatorBankName": "<string>"
    }
  ]
}