Billing Requests-Billing Requests-Billing Request Examples

Number of APIs: 1

1. PayTo Mandate and Payment

POST {{url}}/billing_requests

PayTo is a new, efficient way to initiate real-time payments from customers’ bank accounts in Australia. GoCardless has implemented PayTo within Billing Requests to enable two key payments use cases:

1. Setting up an open mandate with your customer
2. Taking one-off real-time payments

A note on definitions: PayTo uses the term “agreement” to refer to the contract between the GoCardless customer and the end-customer. This concept matches that of the “mandate” so, for consistency, we use this term in the API and documentation instead. Please be aware that the terms are synonymous and that the end-customer will see the term “agreement” in the payment flow.

Constraints

• start_date - the date from which the consent will be valid. It will be shown to a payer to confirm and hence should be considered in the payer timezone. This date cannot be older than the date when the payer authorises the consent. Therefore if you want to specify it, make sure that it is not in the past and that the payer has enough time to complete the flow before the date will come.
• end_date - the date after which we will not be able to collect payments, as the consent stops being valid. It will be shown to a payer to confirm and hence should be considered in the payer timezone. This date cannot be in the past or older than the start date.
• max_amount_per_payment - maximum amount that can be charged for a single payment.
• periodic_limits - frequency configuration
  • period - repeating time frame presented as year, month, week or day.
  • max_total_amount - maximum total amount that can be charged for all payments in the period.
  • max_payments - maximum amount of payments that can be taken within a period
  • alignment - Specifies whether the period starts when the mandate is created or lines up with a calendar date. When the period alignment is calendar based, the first payment is pro-rated to the number of remaining days from the start of the period. By default, this is set to mandate creation_date.

See Billing Requests: PayTo Agreements and Payments for how-to’s, explanations and tutorials.

Create a Billing Request API Docs