Integration
Of Buckaroo Credit Management
Buckaroo Credit Management helps automate the registration and management of invoices through the Buckaroo Payment Engine. It provides a comprehensive system to handle unpaid invoices by sending reminders and, if necessary, transferring the invoice to a collection agency. The service also allows for generating various reports.
Integration Steps
- Registering an Invoice
- Invoices are registered in the Buckaroo Payment Engine. If an invoice remains unpaid past its due date, the system can automatically send reminders or escalate the invoice to a collection agency.
- Testing Credit Management
- By default, test invoices do not perform any Credit Management (CM) steps, including sending payment invitations. To test the CM flow, create an invoice with a description starting with "buckarooschema_test". Example:
buckaroo_schema_test_Invoice123
. - In Buckaroo Plaza, navigate to Credit Management -> Invoices, select your invoice, and trigger the next step by clicking Actions at the top right. Note: You need the Technical Administrator role for this.
- By default, test invoices do not perform any Credit Management (CM) steps, including sending payment invitations. To test the CM flow, create an invoice with a description starting with "buckarooschema_test". Example:
- Workflow
- General Flow: When an invoice’s due date expires, steps in its schedule are executed in order. Each step may involve sending a reminder or transferring the invoice to a collection agency.
- Reminders: Default and custom schedules/templates are available. Merchants can set the maximum number of steps for an invoice’s scheme, such as including or excluding the final transfer to a collection agency.
- Refunds & Credit Notes
- Creating an invoice indicates the debtor owes the merchant. A (partial) refund on a paid invoice reopens it, triggering reminders. To avoid this, create a credit note before issuing a refund.
- Additional Transactions
- Additional transactions can be added to an existing invoice using the same invoice number. This is useful for external payments or retrying failed transactions but not for creating payment plans.
- Credit Management Schemes
- Schemes: Define actions for invoices. Schemes are available under Credit Management -> CM scheme settings.
- Default Schemes: Predefined schemes like DefaultCM1 send reminders and may transfer the invoice to a collection agency. DefaultNone allows invoice creation without follow-up actions.
- Custom Schemes: Merchants can create custom schemes by duplicating existing ones and modifying them. Each scheme consists of steps with actions such as sending reminders or adding admin costs.
- Schema Actions
- Reminder: Sends a reminder to the debtor. Different communication methods (e.g., email, SMS) and fallback options are available.
- Admin Cost Increase: Adds admin costs to the invoice.
- Transfer to Collection Agency: Transfers the invoice to a selected or preferred collection agency.
- Threshold: Halts actions if the invoice amount is below a specified threshold.
- Payment Invitation: Sends a payment reminder on the invoice date.
- Stop Subscription: Stops the subscription associated with the invoice.
- Modifying Schemes: Changes only affect new invoices. Prior versions are retained for existing invoices.
- Templates
- Templates define the content of messages and can be customized for different communication methods. They are managed in the Template Editor under Configuration -> Templates.
- Tags: Used to make message content dynamic (e.g., debtor’s name, invoice amount).
- Invoice Push Notifications
- Push notifications are sent for invoice events (creation, reminders, payments, etc.). The system uses JSON format for these notifications.
- Invoice Push vs. Transaction Push: Invoice push provides a clear status of the invoice, reducing errors compared to transaction push.
- Order of Events: Use EventDateTime to handle pushes in the correct order.
- Service Codes and Actions
- Service Code:
CreditManagement3
- Actions Supported:
CreateInvoice
: Creates an invoice with Credit Management.CreateCombinedInvoice
: Creates an invoice with Credit Management and a primary service’s transaction.CreateCreditNote
: Creates a credit note for an invoice.AddOrUpdateDebtor
: Adds or updates debtor information.CreatePaymentPlan
: Sets up a payment plan for installments.TerminatePaymentPlan
: Ends a payment plan.PauseInvoice
: Pauses an invoice.UnpauseInvoice
: Resumes a paused invoice.
- Service Code:
API Endpoints
- Data Requests:
- Transaction Requests:
By following these guidelines, you can effectively integrate and utilize Buckaroo Credit Management for automated and efficient invoice and transaction management.
Updated 9 days ago