Skip to main content
GET
Get deposit distribution

Authorizations

Authorization
string
header
required

Authentication with an API key can be done by using a bearer token in the Authorization header. This is done using the following format Authorization: Bearer {token}. API keys are issued and revoked directly from the creditor portal under Developers > API.

Path Parameters

tenantId
string<uuid>
required

Id of your debt collection partner's tenant. You can find it on the API page in the creditor portal.

billingId
string<uuid>
required

Id of the billing, from the billings.create webhook

Query Parameters

page
integer
default:0

Zero-based page number

Required range: x >= 0
pageSize
integer
default:25

Number of payments per page

Required range: 1 <= x <= 1000
includeDepositsWithSourceCreditor
boolean

Include the payments made directly to you. Without it, the commission charged on those payments is reported as a separate fee on the billing rather than as part of the distribution.

Response

Successful operation

meta
object
items
object[]