Requests
Handle all your Credit Management requests efficiently!
CreateInvoice:
Register an invoice with mandatory parameters like invoice amount, date, and debtor details. Optional parameters depend on your scheme’s actions.
More details on Parameters for CreateInvoice:
For more details on the parameters within the CreateInvoice Request, visit Troubleshooting for CreateInvoice
Request
Both invoice related as well as debtor related information is needed to create an invoice.
Debtor related info can be categorized into 6 groups:
- Debtor Group: This group has only one parameter, namely the debtor Code and contains all defining information about the debtor. This group (parameter) is always required.
- Person Group: Contains personal information about the debtor. Every debtor requires either a person, a company, or both.
- Company Group: Contains company information about the debtor. May be combined with a person.
- Address Group: Contains address information about the debtor.
- Email Group: Contains e-mail information about the debtor.
- Phone Group: Contains phone information about the debtor. Each phone type is treated as if it were a separate group, e.g. mobile phone data will only ever overwrite existing mobile phone data, but never existing landline phone data.
When providing a debtor related parameter, include the group type as well.
Tip
Make sure to include the group type when providing a debtor related parameter
Examples (Parameters and Samples)
CreateCombinedInvoice
CreateCombinedInvoice is a supplementary action on a transaction request. It functions exactly like CreateInvoice, with the notable difference that it creates the invoice side-by-side with the primary action’s transaction.
Example
An example of the CreateCombinedInvoice:Sample CreateCombinedInvoice
CreateCreditNote
CreateCreditNote is a data request that registers a credit note on an invoice in Buckaroo Credit Management. The credit note amount reduces the amount due on the original invoice.
The credit note may cover the full original invoice amount, or only part of it. Multiple credit notes are possible, so long as their sum does not exceed the original invoice amount.
Note how credit notes can cause an invoice to be considered paid, by reducing the amount due to 0.
A credit note does not result in a refund. Imagine creating a credit note on an invoice that was already fully paid. The invoice is now overpaid: the amount due is negative, since we have reduced the amount due to less than what we have received. In this scenario, the merchant may want to perform a refund. This requires a separate request.
Example
An example of the CreateCreditnote: Parameters and Sample CreateCreditNote
AddOrUpdateDebtor
AddOrUpdateDebtor is a data request that adds or updates debtor information in the Buckaroo Payment Engine. This is exactly like the debtor-related behavior or CreateInvoice, without creating an invoice. This allows the updating of debtor information at any time, and even in bulk, e.g. by using a batch file.
Additionally, AddOrUpdateDebtor allows marking or unmarking contact information as unreachable. Contact information can become marked unreachable by this request, from the Buckaroo Payment Plaza, or by communication failures such as mail bounces.
See CreateInvoice for further information.
Example
An example of the AddOrUpdateDebtor: Parameters and Sample AddOrUpdateDebtor
CreatePaymentPlan
When an invoice is overdue – perhaps even already approaching being transferred to the collection agency – you may want to give the debtor the chance to pay in several smaller installments. You might do this to protect the relationship, or to increase the odds of receiving what you are owed.
Example
The steps and an example for CreatePaymentPlan: Steps and Example CreatePaymentPlan
TerminatePaymentPlan
As discussed under CreatePaymentPlan, this request can be used to terminate an active payment plan. The payment plan stops immediately, and the originally included invoices get the ‘paused’ status. The payment plan’s partial invoices are cancelled. You should inform the debtor accordingly.
No further payments can be received on the partial invoices, although payments can now be received on the original invoices again. Any successful payments resulting from the payment plan remain valid, of course.
Example
An example of TerminatePaymentPlan: Example TerminatePaymentPlan
PauseInvoice
PauseInvoice can pause an invoice with the given invoice number.
Example
An example of PauseInvoice: Example PauseInvoice
UnpauseInvoice
With the UnpauseInvoice action you can resume a paused invoice with the given invoice number.
Example
An example of UnpauseInvoice: Example UnpauseInvoice
InvoiceInfo
Perform this call to retrieve info about one invoice
Example
An example of InvoiceInfo: Example InvoiceInfo
InvoiceInfo multiple invoices
Perform this call to retrieve info about multiple invoices. Extra invoices can be provided through the service parameter "InvoiceNumber". If an invoice number is provided through the basic field as well as through a service parameter, it's info will be returned only once in the reponse.
Example
An example of InvoiceInfo for multiple invoices: Example InvoiceceInfo multiple invoices
DebtorInfo
Perform this call to retrieve Debtor information.
Example
An example of DebtorInfo: Example DebtorInfo
AddOrUpdateProductLines
Perform this request to add or update product lines of an existing invoice. Besides an invoice key, product lines can be provided for the invoice specification.
Example
An example of AddOrUpdateProductLines: AddOrUpdateProductLines
Updated 9 days ago