Steps and Example CreatePaymentPlan

Payment Plan Process:

1. Inclusion of Invoices:

   • One or more existing invoices of a single debtor are included.

2. Charging a Cost:

   • If you charge a cost for the payment plan, an additional invoice is created. This invoice number is based on the payment plan’s chosen dossier number.

3. Distribution of Amount:

   • The total open amount is divided into either a fixed number of installments or installments of a fixed amount. (The final installment may have a smaller amount to ensure the correct total.)

4. Setting Schedule:

   • Choose a start date and an interval (e.g., every month).

5. Debtor Notification:

   • The debtor is informed of the payment plan, including all partial payment dates and amounts. Refer to ‘Buckaroo Credit Management Payment Plan 1/5: Announcement’ in the Template Editor. (These templates can be edited as needed.)

6. Payment Invitations:

   • On each installment date, the debtor receives an email with a pay link. See ‘Buckaroo Credit Management – Payment Plan 2/5: Payment Invitation’ in the Template Editor.
   • By default, only iDEAL is enabled for this pay link. Contact Buckaroo to request additional payment methods.

7. Payment Reminders:

   • If an installment is not paid within 7 days, the debtor receives a reminder. Refer to ‘Buckaroo Credit Management – Payment Plan 3/5: Payment Reminder’ in the Template Editor.

8. Last Chance Notice:

   • If a reminder is ignored for another 3 days, the regular flow stops immediately. The debtor is given a last chance to pay the full remaining amount. See ‘Buckaroo Credit Management – Payment Plan 4/5: Last Chance’ in the Template Editor.

9. Cancellation of Plan:

   • If the last chance is ignored for 14 days, the payment plan is canceled and the debtor is informed. See ‘Buckaroo Credit Management – Payment Plan 5/5: Termination’. All included original invoices are transferred to their scheme’s ‘transfer to collection agency’ step or the end of their scheme if no such step exists. The invoices become active again, and if there is a collection agency, an invoice is immediately transferred.

Additional Information

• Creating Payment Plans:

  • Payment plans can be created through the CreatePaymentPlan request or from the Plaza’s invoice screen, directly on an invoice. The invoice screen will then show the payment plan tab for each of the included invoices.

• Early Termination:

  • Payment plans can be terminated early through the TerminatePaymentPlan request or from the payment plan tab. Original invoices will gain the ‘paused’ status (and can be manually resumed if desired). The debtor receives no notification of this termination, so you should inform them accordingly.

• Pausing Payment Plans:

  • Payment plans can be paused from the payment plan tab. This should only be used in emergencies, as it shifts upcoming partial payments further into the future, making initial announcement dates incorrect. This feature should be used in correspondence with the debtor.

• Invoice Requirements:

  • Included invoices must be live, active or paused, have an open amount, and a DueDate that does not lie in the future.
  • Invoices previously involved in a payment plan cannot be reused.

• Simulated Partial Invoices:

  • Upon creating the payment plan, a simulated partial invoice is created for each expected partial payment. These are used internally to facilitate the process and can be accessed in the payment plan tab via any original invoice. If you receive push notifications on invoices, you will receive them on partial invoices as well.

• Incoming Transactions:

  • Transactions on partial invoices are reflected on the originally included invoices in order of due date. This uses a special processing transaction type similar to the ‘External Payment’ transaction type, allowing you to track only the state of the originally included invoices.

• Refunding Payments:

  • To refund payments on the payment plan, find the appropriate payment on the partial invoice and refund the payment itself. The refund is done on the partial invoice, not its reflection on the original invoices. This distinction is evident from the transaction types. The partial invoice will have a transaction type like “iDEAL” (actual payment), while the original invoice will show a transaction type “Partial payment on payment plan” (reflection for administrative purposes). The refund will reflect on the original invoices, updating their paid amounts accordingly.

Request:

Parameters

For this request, the basic parameter "Description" is required.

Action Parameters:

Example Request

{
   "Description": "Payment in two intstallments",
   "Services": {
      "ServiceList": [
         {
            "Name": "CreditManagement3",
            "Action": "CreatePaymentPlan",
            "Parameters": [
               {
                  "Name": "IncludedInvoiceKey",
                  "Value": "20D09973FB5C4DBC9A33DB0F4F707xxx"
               },
               {
                  "Name": "DossierNumber",
                  "Value": "PaymentplanJohnsmith123"
               },
               {
                  "Name": "InstallmentCount",
                  "Value": "2"
               },
               {
                  "Name": "StartDate",
                  "Value": "2017-09-21"
               },
               {
                  "Name": "Interval",
                  "Value": "Day"
               },
               {
                  "Name": "PaymentPlanCostAmount",
                  "Value": "0.00"
               },
               {
                  "Name": "RecipientEmail",
                  "Value": "[email protected]"
               }
            ]
         }
      ]
   }
}

Response

Example Response

{
   "Key": "9E5E5D160C814C3D94DD9283978ABxxx",
   "Status": {
      "Code": {
         "Code": 190,
         "Description": "Success"
      },
      "SubCode": {
         "Code": "S001",
         "Description": "Transaction successfully processed"
      },
      "DateTime": "2017-09-19T16:59:00"
   },
   "RequiredAction": null,
   "Services": [
      {
         "Name": "CreditManagement3",
         "Action": null,
         "Parameters": [
                {
                    "Name": "InvoiceKey",
                    "Value": "F8F6D18XXXXXXXXXXXXXXXXXD7DC2AB4,0F10849XXXXXXXXXXXXXXXXXXFAC3F96"
                },
                {
                    "Name": "DebtorGuid",
                    "Value": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
                },
                {
                    "Name": "InvoicePayLink",
                    "Value": "https://testcheckout.buckaroo.nl/html/?brq_paydirect_inv=0F10849XXXXXXXXXXXXXXXXXXFAC3F96"
                }
            ]
        }
    ],
   "CustomParameters": null,
   "AdditionalParameters": null,
   "RequestErrors": null,
   "ServiceCode": "CreditManagement3",
   "IsTest": true,
   "ConsumerMessage": null
}

Push

Example Push

{
   "Invoice": {
      "InvoiceKey": "0F10849XXXXXXXXXXXXXXXXXXFAC3F96",
      "InvoiceNumber": "PaymentplanJohnsmith123-2",
      "WebsiteKey": "0000",
      "DebtorCode": "johnsmith4",
      "SchemeKey": "DefaultPP",
      "IsTest": false,
      "Type": "PartialInvoice",
      "Culture": "nl-NL",
      "InvoiceDate": "2017-09-19T00:00:00+02:00",
      "DueDate": "2017-09-22T00:00:00+02:00",
      "InvoiceStatusCode": 10,
      "PreviousStepIndex": 0,
      "PreviousStepDateTime": "0001-01-01T00:00:00+01:00",
      "Event": "ChangedStatus",
      "EventCategory": "FinancialChange",
      "EventDateTime": "2017-09-19T16:58:59.1374012+02:00",
      "EventParameters": [
         {
            "Key": "StatusCode",
            "Value": "10"
         }
      ],
      "Currency": "EUR",
      "AmountDebit": 0.01,
      "AmountCredit": 0,
      "AmountAdminCosts": 0,
      "AmountCreditNotes": 0,
      "AmountPaid": 0,
      "AmountAdminCostsPaid": 0,
      "AmountPendingSlow": 0,
      "OpenAmount": 0.01,
      "OpenAmountAdminCosts": 0,
      "OpenAmountInclAdminCosts": 0.01,
      "IsPaid": false,
      "CustomParameters": [],
      "AdditionalParameters": []
   }
}