Documentation Powered by ReDoc

Centrobill Customer Invoice API (1.0.0)

Download OpenAPI specification:Download

Authentication

ApiKeyAuth

Security Scheme Type API Key
Header parameter name: Authorization

Invoices

Operations with merchant invoices

Retrieve Invoices

Get a list of invoices based on various filtering options.

Authorizations:
ApiKeyAuth
query Parameters
clients
Array of integers

List of Merchant IDs

systems
Array of integers

List of System IDs

pm
string

Payment method

currency
string 3 characters

Currency ISO3 code

payoutCurrency
string 3 characters

Payout Currency ISO3 code

threadId
integer

Thread ID

periodId
integer

Period ID

metaAccountType
string
Enum: "internal" "external"

Type of meta account

minPayout
number

Minimum payout amount

estimatedPayoutDate
string <date>

Estimated payout date (YYYY-MM-DD)

onlyUnpaid
boolean

Filter to include only unpaid invoices

onlyPayable
boolean

Filter to include only payable invoices

page
integer
Default: 1

Page number for pagination

limit
integer
Default: 100

Limit of records per page

invoiceForVendors
boolean

Whether the invoice is for vendors

periodEndDate
string <date>

End date of the period (YYYY-MM-DD)

status
string
Enum: "unpaid" "paid" "zero_amount" "accrued"

Invoice status:

  • unpaid - Unpaid invoice with positive payout.
  • paid - Paid invoice.
  • zero_amount - Invoice with zero payout.
  • accrued - Invoice with negative payout.
actualPayoutDateFrom
string <date>

Filter invoices with an actual payout date from (YYYY-MM-DD)

actualPayoutDateTo
string <date>

Filter invoices with an actual payout date up to (YYYY-MM-DD)

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retrieve an Invoice

Get details of an invoice. Supports JSON and PDF response formats via Accept header.

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Invoice ID

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
application/json
application/pdf
{
  • "id": 987654,
  • "threadId": 123,
  • "periodId": 456,
  • "currency": "USD",
  • "pm": "cc",
  • "clientId": 123456,
  • "systemId": 654321,
  • "clientSystemId": 789,
  • "metaAccType": "external",
  • "invoiceType": "internal",
  • "revenue": 15000.75,
  • "revenueWithoutVat": 14000,
  • "credits": 1200.5,
  • "chbk": 50.25,
  • "chbkCount": 3,
  • "repaids": 500,
  • "repaidsDiscountRate": 5,
  • "discountRate": 5.5,
  • "reserve": 300,
  • "reservePaidBack": false,
  • "reservePaybackDate": "2026-01-15",
  • "reservePayback": 100.75,
  • "reserveRate": 7.5,
  • "chargebackFine": 25,
  • "payout": 14000.25,
  • "payoutOffset": 5,
  • "localPayout": 14000.25,
  • "convertedPayout": null,
  • "payoutCurrency": "EUR",
  • "currencyCommission": 0,
  • "currencyRate": 0,
  • "perTrxFee": 0.2,
  • "perTrxSuccessFee": 0.1,
  • "perTrxFailFee": 0.12,
  • "perTrxGraceFee": 0.08,
  • "perTrxGraceSuccessFee": 0,
  • "perTrxGraceFailFee": 0,
  • "perCreditFee": 0.15,
  • "gatewayFee": 0.5,
  • "verificationFee": 0,
  • "perTrxAutoAntifraudFee": 0,
  • "perTrxManualAntifraudFee": 0,
  • "manualAntifraudFixed": 0,
  • "settlementFee": 0,
  • "settlementFixedFee": 0,
  • "fxFee": 0,
  • "payoutTrxFee": 0,
  • "perTrxPayoutFee": 0,
  • "payouts": 0,
  • "payoutCount": 0,
  • "reversalRequestFee": 0,
  • "reversalRequestsCount": 0,
  • "trxCount": 200,
  • "trxSuccessCount": 180,
  • "trxFailCount": 15,
  • "trxGraceCount": 5,
  • "trxGraceSuccessCount": 3,
  • "trxGraceFailCount": 2,
  • "returnsTrnxCount": 0,
  • "creditCount": 15,
  • "trxAutoAntifraudCount": 4,
  • "trxManualAntifraudCount": 2,
  • "verificationTrxCount": 0,
  • "vatLocal": 200.5,
  • "vatLocalCharged": 120,
  • "vatLocalCredit": 80.5,
  • "periodType": 4,
  • "estimatedPayoutDate": "2026-02-10",
  • "actualPayoutDate": null,
  • "transactionsCurrency": "USD",
  • "mids": [ ],
  • "informational": false,
  • "status": "unpaid",
  • "dateFrom": "2025-11-01",
  • "dateTo": "2025-11-10",
  • "adjustments": [
    ],
  • "createdAt": "2025-11-15T14:30:00.000000Z",
  • "updatedAt": "2025-11-20T08:45:00.000000Z",
  • "period": {
    }
}

Delete an Invoice

Delete an invoice by ID. Unassigns related adjustments and removes thread-period locks.

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Invoice ID

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthorized"
}

Retrieve Invoices (Hybrid)

Get a list of invoices from both current and legacy systems. Uses the same filtering parameters as the regular list endpoint.

Authorizations:
ApiKeyAuth
query Parameters
clients
Array of integers

List of Merchant IDs

systems
Array of integers

List of System IDs

pm
string

Payment method

currency
string 3 characters

Currency ISO3 code

payoutCurrency
string 3 characters

Payout Currency ISO3 code

threadId
integer

Thread ID

periodId
integer

Period ID

metaAccountType
string
Enum: "internal" "external"

Type of meta account

minPayout
number

Minimum payout amount

estimatedPayoutDate
string <date>

Estimated payout date (YYYY-MM-DD)

onlyUnpaid
boolean

Filter to include only unpaid invoices

onlyPayable
boolean

Filter to include only payable invoices

page
integer
Default: 1

Page number for pagination

limit
integer
Default: 100

Limit of records per page

invoiceForVendors
boolean

Whether the invoice is for vendors

periodEndDate
string <date>

End date of the period (YYYY-MM-DD)

status
string
Enum: "unpaid" "paid" "zero_amount" "accrued"

Invoice status

actualPayoutDateFrom
string <date>

Filter invoices with an actual payout date from (YYYY-MM-DD)

actualPayoutDateTo
string <date>

Filter invoices with an actual payout date up to (YYYY-MM-DD)

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Export Invoices

Export invoices as CSV or JSON. Uses the same filtering parameters as the regular list endpoint. Maximum 10000 records.

Authorizations:
ApiKeyAuth
query Parameters
clients
Array of integers

List of Merchant IDs

systems
Array of integers

List of System IDs

pm
string

Payment method

currency
string 3 characters

Currency ISO3 code

payoutCurrency
string 3 characters

Payout Currency ISO3 code

threadId
integer

Thread ID

periodId
integer

Period ID

metaAccountType
string
Enum: "internal" "external"

Type of meta account

minPayout
number

Minimum payout amount

estimatedPayoutDate
string <date>

Estimated payout date (YYYY-MM-DD)

onlyUnpaid
boolean

Filter to include only unpaid invoices

onlyPayable
boolean

Filter to include only payable invoices

invoiceForVendors
boolean

Whether the invoice is for vendors

periodEndDate
string <date>

End date of the period (YYYY-MM-DD)

status
string
Enum: "unpaid" "paid" "zero_amount" "accrued"

Invoice status

actualPayoutDateFrom
string <date>

Filter invoices with an actual payout date from (YYYY-MM-DD)

actualPayoutDateTo
string <date>

Filter invoices with an actual payout date up to (YYYY-MM-DD)

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
application/json
text/csv
[
  • [
    ]
]

Compare Invoice

Compare an invoice between current and legacy systems for a specific period and thread.

Authorizations:
ApiKeyAuth
path Parameters
periodId
required
integer

Period ID

threadId
required
integer

Thread ID

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
{ }

Compare Invoices for Period

Compare all invoices in a period between current and legacy systems. Returns only invoices with differences.

Authorizations:
ApiKeyAuth
path Parameters
periodId
required
integer

Period ID

query Parameters
limit
integer
Default: 5

Maximum number of invoices to compare

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
[
  • { }
]

Mark Invoice as Paid

Mark an invoice as paid. Sets the actual payout date to today.

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Invoice ID

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthorized"
}

Threads

Operations with invoice settings (threads)

Retrieve Threads

Get list of Threads

Authorizations:
ApiKeyAuth
query Parameters
clientIds
Array of integers

List of Merchant IDs

systemIds
Array of integers

List of System IDs

pm
string

Payment method

currency
string 3 characters

Currency ISO3 code

page
integer
Default: 1

Page number

limit
integer
Default: 100

Limit per page

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Add Thread

Create a new Thread

Authorizations:
ApiKeyAuth
header Parameters
X-Request-ID
required
string

Unique ID of request

Request Body schema: application/json
clientId
required
integer

Merchant ID

currency
string 3 characters

Currency ISO3 code

feeCurrency
string 3 characters

Currency for fees

pm
string

Payment method

periodType
required
integer
Enum: 1 2 4 8

Period type:

  • 1 - Weekly period.
  • 2 - Half-monthly period.
  • 4 - Monthly period.
  • 8 - Half-weekly period.
metaAccType
required
string
Enum: "internal" "external"

Gateway account type

discountProfileId
required
integer >= 0

Discount profile ID

chargebackFine
number >= 0

Chargeback fine

reserveRate
number >= 0

Reserve rate percentage

reservePaybackPeriod
integer >= 0

Reserve payback period in days

payoutOffset
integer >= 0

Payout offset in days

perTrxFee
number >= 0

Fee per transaction

perCreditFee
number >= 0

Fee per credit transaction

gatewayFee
number >= 0

Gateway fee percentage

systemId
integer >= 0

System ID (0 if payout based on client ID)

perTrxSuccessFee
number >= 0
perTrxFailFee
number >= 0
perTrxGraceFee
number >= 0
perTrxGraceSuccessFee
number >= 0
perTrxGraceFailFee
number >= 0
verificationFee
number >= 0
perTrxAutoAntifraudFee
number >= 0
perTrxManualAntifraudFee
number >= 0
generate
boolean

Whether to auto-generate invoices

informational
boolean

Whether invoices are informational only

fxFee
number >= 0
settlementFee
number >= 0
settlementFixedFee
number >= 0
manualAntifraudFixed
number >= 0
payoutTrxFee
number >= 0
reversalRequestFee
number >= 0
perTrxPayoutFee
number >= 0
payoutCurrency
string

Payout currency ISO3 code

currencyCommission
number >= 0
mids
Array of integers or null
Array of objects or null

Responses

Request samples

Content type
application/json
{
  • "clientId": 6805,
  • "currency": "USD",
  • "feeCurrency": "EUR",
  • "pm": "cc",
  • "periodType": 1,
  • "metaAccType": "internal",
  • "discountProfileId": 1,
  • "chargebackFine": 41,
  • "reserveRate": 10,
  • "reservePaybackPeriod": 180,
  • "payoutOffset": 2,
  • "perTrxFee": 0,
  • "perCreditFee": 0,
  • "gatewayFee": 0,
  • "systemId": 0,
  • "perTrxSuccessFee": 0,
  • "perTrxFailFee": 0,
  • "perTrxGraceFee": 0,
  • "perTrxGraceSuccessFee": 0,
  • "perTrxGraceFailFee": 0,
  • "verificationFee": 0,
  • "perTrxAutoAntifraudFee": 0,
  • "perTrxManualAntifraudFee": 0,
  • "generate": true,
  • "informational": false,
  • "fxFee": 0,
  • "settlementFee": 0,
  • "settlementFixedFee": 0,
  • "manualAntifraudFixed": 0,
  • "payoutTrxFee": 0,
  • "reversalRequestFee": 0,
  • "perTrxPayoutFee": 0,
  • "payoutCurrency": "EUR",
  • "currencyCommission": 0,
  • "mids": [
    ],
  • "alertFees": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "currency": "USD",
  • "pm": "cc",
  • "chargebackFine": 41,
  • "reserveRate": 10,
  • "generate": true,
  • "informational": false,
  • "clientId": 6805,
  • "periodType": 2,
  • "discountProfileId": 1,
  • "reservePaybackPeriod": 180,
  • "payoutOffset": 2,
  • "perTrxFee": 0,
  • "perCreditFee": 0,
  • "gatewayFee": 0,
  • "metaAccType": "internal",
  • "invoiceType": "internal",
  • "systemId": 0,
  • "perTrxSuccessFee": 0,
  • "perTrxFailFee": 0,
  • "perTrxGraceFee": 0,
  • "perTrxGraceSuccessFee": 0,
  • "perTrxGraceFailFee": 0,
  • "graceMaintenanceFee": 0,
  • "verificationFee": 0,
  • "perTrxAutoAntifraudFee": 0,
  • "perTrxManualAntifraudFee": 0,
  • "feeCurrency": null,
  • "fxFee": 0,
  • "settlementFee": 0,
  • "settlementFixedFee": 0,
  • "payoutTrxFee": 0,
  • "reversalRequestFee": 0,
  • "perTrxPayoutFee": 0,
  • "payoutCurrency": null,
  • "currencyCommission": 0,
  • "manualAntifraudFixed": 0,
  • "mids": null,
  • "alertFees": [
    ]
}

Retrieve a Thread

Get details of a Thread

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Thread ID

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "currency": "USD",
  • "pm": "cc",
  • "chargebackFine": 41,
  • "reserveRate": 10,
  • "generate": true,
  • "informational": false,
  • "clientId": 6805,
  • "periodType": 2,
  • "discountProfileId": 1,
  • "reservePaybackPeriod": 180,
  • "payoutOffset": 2,
  • "perTrxFee": 0,
  • "perCreditFee": 0,
  • "gatewayFee": 0,
  • "metaAccType": "internal",
  • "invoiceType": "internal",
  • "systemId": 0,
  • "perTrxSuccessFee": 0,
  • "perTrxFailFee": 0,
  • "perTrxGraceFee": 0,
  • "perTrxGraceSuccessFee": 0,
  • "perTrxGraceFailFee": 0,
  • "graceMaintenanceFee": 0,
  • "verificationFee": 0,
  • "perTrxAutoAntifraudFee": 0,
  • "perTrxManualAntifraudFee": 0,
  • "feeCurrency": null,
  • "fxFee": 0,
  • "settlementFee": 0,
  • "settlementFixedFee": 0,
  • "payoutTrxFee": 0,
  • "reversalRequestFee": 0,
  • "perTrxPayoutFee": 0,
  • "payoutCurrency": null,
  • "currencyCommission": 0,
  • "manualAntifraudFixed": 0,
  • "mids": null,
  • "alertFees": [
    ]
}

Update Thread

Update an existing Thread. All fields are optional.

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

The ID of the thread to update

header Parameters
X-Request-ID
required
string

Unique ID of request

Request Body schema: application/json
clientId
integer

Merchant ID

currency
string 3 characters

Currency ISO3 code

feeCurrency
string or null 3 characters

Currency for fees

pm
string

Payment method

periodType
integer
Enum: 1 2 4 8

Period type:

  • 1 - Weekly period.
  • 2 - Half-monthly period.
  • 4 - Monthly period.
  • 8 - Half-weekly period.
chargebackFine
number >= 0

Chargeback fine per chargeback

reserveRate
number >= 0

Reserve rate percentage

reservePaybackPeriod
integer >= 0

Reserve payback period in days

payoutOffset
integer >= 0

Payout offset in days

perTrxFee
number >= 0

Fee per transaction

perCreditFee
number >= 0

Fee per credit transaction

gatewayFee
number >= 0

Gateway fee percentage

metaAccType
string
Enum: "internal" "external"

Gateway account type

invoiceType
string or null
Enum: "internal" "external"

Invoice type

systemId
integer >= 0

System ID (0 if payout based on client ID)

perTrxSuccessFee
number >= 0

Fee per successful transaction

perTrxFailFee
number >= 0

Fee per declined transaction

perTrxGraceFee
number >= 0

Fee per graced transaction

perTrxGraceSuccessFee
number >= 0

Fee per successful graced transaction

perTrxGraceFailFee
number >= 0

Fee per declined graced transaction

verificationFee
number >= 0

3DS verification fee

perTrxAutoAntifraudFee
number >= 0

Auto antifraud fee per transaction

perTrxManualAntifraudFee
number >= 0

Manual antifraud fee per transaction

discountProfileId
integer >= 0

Discount profile ID

generate
boolean

Whether to auto-generate invoices

informational
boolean

Whether invoices from this thread are informational only

fxFee
number >= 0

Foreign exchange fee percentage

settlementFee
number >= 0

Settlement fee percentage

settlementFixedFee
number >= 0

Fixed settlement fee

manualAntifraudFixed
number >= 0

Fixed fee for manual antifraud

payoutTrxFee
number >= 0

Payout transaction fee percentage

reversalRequestFee
number >= 0

Fee for reversal request

perTrxPayoutFee
number >= 0

Per-transaction payout fee

payoutCurrency
string or null

Payout currency ISO3 code

currencyCommission
number >= 0

Currency commission rate

mids
Array of integers or null

List of MIDs associated with this thread

Array of objects or null

Alert fee configurations

Responses

Request samples

Content type
application/json
{
  • "clientId": 6805,
  • "currency": "USD",
  • "feeCurrency": "EUR",
  • "pm": "cc",
  • "periodType": 2,
  • "chargebackFine": 41,
  • "reserveRate": 10,
  • "reservePaybackPeriod": 180,
  • "payoutOffset": 2,
  • "perTrxFee": 0,
  • "perCreditFee": 0,
  • "gatewayFee": 0,
  • "metaAccType": "internal",
  • "invoiceType": null,
  • "systemId": 0,
  • "perTrxSuccessFee": 0,
  • "perTrxFailFee": 0,
  • "perTrxGraceFee": 0,
  • "perTrxGraceSuccessFee": 0,
  • "perTrxGraceFailFee": 0,
  • "verificationFee": 0,
  • "perTrxAutoAntifraudFee": 0,
  • "perTrxManualAntifraudFee": 0,
  • "discountProfileId": 1,
  • "generate": true,
  • "informational": false,
  • "fxFee": 0,
  • "settlementFee": 0,
  • "settlementFixedFee": 0,
  • "manualAntifraudFixed": 0,
  • "payoutTrxFee": 0,
  • "reversalRequestFee": 0,
  • "perTrxPayoutFee": 0,
  • "payoutCurrency": "EUR",
  • "currencyCommission": 0,
  • "mids": [
    ],
  • "alertFees": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "currency": "USD",
  • "pm": "cc",
  • "chargebackFine": 41,
  • "reserveRate": 10,
  • "generate": true,
  • "informational": false,
  • "clientId": 6805,
  • "periodType": 2,
  • "discountProfileId": 1,
  • "reservePaybackPeriod": 180,
  • "payoutOffset": 2,
  • "perTrxFee": 0,
  • "perCreditFee": 0,
  • "gatewayFee": 0,
  • "metaAccType": "internal",
  • "invoiceType": "internal",
  • "systemId": 0,
  • "perTrxSuccessFee": 0,
  • "perTrxFailFee": 0,
  • "perTrxGraceFee": 0,
  • "perTrxGraceSuccessFee": 0,
  • "perTrxGraceFailFee": 0,
  • "graceMaintenanceFee": 0,
  • "verificationFee": 0,
  • "perTrxAutoAntifraudFee": 0,
  • "perTrxManualAntifraudFee": 0,
  • "feeCurrency": null,
  • "fxFee": 0,
  • "settlementFee": 0,
  • "settlementFixedFee": 0,
  • "payoutTrxFee": 0,
  • "reversalRequestFee": 0,
  • "perTrxPayoutFee": 0,
  • "payoutCurrency": null,
  • "currencyCommission": 0,
  • "manualAntifraudFixed": 0,
  • "mids": null,
  • "alertFees": [
    ]
}

Delete Thread

Delete a thread by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

The ID of the thread to delete

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthorized"
}

Periods

Operations with periods

Retrieve Periods

Get list of Periods

Authorizations:
ApiKeyAuth
query Parameters
dateFrom
string <date>
Example: dateFrom=2021-09-30

Filter periods starting from this date (YYYY-MM-DD)

dateTo
string <date>
Example: dateTo=2021-09-30

Filter periods ending before this date (YYYY-MM-DD)

type
integer
Enum: 1 2 4 8
Example: type=1

Period type:

  • 1 - Weekly period.
  • 2 - Half-monthly period.
  • 4 - Monthly period.
  • 8 - Half-weekly period.
unclosedByThread
integer

Thread ID to filter unclosed periods

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Period

Create a new Period

Authorizations:
ApiKeyAuth
header Parameters
X-Request-ID
required
string

Unique ID of request

Request Body schema: application/json
dateFrom
required
string <date>

Period start date

dateTo
required
string <date>

Period end date

type
required
integer
Enum: 1 2 4 8

Period type:

  • 1 - Weekly period.
  • 2 - Half-monthly period.
  • 4 - Monthly period.
  • 8 - Half-weekly period.

Responses

Request samples

Content type
application/json
{
  • "dateFrom": "2021-09-30",
  • "dateTo": "2021-10-06",
  • "type": 1
}

Response samples

Content type
application/json
{
  • "id": 1234567,
  • "type": 1,
  • "dateFrom": "2021-09-28",
  • "dateTo": "2021-10-04"
}

Retrieve a Period

Get details of a Period

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Period ID

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
{
  • "id": 1234567,
  • "type": 1,
  • "dateFrom": "2021-09-28",
  • "dateTo": "2021-10-04"
}

Update Period

Update an existing Period

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Period ID

header Parameters
X-Request-ID
required
string

Unique ID of request

Request Body schema: application/json
dateFrom
string <date>

Period start date

dateTo
string <date>

Period end date

type
integer
Enum: 1 2 4 8

Period type:

  • 1 - Weekly period.
  • 2 - Half-monthly period.
  • 4 - Monthly period.
  • 8 - Half-weekly period.

Responses

Request samples

Content type
application/json
{
  • "dateFrom": "2021-09-30",
  • "dateTo": "2021-10-06",
  • "type": 1
}

Response samples

Content type
application/json
{
  • "id": 1234567,
  • "type": 1,
  • "dateFrom": "2021-09-28",
  • "dateTo": "2021-10-04"
}

Delete Period

Delete a period by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Period ID

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthorized"
}

Discount Profiles

Operations with discount profiles

Retrieve Discount Profiles

Get a paginated list of Discount Profiles

Authorizations:
ApiKeyAuth
query Parameters
page
integer
Default: 1

Page number

limit
integer
Default: 100

Limit per page

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Add Discount Profile

Create a new Discount Profile

Authorizations:
ApiKeyAuth
header Parameters
X-Request-ID
required
string

Unique ID of request

Request Body schema: application/json
name
required
string

Profile name

repaidsDiscountRate
number >= 0

Repaids discount rate

Responses

Request samples

Content type
application/json
{
  • "name": "Default profile",
  • "repaidsDiscountRate": 5
}

Response samples

Content type
application/json
{
  • "id": 1234567,
  • "name": "Demo profile",
  • "repaidsDiscountRate": 0.1,
  • "rows": [
    ]
}

Retrieve a Discount Profile

Get details of a Discount Profile

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Discount Profile ID

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
{
  • "id": 1234567,
  • "name": "Demo profile",
  • "repaidsDiscountRate": 0.1,
  • "rows": [
    ]
}

Update Discount Profile

Update an existing Discount Profile

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Discount Profile ID

header Parameters
X-Request-ID
required
string

Unique ID of request

Request Body schema: application/json
name
required
string

Profile name

repaidsDiscountRate
number >= 0

Repaids discount rate

Responses

Request samples

Content type
application/json
{
  • "name": "Default profile",
  • "repaidsDiscountRate": 5
}

Response samples

Content type
application/json
{
  • "id": 1234567,
  • "name": "Demo profile",
  • "repaidsDiscountRate": 0.1,
  • "rows": [
    ]
}

Add Discount Profile Row

Add a new row to a discount profile

Authorizations:
ApiKeyAuth
header Parameters
X-Request-ID
required
string

Unique ID of request

Request Body schema: application/json
profileId
required
integer

Discount profile ID

periodType
required
integer
Enum: 1 2 4 8

Period type:

  • 1 - Weekly period.
  • 2 - Half-monthly period.
  • 4 - Monthly period.
  • 8 - Half-weekly period.
startSum
required
number >= 0

Start revenue sum

discountRate
required
number >= 0

Discount rate

Responses

Request samples

Content type
application/json
{
  • "profileId": 1,
  • "periodType": 1,
  • "startSum": 10000,
  • "discountRate": 0.1
}

Response samples

Content type
application/json
{
  • "message": "Bad Request",
  • "errors": {
    }
}

Delete Discount Profile Row

Delete a discount profile row by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Discount profile row ID

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthorized"
}

Adjustments

Operations with adjustments

Retrieve Adjustments

Get a paginated list of adjustments

Authorizations:
ApiKeyAuth
query Parameters
clientId
integer

Merchant ID

pm
string

Payment method

currency
string 3 characters

Currency ISO3 code

page
integer
Default: 1

Page number

limit
integer
Default: 100

Limit per page

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Add Adjustment

Create a new Adjustment

Authorizations:
ApiKeyAuth
header Parameters
X-Request-ID
required
string

Unique ID of request

Request Body schema: application/json
clientId
required
integer

Merchant ID

currency
required
string 3 characters

ISO3 currency code

pm
required
string

Payment method

metaAccType
string or null
Enum: "internal" "external"

Meta account type

comment
required
string

Description of adjustment

sum
required
number

Adjustment amount

Responses

Request samples

Content type
application/json
{
  • "clientId": 12345,
  • "currency": "USD",
  • "pm": "cc",
  • "metaAccType": null,
  • "comment": "Additional fee",
  • "sum": -25.34
}

Response samples

Content type
application/json
{
  • "id": 1234567,
  • "currency": "USD",
  • "pm": "sofortbanking",
  • "clientId": 12345,
  • "metaAccType": null,
  • "comment": "Additional fee",
  • "sum": -25.34
}

Retrieve an Adjustment

Get details of an adjustment by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Adjustment ID

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
{
  • "id": 1234567,
  • "currency": "USD",
  • "pm": "sofortbanking",
  • "clientId": 12345,
  • "metaAccType": null,
  • "comment": "Additional fee",
  • "sum": -25.34
}

Update Adjustment

Update an existing adjustment. All fields are optional.

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Adjustment ID

header Parameters
X-Request-ID
required
string

Unique ID of request

Request Body schema: application/json
clientId
integer

Merchant ID

currency
string 3 characters

ISO3 currency code

pm
string

Payment method

metaAccType
string or null
Enum: "internal" "external"

Meta account type

comment
string

Description of adjustment

sum
number

Adjustment amount

Responses

Request samples

Content type
application/json
{
  • "clientId": 12345,
  • "currency": "USD",
  • "pm": "cc",
  • "metaAccType": "internal",
  • "comment": "Updated fee",
  • "sum": -30
}

Response samples

Content type
application/json
{
  • "id": 1234567,
  • "currency": "USD",
  • "pm": "sofortbanking",
  • "clientId": 12345,
  • "metaAccType": null,
  • "comment": "Additional fee",
  • "sum": -25.34
}

Delete Adjustment

Delete an adjustment by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Adjustment ID

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthorized"
}

Payouts

Operations with payout summaries

Retrieve Payouts

Get a list of unpaid payout summaries grouped by client ID.

Authorizations:
ApiKeyAuth
query Parameters
clients
integer

Merchant ID

systems
Array of integers

List of System IDs

minPayout
integer >= 0

Minimum payout amount

periodType
integer >= 0
Enum: 1 2 4 8

Period type:

  • 1 - Weekly period.
  • 2 - Half-monthly period.
  • 4 - Monthly period.
  • 8 - Half-weekly period.
estimatedPayoutDateBefore
string <date>

Filter payouts with estimated date before this date (YYYY-MM-DD)

limit
integer >= 0

Limit of records

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
{
  • "12345": {
    }
}

Statements

Operations with statements

Retrieve Statements

Get a paginated list of statements

Authorizations:
ApiKeyAuth
query Parameters
client_id
integer

Merchant ID

month
string
Example: month=2025-11

Statement month (YYYY-MM)

currency
string 3 characters

Currency ISO3 code

payment_method
string

Payment method

page
integer
Default: 1

Page number

limit
integer
Default: 100

Limit per page

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Retrieve a Statement

Get details of a statement. Supports JSON and PDF response formats via Accept header.

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Statement ID

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
application/json
application/pdf
{
  • "id": 1,
  • "setting_id": 10,
  • "client_id": 12345,
  • "currency": "USD",
  • "payment_method": "cc",
  • "mid": null,
  • "date_from": "2025-11-01",
  • "date_to": "2025-11-30",
  • "sales_sum": 15000.75,
  • "sales_count": 200,
  • "declines_sum": 500,
  • "declines_count": 30,
  • "credits_sum": 1200.5,
  • "credits_count": 15,
  • "payouts_sum": 0,
  • "payouts_count": 0,
  • "chargebacks_sum": 50.25,
  • "chargebacks_count": 3,
  • "success_fee": 150,
  • "decline_fee": 30,
  • "credit_fee": 15,
  • "payout_fee": 0,
  • "chargeback_fine": 75,
  • "settlement_fee": 0,
  • "total_fees": 270,
  • "created_at": "2025-11-15T14:30:00+00:00"
}

Delete a Statement

Delete a statement by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Statement ID

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
{
  • "message": "Unauthorized"
}

Generate Statement

Generate a statement for a given setting and month. By default generates asynchronously (returns 204). Set sync=true for synchronous generation (returns 201 with the statement). Returns 409 if a statement already exists.

Authorizations:
ApiKeyAuth
header Parameters
X-Request-ID
required
string

Unique ID of request

Request Body schema: application/json
setting_id
required
integer

Statement setting ID

month
required
string

Statement month (YYYY-MM). Must not be in the future.

sync
boolean

Whether to generate synchronously (default false)

Responses

Request samples

Content type
application/json
{
  • "setting_id": 10,
  • "month": "2025-11",
  • "sync": false
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "setting_id": 10,
  • "client_id": 12345,
  • "currency": "USD",
  • "payment_method": "cc",
  • "mid": null,
  • "date_from": "2025-11-01",
  • "date_to": "2025-11-30",
  • "sales_sum": 15000.75,
  • "sales_count": 200,
  • "declines_sum": 500,
  • "declines_count": 30,
  • "credits_sum": 1200.5,
  • "credits_count": 15,
  • "payouts_sum": 0,
  • "payouts_count": 0,
  • "chargebacks_sum": 50.25,
  • "chargebacks_count": 3,
  • "success_fee": 150,
  • "decline_fee": 30,
  • "credit_fee": 15,
  • "payout_fee": 0,
  • "chargeback_fine": 75,
  • "settlement_fee": 0,
  • "total_fees": 270,
  • "created_at": "2025-11-15T14:30:00+00:00"
}

Statement Settings

Operations with statement settings

Create Statement Setting

Create a new statement setting

Authorizations:
ApiKeyAuth
header Parameters
X-Request-ID
required
string

Unique ID of request

Request Body schema: application/json
clientId
required
integer

Merchant ID

currency
required
string 3 characters

ISO3 currency code

feeCurrency
string or null 3 characters

Currency for fee calculations

paymentMethod
string or null

Payment method

mid
integer or null

MID

timezoneOffset
integer [ -12 .. 12 ]

Timezone offset in hours

discountProfileId
required
integer >= 0

Discount profile ID

successFeeFixed
number >= 0

Fixed fee per successful transaction

successFeePercent
number >= 0

Percentage fee per successful transaction

declineFeeFixed
number >= 0

Fixed fee per declined transaction

declineFeePercent
number >= 0

Percentage fee per declined transaction

creditFeeFixed
number >= 0

Fixed fee per credit transaction

creditFeePercent
number >= 0

Percentage fee per credit transaction

payoutFeeFixed
number >= 0

Fixed fee per payout

payoutFeePercent
number >= 0

Percentage fee per payout

chargebackFine
number >= 0

Fine per chargeback

settlementFee
number >= 0

Settlement fee

isEnabled
boolean

Whether this setting is enabled

Responses

Request samples

Content type
application/json
{
  • "clientId": 12345,
  • "currency": "USD",
  • "feeCurrency": null,
  • "paymentMethod": "cc",
  • "mid": null,
  • "timezoneOffset": 0,
  • "discountProfileId": 1,
  • "successFeeFixed": 0.1,
  • "successFeePercent": 3.5,
  • "declineFeeFixed": 0.05,
  • "declineFeePercent": 0,
  • "creditFeeFixed": 0.05,
  • "creditFeePercent": 0,
  • "payoutFeeFixed": 0,
  • "payoutFeePercent": 0,
  • "chargebackFine": 25,
  • "settlementFee": 0,
  • "isEnabled": true
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "clientId": 12345,
  • "currency": "USD",
  • "feeCurrency": null,
  • "paymentMethod": "cc",
  • "mid": null,
  • "timezoneOffset": 0,
  • "discountProfileId": 1,
  • "successFeeFixed": 0.1,
  • "successFeePercent": 3.5,
  • "declineFeeFixed": 0.05,
  • "declineFeePercent": 0,
  • "creditFeeFixed": 0.05,
  • "creditFeePercent": 0,
  • "payoutFeeFixed": 0,
  • "payoutFeePercent": 0,
  • "chargebackFine": 25,
  • "settlementFee": 0,
  • "isEnabled": true
}

Retrieve a Statement Setting

Get details of a statement setting by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Statement setting ID

header Parameters
X-Request-ID
required
string

Unique ID of request

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "clientId": 12345,
  • "currency": "USD",
  • "feeCurrency": null,
  • "paymentMethod": "cc",
  • "mid": null,
  • "timezoneOffset": 0,
  • "discountProfileId": 1,
  • "successFeeFixed": 0.1,
  • "successFeePercent": 3.5,
  • "declineFeeFixed": 0.05,
  • "declineFeePercent": 0,
  • "creditFeeFixed": 0.05,
  • "creditFeePercent": 0,
  • "payoutFeeFixed": 0,
  • "payoutFeePercent": 0,
  • "chargebackFine": 25,
  • "settlementFee": 0,
  • "isEnabled": true
}

Update Statement Setting

Update an existing statement setting. All fields are optional.

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer

Statement setting ID

header Parameters
X-Request-ID
required
string

Unique ID of request

Request Body schema: application/json
clientId
integer

Merchant ID

currency
string 3 characters

ISO3 currency code

feeCurrency
string or null 3 characters

Currency for fee calculations

paymentMethod
string or null

Payment method

mid
integer or null

MID

timezoneOffset
integer [ -12 .. 12 ]

Timezone offset in hours

discountProfileId
integer >= 0

Discount profile ID

successFeeFixed
number >= 0

Fixed fee per successful transaction

successFeePercent
number >= 0

Percentage fee per successful transaction

declineFeeFixed
number >= 0

Fixed fee per declined transaction

declineFeePercent
number >= 0

Percentage fee per declined transaction

creditFeeFixed
number >= 0

Fixed fee per credit transaction

creditFeePercent
number >= 0

Percentage fee per credit transaction

payoutFeeFixed
number >= 0

Fixed fee per payout

payoutFeePercent
number >= 0

Percentage fee per payout

chargebackFine
number >= 0

Fine per chargeback

settlementFee
number >= 0

Settlement fee

isEnabled
boolean

Whether this setting is enabled

Responses

Request samples

Content type
application/json
{
  • "clientId": 12345,
  • "currency": "USD",
  • "feeCurrency": null,
  • "paymentMethod": "cc",
  • "mid": null,
  • "timezoneOffset": 0,
  • "discountProfileId": 1,
  • "successFeeFixed": 0.1,
  • "successFeePercent": 3.5,
  • "declineFeeFixed": 0.05,
  • "declineFeePercent": 0,
  • "creditFeeFixed": 0.05,
  • "creditFeePercent": 0,
  • "payoutFeeFixed": 0,
  • "payoutFeePercent": 0,
  • "chargebackFine": 25,
  • "settlementFee": 0,
  • "isEnabled": true
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "clientId": 12345,
  • "currency": "USD",
  • "feeCurrency": null,
  • "paymentMethod": "cc",
  • "mid": null,
  • "timezoneOffset": 0,
  • "discountProfileId": 1,
  • "successFeeFixed": 0.1,
  • "successFeePercent": 3.5,
  • "declineFeeFixed": 0.05,
  • "declineFeePercent": 0,
  • "creditFeeFixed": 0.05,
  • "creditFeePercent": 0,
  • "payoutFeeFixed": 0,
  • "payoutFeePercent": 0,
  • "chargebackFine": 25,
  • "settlementFee": 0,
  • "isEnabled": true
}