Requests

Article Summary

Share feedback

Thanks for sharing your feedback!

CreateInvoice

CreateInvoice is a data request that registers an invoice with Credit Management in the Buckaroo Payment Engine.

A few parameters are mandatory. Most are optional, although the given scheme’s actions can impose additional requirements. For example, if a scheme can send e-mails, the Email group is required.

Note that the debtor-related parameters are grouped. The Person group handles personal information, the Address group handles address information, and so on. Groups are always either included or omitted.

A debtor is identified by its unique Debtor_Code, determined by the merchant. A new code registers a new debtor. An existing code with no further information uses the existing debtor as is. An existing code with additional information also updates (i.e. overwrites) any group that is given. E.g. if any parameters from the Address group are given, any previous address information is overwritten by the given group.

Each group should be included or omitted as a whole. If a group (e.g. Address) is given, except for some of its optional parameters (e.g. Address_HouseNumber), the missing parameters are considered empty.

For phone numbers, each type of phone (e.g. mobile, landline, or fax) is considered separately, as if it were a group of its own. Submitting a mobile phone number does not overwrite any existing landline phone number.

Example: Debtor_Code 1234 is already known, with Person, Address, and Phone_Landline information. A new request is made, using the same debtor code, accompanied by parameters Phone_Mobile, Address_Country, Address_City, Address_ZipCode, and Address_Street. The result is as follows: The Person and Phone_Landline data remains available, unchanged. The mobile phone number is added. The complete address is replaced by the new one. Note in particular that, because no state and no house number are given, these will indeed be empty in the new address, even if they were populated for the old address. (They are allowed to be empty because addresses exist that do not have them.)

Furthermore, if any contact detail was marked unreachable, re-submitting that information removes the mark, allowing the detail to be used again. For example, if a new e-mail address is submitted or the existing e-mail address is explicitly submitted again (rather than being omitted), then the merchant is instructing the use of that e-mail address. This is assumed to be a conscious decision (e.g. because the debtor has informed the merchant that the inbox is no longer full), and as such, the unreachable mark is removed.

Base JSON request

Use the base request as instructed on this page

Request

(CreateInvoice)

There is a certain amount of information needed to create an invoice. First off, you need to provide invoice related information, like the invoice amount, invoice date, scheme key, et cetera. Secondly, you need to provide a debtor. Debtor related information can be categorised 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.

Parameters

Service specific parameters

Parameter	Type	Required	Description
InvoiceAmount	decimal	yes	The amount of the invoice. Note: In case of a CreateCombinedInvoice request, the InvoiceAmount may deviate from the transaction amount, e.g. if additional transactions are to be added later, such as ExternalPayments.
InvoiceAmountVat	decimal		The VAT amount on the invoice.
InvoiceDate		yes	The invoice date. (yyyy-mm-dd)
DueDate		yes	The due date for the invoice. The schedule starts counting from this date. Important note: if combined with SEPA Direct Debit, the collect date should always precede the due date of the invoice, since you don't want to trigger a reminder step before debiting the customer. If however, the collect date is accidentally set after the due date, then the first reminder step will be postponed till the collect date, but only if it's set within 14 days after the due date. If it's set further than that, then our system will perform another check after 14 days and so on.
SchemeKey	String		The key of the scheme to use. Available keys are found in the Buckaroo Payment Plaza: Configuration > Credit Management.
MaxStepIndex	integer		If given, only this many scheme steps are taken, allowing the scheme to be cut short. (min: 1)
AllowedServices	string		Allowed payment methods (Comma-separated list of service codes) when using a pay link in Credit Management. This acts as a whitelist. Cannot be combined with DisallowedServices. The order in which the payment methods are listed also determines the order in which they are displayed to the customer on the Buckaroo checkout page. Default: all services are allowed.
DisallowedServices	string		Disallowed payment methods (Comma-separated list of service codes) when using a pay link in Credit Management. This acts as a blacklist. Cannot be combined with AllowedServices. Default: all services are allowed.
AllowedServicesAfterDueDate	string		Allowed payment methods (Comma-separated list of service codes) after the due date when using a pay link in Credit Management. This acts as a whitelist. Comma-separated. Cannot be combined with DisallowedServicesAfterDueDate. The order in which the payment methods are listed also determines the order in which they are displayed to the customer on the Buckaroo checkout page. Default: all services are allowed.
DisallowedServicesAfterDueDate	string		Disallowed payment methods (Comma-separated list of service codes) after the due date when using a pay link in Credit Management. This acts as a blacklist. Cannot be combined with AllowServicesAfterDueDate. Default: all services are allowed.
Code	string	Required	GroupType: Debtor. A unique code by which the merchant identifies the debtor. If the debtor with this code exists, any given components are overwritten.
Culture	string		GroupType: Person. The person’s culture code. May be specific, e.g. nl-NL, en-US, or non-specific, e.g. en. Required if person information is provided.
Title	string		GroupType: Person. The person’s title.
Initials	string		GroupType: Person. The person’s initials.
FirstName	string		GroupType: Person. The person’s first name.
LastNamePrefix	string		GroupType: Person. The person’s last name prefix, e.g. ‘van der’.
LastName	string		GroupType: Person. The person’s last name, excluding prefix. Required if person information is provided.
Gender	integer		GroupType: Person. The person’s gender. Possible values: 1, 2, 0, 9 (Male, female, unknown, not applicable. Default: 0).
BirthDate	date		GroupType: Person. The person’s date of birth (yyyy-mm-dd). Important: debtor has to be between 2 and 120 years old, in order to transfer his/her invoices to collection agency CIB.
PlaceOfBirth	string		GroupType: Person. The person’s place of birth.
Culture	string		GroupType: Company. The company’s culture code. May be specific, e.g. nl-NL, en-US, or non-specific, e.g. en. Required if company information is provided.
Name	string		GroupType: Company. The company’s name. Required if company information is provided.
VatApplicable	boolean		GroupType: Company. Whether VAT applies to the company.
VatNumber	string		GroupType: Company. The company’s VAT identification number.
ChamberOfCommerce	string		GroupType: Company. The company’s Chamber of Commerce registration number.
Street	string		GroupType: Address. The address’ street name. Required if address is given. Required if CM scheme has a collection agency step.
HouseNumber	integer		GroupType: Address. The address’ house number. Required if CM scheme has a collection agency step.
HouseNumberSuffix	string		GroupType: Address. The address’ house number suffix.
Zipcode	string		GroupType: Address. The address’ zip code. Required if address is given. Required if CM scheme has a collection agency step.
City	string		GroupType: Address. The address’ city. Required if address is given. Required if CM scheme has a collection agency step.
State			GroupType: Address. The address’ state or province.
Country	string		GroupType: Address. The address’ two-letter ISO country code, e.g. NL or US. Required if address is given. Required if CM scheme has a collection agency step.
Email	string		GroupType: Email. The e-mail address of the person or company.
Mobile	string		GroupType: Phone. The mobile phone number. Please note: this is the only number that can be used for SMS reminders. With regards to SMS reminders it is advised to send in the phone number formatted as either "+31612345678" or "0612345678", filtering out any dashes "-" and white spaces " ".
Landline	string		GroupType: Phone. The landline phone number.
Fax	string		GroupType: Phone. The fax number.
ApplyStartRecurrent	string		If True, every transaction via the Invoice paylink will have the property StartRecurrent = True.

Example request

{
   "Currency": "EUR",
   "Invoice": "testinvoice123r",
   "Services": {
      "ServiceList": [
         {
            "Name": "CreditManagement3",
            "Action": "CreateInvoice",
            "Parameters": [
               {
                  "Name": "ApplyStartRecurrent",
                  "Value": "False"
               },
               {
                  "Name": "InvoiceAmount",
                  "Value": "10.00"
               },
               {
                  "Name": "InvoiceAmountVAT",
                  "Value": "1.00"
               },
               {
                  "Name": "InvoiceDate",
                  "Value": "2017-09-22"
               },
               {
                  "Name": "DueDate",
                  "Value": "2018-12-23"
               },
               {
                  "Name": "SchemeKey",
                  "Value": "xxxx"
               },
               {
                  "Name": "MaxStepIndex",
                  "Value": "2"
               },
               {
                  "Name": "AllowedServices",
                  "Value": "ideal,mastercard"
               },
               {
                  "Name": "AllowedServicesAfterDueDate",
                  "Value": "ideal,mastercard"
               },
               {
                  "Name": "Code",
                  "GroupType": "Debtor",
                  "GroupID": "",
                  "Value": "johnsmith4"
               },
               {
                  "Name": "Email",
                  "GroupType": "Email",
                  "GroupID": "",
                  "Value": "youremail@example.nl"
               },
               {
                  "Name": "Culture",
                  "GroupType": "Person",
                  "GroupID": "",
                  "Value": "nl-NL"
               },
               {
                  "Name": "Title",
                  "GroupType": "Person",
                  "GroupID": "",
                  "Value": "Msc"
               },
               {
                  "Name": "Initials",
                  "GroupType": "Person",
                  "GroupID": "",
                  "Value": "JS"
               },
               {
                  "Name": "FirstName",
                  "GroupType": "Person",
                  "GroupID": "",
                  "Value": "John"
               },
               {
                  "Name": "LastNamePrefix",
                  "GroupType": "Person",
                  "GroupID": "",
                  "Value": "Jones"
               },
               {
                  "Name": "LastName",
                  "GroupType": "Person",
                  "GroupID": "",
                  "Value": "Smith"
               },
               {
                  "Name": "Gender",
                  "GroupType": "Person",
                  "GroupID": "",
                  "Value": "1"
               },
               {
                  "Name": "BirthDate",
                  "GroupType": "Person",
                  "GroupID": "",
                  "Value": "1990-01-01"
               },
               {
                  "Name": "PlaceOfBirth",
                  "GroupType": "Person",
                  "GroupID": "",
                  "Value": "Utrecht"
               },
               {
                  "Name": "Culture",
                  "GroupType": "Company",
                  "GroupID": "",
                  "Value": "nl-NL"
               },
               {
                  "Name": "Name",
                  "GroupType": "Company",
                  "GroupID": "",
                  "Value": "My Company Corporation"
               },
               {
                  "Name": "VatApplicable",
                  "GroupType": "Company",
                  "GroupID": "",
                  "Value": "true"
               },
               {
                  "Name": "VatNumber",
                  "GroupType": "Company",
                  "GroupID": "",
                  "Value": "NL140619562B01"
               },
               {
                  "Name": "ChamberOfCommerce",
                  "GroupType": "Company",
                  "GroupID": "",
                  "Value": "20091741"
               },
               {
                  "Name": "Street",
                  "GroupType": "Address",
                  "GroupID": "",
                  "Value": "Hoofdstraat"
               },
               {
                  "Name": "HouseNumber",
                  "GroupType": "Address",
                  "GroupID": "",
                  "Value": "90"
               },
               {
                  "Name": "HouseNumberSuffix",
                  "GroupType": "Address",
                  "GroupID": "",
                  "Value": "A"
               },
               {
                  "Name": "Zipcode",
                  "GroupType": "Address",
                  "GroupID": "",
                  "Value": "8441ER"
               },
               {
                  "Name": "City",
                  "GroupType": "Address",
                  "GroupID": "",
                  "Value": "Heerenveen"
               },
               {
                  "Name": "State",
                  "GroupType": "Address",
                  "GroupID": "",
                  "Value": "Friesland"
               },
               {
                  "Name": "Country",
                  "GroupType": "Address",
                  "GroupID": "",
                  "Value": "NL"
               },
               {
                  "Name": "Mobile",
                  "GroupType": "Phone",
                  "GroupID": "",
                  "Value": "06198765432"
               }
            ]
         }
      ]
   }
}

Response

(CreateInvoice)

Parameters

Parameter	Description
InvoiceKey	The unique key that was created to identify the invoice.
DebotGuid	Unique identifier of the debtor
InvoicePayLink	Pay link of the invoice

Example response

{
    "Key": "EAE77A1EDCCC479DA94325A4D245xxxx",
    "Status": {
        "Code": {
            "Code": 190,
            "Description": "Success"
        },
        "SubCode": {
            "Code": "S001",
            "Description": "Transaction successfully processed"
        },
        "DateTime": "2017-09-18T16:42:10"
    },
    "RequiredAction": null,
    "Services": [
        {
            "Name": "CreditManagement3",
            "Action": null,
            "Parameters": [
                {
                    "Name": "InvoiceKey",
                    "Value": "9C9D0305DE4A47178DE903FA91C1xxxx"
                },
                {
                    "Name": "DebtorGuid",
                    "Value": "xxxxxxxxxxxxxxxxxxxxxxxxxxx"
                },
                {
                    "Name": "InvoicePayLink",
                    "Value": "https://testcheckout.buckaroo.nl/html/?brq_paydirect_inv=xxxxxx"
                }
            ]
        }
    ],
    "CustomParameters": null,
    "AdditionalParameters": null,
    "RequestErrors": null,
    "ServiceCode": "CreditManagement3",
    "IsTest": true,
    "ConsumerMessage": null
}

Push

(CreateInvoice)

Parameters

Parameter	Description
InvoiceKey	The unique key identifying the invoice. Was also output from the request that originally created the invoice.
InvoiceNumber	The invoice number.
WebsiteKey	The unique key identifying the website that the invoice belongs to.
DebtorCode	The unique code identifying the debtor that the invoice is for.
SchemeKey	The key of the scheme that the invoice follows.
IsTest	Wether the invoice was a test or not
Type	The type of the invoice. Possible values: 1) RegularInvoice: the type of invoice that is normally used, 2) PartialInvoice: a partial invoice, such as those used in Payment Plans. Not applicable to most merchants, and can usually be ignored, 3) CreditNote: A credit note reducing the open amount of an existing invoice. The credit note also causes a financial change on the original invoice, which provides a clearer context. As such, the credit note push can usually be ignored.
Culture	The debtor’s culture, if available, or “en-US” otherwise.
InvoiceDate	The official date of the invoice.
DueDate	The date on which payment is due.
InvoiceStatusCode	The current status of the invoice. Possible Status codes are: 10: Active. The invoice follows its scheme, if applicable. 20: Paused. The invoice currently does proceed on its scheme. 21: PausedByDispute. Like Paused, but specifically caused by a manually registered dispute. 22: PausedByPaymentPlan. Like Paused, but specifically caused by a payment plan. This status can only be removed through termination of the payment plan. 23: PausedDueToValidation. The invoice is paused because one or more scheme actions could not be performed due to a validation error. 70: PendingTransferToCollectionAgency. The invoice is marked for transfer to the collection agency, in accordance with its scheme. 71: TransferredToCollectionAgency. The invoice is at the collection agency, and awaiting their response. 72: AcceptedByCollectionAgency. The collection agency has accepted the invoice and will work on it. 73: ProcessedByCollecionAgency. The collection agency has finished its work on the invoice. 74: ProcessedByCollectionAgencyIncomplete. The collection agency has finished its work on the invoice but did not manage to (fully) collect the invoice. 75: PendingRecall. The recall request has yet to be confirmed by the collection agency. 76: Recalled. Collection agency has confirmed the recall. 79: RefusedByCollectionAgency. The collection agency has not accepted the invoice. 80: WrittenOff. The invoice was manually written off by the merchant. 90: Rejected. The invoice was rejected, most likely because its request was invalid. It has never been active. 91: Cancelled. The invoice has been active, but is no longer. For example, this can happen to the partial invoices created by a payment plan (see CreatePaymentPlan) if they cease to apply. 99: Emergency. This invoice was manually disabled because of an emergency. Tech support is examining it. 0: NotSet. A technical error took place. This status should never occur.
PreviousStepIndex	The last step that was taken on the invoice’s scheme. E.g. 0 means no steps were taken, 1 means step 1 is the last step that was taken, and so on.
PreviousStepDateTime	The moment the previous step was taken. DateTimes are in Buckaroo’s local time zone, CE(S)T, in ISO-8601 format, as seen in the examples. Most systems support automatic interpretation and conversion of this representation.
Event	The name of the event that caused this push. 1) ChangedTransactionStatus: one of the invoice’s transactions changed status in a relevant way. Generally only a change to ‘successful’ is relevant, although there are exceptions, e.g. a Sepa Direct Debit moving to or away from ‘pending’ influences PendingSlowPaymentAmount, 2) ChangedStatus: the invoice changed status, e.g. to ‘active’ or ‘paused’. See below for options, 3) CreatedCreditNote: credit note was created on the invoice. Note that a push may be sent for the credit note itself, but the CreatedCreditNote event on the original invoice is the most relevant, 4) SentReminderMessage: a reminder was sent for the invoice, in accordance with its scheme, 5) SentBackupReminderMessage: a reminder was sent for the invoice using a backup method, in accordance with its scheme. E.g. the scheme may be set to send a letter if the e-mail cannot be delivered, 6) SkippedReminderBecauseNoMethodsRemain: a reminder action in the invoice’s scheme has failed to reach the debtor. This happens when all of the given communication methods bounce (e.g. incorrect e-mail address) or have been marked as unreachable by the merchant (e.g. through the Debtor screen in the Payment Plaza), 7) IncreasedAdminFee: the administration fee on the invoice has been increased, in accordance with the invoice’s scheme, 8) TransferredToCollectionAgency: the invoice has entered the collection agency process, in accordance with its scheme. Note that the ChangedStatus event provides more detailed updates as the invoice status changes throughout this process (transfer, acceptance, refusal, completion), 9) CreatedRecollect: a recollect was created for the invoice, in accordance with its scheme. This happens when Sepa Direct Debit recollection is active on the scheme, when the previous attempt fails and there is enough time for another attempt, 10) SentPaymentInvitationMessage: a payment invitation was sent for the invoice, in accordance with its scheme, 11) SentBackupPaymentInvitationMessage: A payment invitation was sent for the invoice using a backup method, in accordance with its scheme. E.g. the scheme may be set to send a letter if the e-mail cannot be delivered. 12) CmSchemeValidationError: One or more scheme actions could not be performed due to a validation error. 13) InvoicePausedDueToValidationErrors: The invoice is paused because one or more scheme actions could not be performed due to a validation error. This will only occur if 1) the payment invitation could not be performed, 2) not a single reminder message within a CM step could be performed or 3) the invoice could not be transferred to the collection agency.
EventCategory	The category the event belongs to. Possible values: 1) FinancialChange: any change that relates to the invoice’s amounts, including the initial invoice creation, transaction status changes, and credit notes, 2) ValidationError: A validation error occurred, 3) Other: anything else, e.g. a reminder being sent.
EventDateTime	The moment the event took place. Important, as earlier events should be ignored in case a later event has already been observed. See the section on “Order Of Events”. DateTimes are in Buckaroo’s local time zone, CE(S)T, in ISO-8601 format, as seen in the examples. Most systems support automatic interpretation and conversion of this representation.
EventParameters	Any number of additional pieces of data regarding the Event, as key-value pairs. E.g. the ChangedTransactionStatus event has a TransactionKey and a TransactionStatusCode parameter. Or the CmSchemeValidationError and InvoicePausedDueToValidationErrors events have the ValidationErrorMessage parameter. Note that ValidationErrorMessage parameters are always supplemented with an index number, because there can be multiple ValidationErrorMessages in one push message. So the first ValidationErrorMessage is always ValidationErrorMessage0, a second one ValidationErrorMessages1, third one ValidationErrorMessages2, and so on.
Currency	The invoice’s currency.
AmountDebit	An invoice’s amount. 0 for credit notes.
AmountCredit	A credit note’s amount. 0 except for credit notes.
AmountAdminCosts	The administration costs that have been added to the invoice so far, in accordance with its scheme.
AmountCreditNotes	The total amount that has been credited on the invoice, by means of credit notes.
AmountPaid	The total main amount that was paid on the invoice, i.e. excluding administration costs.
AmountAdminCostsPaid	The total amount of the administration costs that was paid on the invoice.
AmountPendingSlow	The total amount that could still come in from pending “slow” payment methods. At the time of writing, this only applies to pending Sepa Direct Debits and Collection Agency Payouts. The invoice may not be paid yet, but it could very well become so when the payment succeeds, so we may not want to contact the debtor unless the payment fails.
OpenAmount	The main amount that is yet to be paid on the invoice, i.e. excluding administration costs.
OpenAmountAdminCosts	The amount of the administration costs that is yet to be paid on the invoice.
OpenAmountInclAdminCosts	The amount that is yet to be paid on the invoice, including administration costs.
IsPaid	s the invoice fully paid? This is the same as OpenAmount being greater than 0. We do not take administration costs into consideration.
DebtorGuid	Unique identifier of the debtor
InvoicePayLink	Pay link of the invoice

Example push

{
   "Invoice": {
      "InvoiceKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "InvoiceNumber": "testinvoice_1614689513",
      "WebsiteKey": "0000",
      "DebtorCode": "JohnSmith12345",
      "DebtorGuid": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "SchemeKey": "xxxxx",
      "IsTest": true,
      "Type": "RegularInvoice",
      "Culture": "nl-NL",
      "InvoiceDate": "2021-03-02T00:00:00",
      "DueDate": "2021-03-02T00:00:00",
      "InvoiceStatusCode": 23,
      "PreviousStepIndex": 0,
      "PreviousStepDateTime": "2021-03-02T15:59:21",
      "InvoicePayLink": "http://testcheckout.local/html/?brq_paydirect_inv=xxxx",
      "Event": "InvoicePausedDueToValidationErrors",
      "EventCategory": "ValidationError",
      "EventDateTime": "2021-03-02T16:02:04.321891",
      "EventParameters": [
         {
            "Key": "ValidationErrorMessage0",
            "Value": "Required data Email missing."
         },
         {
            "Key": "ValidationErrorMessage1",
            "Value": "Required data MobilePhone missing."
         }
      ],
      "Currency": "EUR",
      "AmountDebit": 1,
      "AmountCredit": 0,
      "AmountAdminCosts": 0,
      "AmountCreditNotes": 0,
      "AmountPaid": 0,
      "AmountAdminCostsPaid": 0,
      "AmountPendingSlow": 0,
      "OpenAmount": 1,
      "OpenAmountAdminCosts": 0,
      "OpenAmountInclAdminCosts": 1,
      "IsPaid": false,
      "CustomParameters": [],
      "AdditionalParameters": []
   }
}

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.

Base JSON request

Use the base request as instructed on this page

Request

(CreateCombinedInvoice)
In this example, a Sepa Direct Debit is performed, combined with the CreateCombinedInvoice action of CreditManagement.

The requests consists of Sepadirectdebit parameters (for an explanation, see the Sepadirectdebit service section) and the CreateInvoice parameters (see previous call).

Parameters

Basic parameters

Parameter	Type	Required	Description
OriginalInvoiceNumber	String	Yes	The invoice number of the original invoice that the credit note applies to.
InvoiceDate	Date	Yes	The credit note date. (yyyy-mm-dd)
InvoiceAmount	Decimal	Yes	The amount credited by the credit note. Positive.
InvoiceAmountVat	Decimal		The VAT amount on the credit note. Positive. Must not exceed the original invoice VAT amount.
SendCreditNoteMessage	String		Any number of communication methods to use to inform the debtor of the credit note, comma-separated, in order of preference. Example: Email,SMS,Letter. If an e-mail address is available, it is used. Otherwise, SMS and letter are attempted in order.

Parameter	Type	GroupType	Description
AddressUnreachable	boolean	Address	The given address is marked as unreachable (true), or the mark is removed (false).
EmailUnreachable	boolean	Email	The given e-mail address is marked as unreachable (true), or the mark is removed (false).
MobileUnreachable	boolean	Phone	The given mobile phone number is marked as unreachable (true), or the mark is removed (false).
LandlineUnreachable	boolean	Phone	The given landline phone number is marked as unreachable (true), or the mark is removed (false).
FaxUnreachable	boolean	Phone	The given fax number is marked as unreachable (true), or the mark is removed (false).

Parameter	Type	Description	Required
IncludedInvoiceKey	String	comma separated list of involved invoice keys	Yes
DossierNumber	String	Number of the to be created dossier/file	Yes
InstallmentCount	Integer	number of installments	No
InstallmentAmount	Decimal	amount for each installement	No
InitialAmount	Decimal	amount for first installment	No
StartDate	Date	start date of the payment plan	Yes
Interval	String	interval between each installment	Yes
PaymentPlanCostAmount	Decimal	amount of payment plan cost	Yes
PaymentPlanCostAmountVat	Decimal	vat amount of payment plan cost	No
RecipientEmail	String	debtor email	Yes
AllowedServices	String	Allowed payment methods. Comma separated list of service codes	No

Parameter	Type	Description
DebtorFileGuid	string	Unique identifier of the Debtor File
DebtorFileNumber	string	Bank Transfer reference for the consumer to include in the Transfer's description. By providing the DebtorFileNumber, the transferred amount will be used fulfill the invoices in the Debtor File.
DebtorFilePaylink	string	Paylink to fulfill the Debtor File

Requests

CreateInvoice

Request

Parameters

Service specific parameters

Example request

Response

Parameters

Example response

Push

Parameters

Example push

CreateCombinedInvoice

Request

Parameters

Example request

Response

Parameters

Example response

Push

Parameters

Example push

CreateCreditNote

Request

Parameters

Example request

Response

Parameters

Example response:

Push

Parameters

AddOrUpdateDebtor

Request

Parameters

Example request

Response

Parameters

Example response:

CreatePaymentPlan

Request

Parameters

Example request

Response

Parameters

Example response:

Push

Parameters

Example push

TerminatePaymentPlan

Request

Parameters

Example request

Response

Parameters

Example response:

Push

Parameters

Example push:

PauseInvoice

Request

Parameters

Example request

Response

Parameters

Example response:

Push

Parameters

Example push

UnpauseInvoice

Request

Parameters

Example request

Response

Parameters

Example response

Push

Parameters

Example push

InvoiceInfo

Request