Single payments - deeper dive

Now that you can create a single payment there is a wide range of other payment API you can utilise.

Create a new BDR SmartRequest

Designed for billers who want to manage the presentment of the payment request to their customer themselves. Ordo returns a URL unique to each payment request, which you present to your customer by whatever medium you want. This is the API explained in Creating a single payment request

📘

Scope - smartrequests

Refer to the API reference for further information on creating a new BDR SmartRequest

Withdraw a SmartRequest

Withdrawing a payment request is a biller action that prohibits the Payer from paying or declining the payment request they have received. As part of the Biller Delivery API, you can also set the expiry date of the payment request to any time/date beyond the creation time/date, with no further action available to the Payer after that time/date. Note; if you have attached any documents to a payment request, withdrawing the payment request stops the Payer from viewing or downloading the documents.

📘

Refer to the API reference for further information on withdrawing payment request

Upload document in payment request platform

Attachments may also be associated and sent with the payment request. When presented to the Payer these can be viewed and downloaded. If a Biller withdraws a payment request, then the link to the attachments becomes unusable, ensuring that the recipient can no longer view or download the attachments.

📘

Scope - document

Refer to the API reference for further information on uploading a document to a payment request

Other APIs to support edge-cases

Create a new smart request - 'send via Ordo'

This includes the Ordo platform delivering the request for payment to the payer via email or SMS, using Ordo's own branding. This option is primarily for those Billers who do not have their own delivery mechanism to send payment requests to their customers.

📘

Scope - smartrequests

Refer to the API reference for further information on creating a new smart request via Ordo

Withdraw a SmartRequest - 'send via Ordo'

Withdrawing a payment request is a biller action that prohibits the Payer from paying or declining the payment request they have received. As part of the Biller Delivery API, you can also set the expiry date of the payment request to any time/date beyond the creation time/date, with no further action available to the Payer after that time/date. Note; if you have attached any documents to a payment request, withdrawing the payment request stops the Payer from viewing or downloading the documents.

📘

Scope - smartrequests

Refer to the API reference for further information on withdrawing a SmartRequest via Ordo

Agree an extension request

Allows an extension to the due date for a smart request when asked for by the payer. Note, this is only relevant if you chose to allow extension requests when creating smart requests sent via Ordo.

📘

Scope - smartrequests

Refer to the API reference for further information on agreeing an extension request

Decline an extension request

Decline a customer's request for an extension to the due date of a smart request. Note, this is only relevant if you chose to allow extension requests when creating send via Ordo requests.

📘

Scope - smartrequests

Refer to the API reference for further information on declining an extension request

Requesting Part Payments

If your use case caters for payers making partial payments, you can enable 'part payment' when creating a payment request. Doing this means the payer can make up to 5 part payments; the amount of each one being determined by the payer.

📘

Scope - smartrequests