Versions Compared

Version Old Version 4 New Version Current
Changes made by

Leatherback (Unlicensed)

Leatherback (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Panel
bgColor#79E2F2

Title: Fetch all Transaction Details by Page Size

Panel
bgColor#F4F5F7

Description: This endpoint is used to retrieve transaction details in pages. Default size is 50pages

Panel
bgColor#F4F5F7

URL: https://laas.leatherback.co/Payout/Disbursement/Payout/FetchPayoutTxns

Panel
bgColor#F4F5F7

Base URL: https://laas.leatherback.co

Panel
bgColor#F4F5F7

HTTP Method: GET

Panel
bgColor#F4F5F7

Headers: authorization Set value to X-API: SECRET_KEY

string

 

First, you need to pass the Query params stated below;

Panel
bgColor#FFC400

Query Params

Code Block
languagejson
pageNumber integer($int32)(query)
page number: ''
Default value : 1

1
pageSizeinteger($int32)
(query)
page size.

Default value : 50

 

Panel
bgColor#FFC400

Sample Response code : 200

...

languagejson

...

 

Element

Description

Type

Example

Required

pageNumber

Current page of the transaction list

Integer | query Params

1

Yes

pageSize

Number of items returned per current page

Integer | query Params

Default is 50

Yes

Panel
bgColor#FFC400

Sample Response

Expand
titleSample Response Payload (Success)
Code Block
{
  "value": {
    "pageData": {
      "pageNumber": 1,
      "pageCount": 51,
      "pageSize": 2,
      "hasNextPage": true,
      "hasPreviousPage": false,
      "firstItemOnPage": 1,
      "lastItemOnPage": 2,
      "totalItemCount": 101
    },
    "record": [
      {
        "txnId": "ada50036-3f3f-4cc4-5a1d-08dbd036e81c",
        "batchId": "9672d878-692c-4b14-bbd8-af3aefc74844",
        "debitAccountNumber": "GB80LEAT04069100005580",
        "debitAccountName": "LAAS TEAM",
        "beneficiaryAccountNumber": "GB02LEAT04069100008245",
        "currencyCode": "GBP",
        "currencySymbol": "£",
        "amount": 4000,
        "narration": "Received Credit transaction",
        "status": "Successful",
        "previousBalance": 0,
        "currentBalance": 4000,
        "payoutType": "Credit",
        "tenantReference": "30e57c42-a0c3-40e4-aaf0-8c3c2ffcb5ab",
        "paymentReference": "AaaS-TDXMPNOZEPPO",
        "beneficiaryAccountName": "BOLLY GROUP",
        "beneficiaryPaymentMethodType": "None",
        "beneficiaryPaymentMethodValue": null,
        "transactionDate": "2023-10-19T00:04:05.5111377"
      },
      {
        "txnId": "
3fa85f64
99f41f45-
5717
b8e5-
4562
4956-
b3fc
1fce-
2c963f66afa6
08dbd0370126",
        "batchId": "
3fa85f64
9f937918-
5717
c72c-
4562
4e0e-
b3fc
9b07-
2c963f66afa6
04d73d04aa26",
        "debitAccountNumber":
"string"
null,
        "debitAccountName":
"string"
null,
        "beneficiaryAccountNumber": "
string
9977598776",
        "currencyCode": "
string
NGN",
        "currencySymbol": "
string
₦",
        "amount":
0
5000000,
        "narration": "
string
Account Topup.",
        "status": "
string
Successful",
        "previousBalance": 0,
        "currentBalance":
0
5000000,
        "payoutType": "
None
Credit",
        "tenantReference": "
string
",
        "paymentReference": "
string
T9QFTIAHJPPO",
        "beneficiaryAccountName": "
string
MERCHANT(Bolly group)",
        "beneficiaryPaymentMethodType": "
string
BankCode",
        "beneficiaryPaymentMethodValue": "000023",
        "transactionDate": "2023-10-19T00:04:48.6103903"
      }
    ]
  },
  "isSuccess": true,
  "error": "",
  "message":
"string" } ], "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string
"",
  "responseCode": null,
  "type": null,
  "title": null,
  "status": 200,
  "detail": null,
  "instance": null,
  "extensions": {}
}
Expand
titleSample Response Payload ( No Result)
Code Block
{
    "value": {
        "pageData": {
            "pageNumber": 1,
            "pageCount": 51,
            "pageSize": 10,
            "hasNextPage": false,
            "hasPreviousPage": false,
            "firstItemOnPage": 0,
            "lastItemOnPage": 0,
            "totalItemCount": 0
        },
        "record": []
    },
    "isSuccess": true,
    "error": "",
    "message": "",
    "responseCode": null,
    "type": null,
    "title": null,
    "status": 200,
    "detail": null,
    "instance": null,
    "extensions": {}
}
Expand
titleSample Response Payload ( Error)
Code Block
languagejs
{
    "errors": {
        "pageNumber": [
            "The value 'e' is not valid."
        ]
    },
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "00-77a2c1552f5cf72df0b8c9c455aada95-a8626ad2891ff1be-00"
}
Filter by label (Content by label)
showLabelsfalse
max5
spacescom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@1256f
sortmodified
showSpacefalse
reversetrue
typepage
labelskb-how-to-article
cqllabel = "kb-how-to-article" and type = "page" and space = "LAD"