Get all payments

GET /api/v1/Payments/get-all

Description

This endpoint is used to retrieve all payments based on various filtering criteria.

Tags:
Payments

URL:
/api/v{version}/Payments/get-all

ApiKey:
No API key required

Content-Type:
No request body

Query Parameters:
UserId: string, optional, unique identifier of the user.
TenantId: string, optional, unique identifier of the tenant.
AccountId: string, optional, unique identifier of the account.
TransactionDate: string, optional, in date-time format, date of the transaction.
StartDate: string, optional, in date-time format, start date of the transaction period.
EndDate: string, optional, in date-time format, end date of the transaction period.
SearchText: string, optional, text to search for.
Order: object, optional, ordering options for the result list.
Status: object, optional, status of the transaction.
Type: object, optional, type of the transaction.
Descending: boolean, optional, sorting order for the result list.
PageNumber: integer, optional, default is 1, page number for pagination.
PageSize: integer, optional, default is 10, page size for pagination.
version: string, required, version of the API.
Accept-Language: header, optional, change the default response message language from English (en) to French (fr) or English (en).

Request Body:
None

Response:
Success, returns a list of all payments based on the provided filtering criteria.

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

Example:

bashCopy codeGET /api/v1/Payments/get-all?UserId=12345-abcde-67890&AccountId=3456-defgh-789&TransactionDate=2024-02-17T10:00:00&PageSize=5&PageNumber=1
Accept-Language: en

/api/v`{{version}}`/Payments/get-all?UserId=<uuid>&TenantId=<uuid>&AccountId=<string>&TransactionDate=<dateTime>&StartDate=<dateTime>&EndDate=<dateTime>&SearchText=<string>&Order=1&Status=3&Type=2&Descending=<boolean>&PageNumber=<integer>&PageSize=<integer>

Headers

Content-Type	Value
Accept-Language

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
UserId	<uuid>
TenantId	<uuid>
AccountId	<string>
TransactionDate	<dateTime>
StartDate	<dateTime>
EndDate	<dateTime>
SearchText	<string>
Order	1
Status	3
Type	2
Descending	<boolean>
PageNumber	<integer>
PageSize	<integer>

Response: 200

{
  "pageNumber": `<integer>`,
  "pageSize": `<integer>`,
  "total": `<integer>`,
  "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>`
    },
    {
      "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>`
}