List all statement activity - Lopay Partner API

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Query Params

offsetId

string

optional

Optional. Base64 encoded ISO date of the last activity entry in current response. Provided in the "nextOffsetId" property in the response.

Example:

MjAyNS0wMi0yMFQxNjowMDo1Ni4zODBa

pageSize

number

optional

Optional - default 20. Number of statement activity entries to return.

<= 100> 0

Default:

20

Example:

20

startDate

string <date-time>

required

The timestamp from which to list activity entries from. Interpreted in UTC.

Example:

2025-01-01T00:00:00.000Z

endDate

string <date-time>

required

The timestamp up to which to list activity entries to. Interpreted in UTC.

Example:

2025-01-01T23:59:59.999Z

teamMemberId

string <uuid>

optional

Optional. ID of the team member to filter the statement activity entries by.

Example:

c689b77a-d47d-4d02-b037-6f49509f759b

type

enum<string>

optional

Optional. The type of statement activity to filter by.

Allowed values:

incomerefundspayoutscardSpendcashAdvanceRepayments

Example:

income

query

string

optional

Optional. Text search term to filter by.

Example:

Haircut

Header Params

x-merchant-id

string <uuid>

Merchant ID

required

If acting on behalf of a merchant, you will need to specify their merchant ID.

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.lopay.com/api/1/partner/report/statement/activity?startDate&endDate' \
--header 'x-merchant-id;' \
--header 'x-api-key;'

Responses

🟢200OK

application/json

OK response

Body

data

array [object {9}]

required

id

string <uuid>

required

title

string

required

type

enum<string>

required

Allowed values:

paymentpayoutauthorizationvouchercashAdvancePayoutcashAdvanceRepayment

status

enum<string>

required

Allowed values:

successrefundpaidfailedpending

amount

object

required

logoUrl

string <uri> | null

optional

paymentId

string <uuid> | null

optional

paidAt

string | null

optional

createdAt

string

required

pagination

object

required

pageSize

integer

required

> 0

nextOffsetId

string | null

required

Examples

No offsetIdWith offsetId

{
    "data": [
        {
            "id": "441bd490-c557-4d0f-85c7-46b4760c6439",
            "title": "Payout to bank",
            "type": "payout",
            "status": "paid",
            "amount": {
                "units": 1953,
                "currencyCode": "GBP"
            },
            "createdAt": "2025-02-20T16:01:23.349Z"
        }
    ],
    "pagination": {
        "pageSize": 1,
        "nextOffsetId": "MjAyNS0wMi0yMFQxNjowMToyMy4zNDla"
    }
}

🟠400Bad Request

🟠401Unauthorized