Ordo hosted - Creating an single payment

Prerequisites

Having gone through the Get Started guide, you should now have the following information to allow you to create a payment request:

• subscription_key - The key used to access the Ordo API Management gateway.
• client_id - Unique string identifying your application.
• client_secret - Secret key used to authenticate your application with our platform.
• billerParticipantId - which is your unique ID within Ordo.
• billerAccountId - unique proxy of your account details for where payments will be received into.

If you do not have the above information, please go to See here for how to get started

Before you're able to make a request for payment, your mock bank account must have been added by Ordo to your staging web profile.

This can be checked by logging in and navigating to Billing Accounts on the navigation panel on the left. See below for an example of what you should see. If a bank account has not been added, please contact support.

By this point you should also have received an email containing your billerParticipantId and billerAccountId which are required fields when creating a payment request. If you have not received these values yet, please contact support.

Creating your first payment request

You can create a request for payment using Ordo that will contain a link in the response which you can present to your end customers to make the payment directly into your bank account.

See below for an example request including headers and body to create a payment request.

POST
https://test.api.ordopay.com/smartrequestmanager/v1/smartRequests/newSmartRequestBDRLink
HTTP/1.1

Headers:
{
  Authorization: Bearer {access_token},
  "Ocp-Apim-Subscription-Key": {subscription_key},
  "content-type": "application/json"
}

JSON Body:
{
  "senderParticipantId": 1234,
  "billerParticipantId": 1234,
  "billerReference": "EXAMPLE REFERENCE",
  "billerAccountId": "d91439d3-3855-494c-a096-6734f822af2f",
  "payerAliasType": "EMAIL",
  "payerAliasValue": "[email protected]",
  "payerReference": "EXAMPLE REFERENCE",
  "amountDue": 10.50,
  "dueDate": "2022-10-19T07:51:52+00:00",
  "partialPaymentAllowed": false,
  "dueDateExtensionsAllowed": false,
  "attachmentBatchId": "",
  "amountCurrency": "GBP",
  "partialPaymentsRemaining": 0,
  "expiryDate": "2022-10-20T07:51:52+00:00",
  "bdrRedirectURL": "https://example.com/redirectUrl",
  "bdrCancelURL": "https://example.com/cancelUrl",
  "bdrErrorURL": "https://example.com/errorUrl",
  "refundAccountRequired": true
}

Successful response:

{
  "bdRlink": "https://rfpdevwebportal.azurewebsites.net/2dGhIcjmTnK",
  "smartRequestId": "95a43002-5ba3-44a7-a4e1-cbd50bf5cb70",
  "creationDateTime": "2022-10-19T10:36:05",
  "status": "PENDING",
  "paymentStatus": "UNPAID",
  "billerParticipantId": 1234,
  "billerContactEmail": null,
  "billerContactPhone": null,
  "billerReference": "EXAMPLE REFERENCE",
  "billerAccountId": "d91439d3-3855-494c-a096-6734f822af2f",
  "payerParticipantId": null,
  "payerAliasType": "EMAIL",
  "payerAliasValue": "[email protected]",
  "payerReference": "EXAMPLE REFERENCE",
  "amountDue": 10.50,
  "amountCurrency": "GBP",
  "dueDate": "2022-10-19T07:51:52+00:00",
  "expiryDate": "2022-10-20T07:51:52+00:00",
  "dueDateExtensionsAllowed": false,
  "partialPaymentAllowed": false,
  "partialPaymentsRemaining": 0,
  "attachmentBatchId": "",
  "refundAccountRequired": true,
  "smartRequestUrls": {
     "bdrRedirectURL": "https://example.com/redirectUrl?srID=95a43002-5ba3-44a7-a4e1-cbd50bf55cb70",
     "bdrCancelURL": "https://example.com/cancelUrl?srID=95a43002-5ba3-44a7-a4e1-cbd50bf55cb70",
     "bdrErrorURL": "https://example.com/errorUrl?srID=95a43002-5ba3-44a7-a4e1-cbd50bf55cb70"
  }
}

If the POST was successful, the response will contain a bdRlink property. This URL is unique to this payment request and can be served to your end customers however you choose. For testing purposes on our staging environment, navigating to the URL for bdRlink will begin our Quick Checkout flow and allow you to complete a test payment on our staging environment.

For a walk through on making a test payment, see [Making payments](doc:Paying a payment request).

🚧

Note

The URLs for Production and Staging environments are similar, below you will find the correct URLs to use for each environments (http://test its http://live).

Environment	Request	URL
Staging	OrdoTokenRequestUrl	https://test.identity.ordopay.com/connect/token
Staging	OrdoPaymentRequestUrl	https://test.api.ordopay.com/smartrequestmanager/v1/smartRequests/newSmartRequestBDRLink
Production	OrdoTokenRequestUrl	http://live.identity.ordopay.com/connect/token
Production	OrdoPaymentRequestUrl	https://live.api.ordopay.com/smartrequestmanager/v1/smartRequests/newSmartRequestBDRLink