Generate Fee Statement

POST

/api/admin/merchants/{merchantId}/fee-statements

curl --request POST \
  --url https://example.com/api/admin/merchants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/fee-statements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "merchantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "periodStart": "2026-04-15T12:00:00Z", "periodEnd": "2026-04-15T12:00:00Z" }'

Generate a Draft statement for the outstanding (unbilled) fees up to an optional cutoff.

Authorizations

• Bearer

Parameters

Path Parameters

merchantId

required

string format: uuid

Request Body

object

merchantId

string format: uuid

periodStart

string format: date-time

nullable

periodEnd

string format: date-time

nullable

Example ^generated

{
  "merchantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "periodStart": "2026-04-15T12:00:00Z",
  "periodEnd": "2026-04-15T12:00:00Z"
}

object

merchantId

string format: uuid

periodStart

string format: date-time

nullable

periodEnd

string format: date-time

nullable

Example ^generated

{
  "merchantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "periodStart": "2026-04-15T12:00:00Z",
  "periodEnd": "2026-04-15T12:00:00Z"
}

object

merchantId

string format: uuid

periodStart

string format: date-time

nullable

periodEnd

string format: date-time

nullable

Example ^generated

{
  "merchantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "periodStart": "2026-04-15T12:00:00Z",
  "periodEnd": "2026-04-15T12:00:00Z"
}

Responses

201

Created

Media type application/json

object

statement

object

id

string format: uuid

merchantId

string format: uuid

reference

string

nullable

periodStart

string format: date-time

nullable

periodEnd

string format: date-time

status

string

Allowed values: Draft Finalised Paid Void

totalFees

number format: double

totalNet

number format: double

transactionCount

integer format: int32

currency

string

nullable

finalisedAt

string format: date-time

nullable

paidAt

string format: date-time

nullable

createdAt

string format: date-time

paymentReference

string

nullable

notes

string

nullable

lines

object

items

Array<object>

nullable

object

transactionId

string format: uuid

occurredAt

string format: date-time

description

string

nullable

reference

string

nullable

status

string

Allowed values: Processing Approved Declined Refunded Voided

amount

number format: double

feeAmount

number format: double

netAmount

number format: double

page

integer format: int32

pageSize

integer format: int32

totalCount

integer format: int32

totalPages

integer format: int32

hasNextPage

boolean

hasPreviousPage

boolean

Example

{
  "statement": {
    "status": "Draft"
  },
  "lines": {
    "items": [
      {
        "status": "Processing"
      }
    ]
  }
}

404

Not Found

Media type application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}