Skip to main content

Trigger Future Invoice

POST 
/testing/send-invoices

Only available in sandbox

This endpoint can be called to trigger invoice generation and distribution with a specified cut off date in sandbox and can be used to test invoicing behaviour when integrating with the API. Normal invoicing rules will run and factor in:

  • merchant-specific rules for the invoicing date within the billing cycle
  • repayment account configuration rules for the due date
  • invoicing grouping keys (if any) for specific plans for the repayment account

The endpoint will trigger invoicing as if it is running on the specified cut off date. This means it will identify any instalments with an invoicing date between today and the given cut off date (inclusive) and generate invoices for those instalments according to the factors mentioned above.

As the invoicing process is asynchronous, there will be a short delay after hitting this endpoint before invoices are distributed. This delay will typically be 2 minutes.

Request​

Responses​

Successful Response