This section is exclusively available to Confirma Software partners.The endpoints described here require a partner-level API key with elevated privileges — standard creditor-level access tokens cannot be used to call these endpoints.Partner services provide the tooling needed to manage creditors programmatically within the Cash-In platform — from onboarding new creditors and maintaining their account details, to monitoring invoice delivery across all creditors in a partner's portfolio and communicating directly with debtors via SMS.If you are a Confirma Software partner and have not yet received your partner-level API key, contact deployment@cash-in.fi to request access..
Endpoints available to partners#
Endpoints available to partners
Creditor management#
Partners can create and maintain creditor accounts directly through the API, without requiring manual onboarding through Cash-In's deployment team.Registers a new creditor in the Cash-In platform. The payload includes the creditor's business details, contact persons, and service configuration.
On success, the creditor is provisioned and their API credentials are returned in the response.
Updates the account details of an existing creditor. Use this endpoint to keep creditor contact information, bank account details, or service settings current without requiring manual intervention from Cash-In.
Credential management#
Returns the current API credentials for a specified creditor. This is useful when a creditor's access token needs to be retrieved or verified programmatically — for example, when integrating new creditors into a partner's own platform or supporting a creditor whose token has been lost.
Returns the external agreement identifiers associated with a creditor. These identifiers are used to map the creditor's account in Cash-In to the corresponding records in a partner's own system, ensuring consistent reference across integrations.
Delivery monitoring#
Returns invoice delivery information scoped to a specific seller (creditor). Unlike the standard delivery endpoint available to individual creditors, this partner-level endpoint allows a single API call to retrieve delivery data on behalf of any creditor in the partner's portfolio — enabling centralised monitoring of invoice distribution across all managed accounts.
Debtor communication#
Sends an SMS message to a specified recipient. This endpoint is intended for debtor outreach — for example, sending payment reminders or case notifications directly to a debtor's mobile number as part of a collection workflow. Message delivery reports are available in the response.
