Request to Pay / "Smart Request" management for one-off payment requests — create and manage smart requests and their messages, Biller Delivery Request (BDR) links, extensions and withdrawals. 8 documented operations.
openapi: 3.0.1
info:
title: Single Payments
version: v1
servers:
- url: https://test.api.ordopay.com/smartrequestmanager/v1
paths:
/smartRequests/newSmartRequestBDRLink:
post:
tags:
- Ordo hosted
summary: Create a payment request with link
description: "Create a new payment request with a link.\r\nThis includes the creation of the payment\
\ request as well as returning a unique URL (bdRlink) for you to present to your customer."
operationId: PostSmartRequestBDRAsync
requestBody:
description: Smart Request message object.
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/NewBDRSmartRequestMessage'
example:
bdrRedirectURL: string
bdrCancelURL: string
bdrErrorURL: string
senderParticipantId: 0
recipientParticipantId: 0
billerParticipantId: 0
billerContactEmail: string
billerContactPhone: string
billerReference: string
billerAccountId: string
payerParticipantId: 0
payerAliasType: EMAIL
payerAliasValue: "Email : example@mail.com\r\nPhone : +countrycode 7712345678."
payerReference: string
amountDue: 0
amountCurrency: GBP
dueDate: '2017-07-21T17:32:28Z'
expiryDate: '2017-07-21T17:32:28Z'
partialPaymentAllowed: true
dueDateExtensionsAllowed: true
partialPaymentsRemaining: 0
attachmentBatchId: string
application/json:
schema:
$ref: '#/components/schemas/NewBDRSmartRequestMessage'
example:
bdrRedirectURL: string
bdrCancelURL: string
bdrErrorURL: string
senderParticipantId: 0
recipientParticipantId: 0
billerParticipantId: 0
billerContactEmail: string
billerContactPhone: string
billerReference: string
billerAccountId: string
payerParticipantId: 0
payerAliasType: EMAIL
payerAliasValue: "Email : example@mail.com\r\nPhone : +countrycode 7712345678."
payerReference: string
amountDue: 0
amountCurrency: GBP
dueDate: '2017-07-21T17:32:28Z'
expiryDate: '2017-07-21T17:32:28Z'
partialPaymentAllowed: true
dueDateExtensionsAllowed: true
partialPaymentsRemaining: 0
attachmentBatchId: string
text/json:
schema:
$ref: '#/components/schemas/NewBDRSmartRequestMessage'
example:
bdrRedirectURL: string
bdrCancelURL: string
bdrErrorURL: string
senderParticipantId: 0
recipientParticipantId: 0
billerParticipantId: 0
billerContactEmail: string
billerContactPhone: string
billerReference: string
billerAccountId: string
payerParticipantId: 0
payerAliasType: EMAIL
payerAliasValue: "Email : example@mail.com\r\nPhone : +countrycode 7712345678."
payerReference: string
amountDue: 0
amountCurrency: GBP
dueDate: '2017-07-21T17:32:28Z'
expiryDate: '2017-07-21T17:32:28Z'
partialPaymentAllowed: true
dueDateExtensionsAllowed: true
partialPaymentsRemaining: 0
attachmentBatchId: string
application/*+json:
schema:
$ref: '#/components/schemas/NewBDRSmartRequestMessage'
example:
bdrRedirectURL: string
bdrCancelURL: string
bdrErrorURL: string
senderParticipantId: 0
recipientParticipantId: 0
billerParticipantId: 0
billerContactEmail: string
billerContactPhone: string
billerReference: string
billerAccountId: string
payerParticipantId: 0
payerAliasType: EMAIL
payerAliasValue: "Email : example@mail.com\r\nPhone : +countrycode 7712345678."
payerReference: string
amountDue: 0
amountCurrency: GBP
dueDate: '2017-07-21T17:32:28Z'
expiryDate: '2017-07-21T17:32:28Z'
partialPaymentAllowed: true
dueDateExtensionsAllowed: true
partialPaymentsRemaining: 0
attachmentBatchId: string
responses:
'201':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/NewBDRSmartRequestResponse'
examples:
default:
value: null
application/json:
schema:
$ref: '#/components/schemas/NewBDRSmartRequestResponse'
example:
bdRlink: string
smartRequestId: string
creationDateTime: '2017-07-21T17:32:28Z'
status: BLOCKED
paymentStatus: FULLPAID
billerParticipantId: 0
billerContactEmail: string
billerContactPhone: string
billerReference: string
billerAccountId: string
payerParticipantId: 0
payerAliasType: EMAIL
payerAliasValue: "Email : example@mail.com\r\nPhone : +countrycode 7712345678."
payerReference: string
amountDue: 0
amountCurrency: GBP
dueDate: '2017-07-21T17:32:28Z'
expiryDate: '2017-07-21T17:32:28Z'
dueDateExtensionsAllowed: true
partialPaymentAllowed: true
partialPaymentsRemaining: 0
attachmentBatchId: string
text/json:
schema:
$ref: '#/components/schemas/NewBDRSmartRequestResponse'
example:
bdRlink: string
smartRequestId: string
creationDateTime: '2017-07-21T17:32:28Z'
status: BLOCKED
paymentStatus: FULLPAID
billerParticipantId: 0
billerContactEmail: string
billerContactPhone: string
billerReference: string
billerAccountId: string
payerParticipantId: 0
payerAliasType: EMAIL
payerAliasValue: "Email : example@mail.com\r\nPhone : +countrycode 7712345678."
payerReference: string
amountDue: 0
amountCurrency: GBP
dueDate: '2017-07-21T17:32:28Z'
expiryDate: '2017-07-21T17:32:28Z'
dueDateExtensionsAllowed: true
partialPaymentAllowed: true
partialPaymentsRemaining: 0
attachmentBatchId: string
refundAccountRequired: false
smartRequestUrls:
bdrRedirectURL: https://www.myLink.com?customerID=24
bdrCancelURL: https://www.myLink.com?customerID=24
bdrErrorURL: https://www.myLink.com?customerID=24
'400':
description: Bad Request
content:
text/plain: {}
application/json: {}
text/json: {}
'401':
description: Unauthorized
content:
text/plain:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
examples:
default:
value: null
application/json:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
example:
code: string
errors: {}
type: string
title: string
status: 0
detail: string
instance: string
text/json:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
example:
code: string
errors: {}
type: string
title: string
status: 0
detail: string
instance: string
'403':
description: Forbidden
content:
text/plain: {}
application/json: {}
text/json: {}
'404':
description: Not Found
content:
text/plain: {}
application/json: {}
text/json: {}
'422':
description: Client Error
content:
text/plain:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
examples:
default:
value: null
application/json:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
example:
code: string
errors: {}
type: string
title: string
status: 0
detail: string
instance: string
text/json:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
example:
code: string
errors: {}
type: string
title: string
status: 0
detail: string
instance: string
/smartRequests/{smartRequestId}:
get:
tags:
- Ordo hosted
summary: Get single payment request
description: Retrieve the details of a single specified payment request. Note - this information
is also available via a webhook notification.
operationId: GetSmartRequestAsync
parameters:
- name: smartRequestId
in: path
description: System generated unique identifier of the smart request.
required: true
schema:
type: string
- name: participantId
in: header
description: Format - int32. System generated unique identifier of the participant.
schema:
type: integer
format: int32
- name: payerAliasType
in: header
description: PayerAliasType.
schema:
type: string
- name: payerAliasValue
in: header
description: PayerAliasValue.
schema:
type: string
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/GetSmartRequestResponse'
examples:
default:
value: null
application/json:
schema:
$ref: '#/components/schemas/GetSmartRequestResponse'
example:
smartRequestId: string
threadId: string
creationDateTime: '2017-07-21T17:32:28Z'
status: BLOCKED
billerParticipantId: 0
billerApprovedName: string
billerContactEmail: string
billerContactPhone: string
billerReference: string
billerAccountId: string
billerAccountName: string
payerAliasType: EMAIL
payerAliasValue: "Email : example@mail.com. or\r\nPhone : +countrycode 7712345678."
payerParticipantId: 0
payerReference: string
payerLastAccessed: '2017-07-21T17:32:28Z'
billerLastAccessed: '2017-07-21T17:32:28Z'
amountDue: 0
amountCurrency: GBP
amountPaid: 0
paymentStatus: FULLPAID
dueDate: '2017-07-21T17:32:28Z'
dueDateExtensionsAllowed: true
expiryDate: '2017-07-21T17:32:28Z'
extensionDateRequested: true
requestedExtensionDate: '2017-07-21T17:32:28Z'
partialPaymentAllowed: true
partialPaymentsRemaining: 0
declineReasonCode: string
declineReasonText: string
withdrawReasonCode: string
withdrawReasonText: string
paymentInProgress: true
smartRequestMessages:
- smartRequestMessageId: string
senderParticipantId: 0
recipientParticipantId: 0
messageType: REQUESTTOPAY
messageDateTime: '2017-07-21T17:32:28Z'
messageBody: string
documentBatchId:
- string
text/json:
schema:
$ref: '#/components/schemas/GetSmartRequestResponse'
example:
smartRequestId: string
threadId: string
creationDateTime: '2017-07-21T17:32:28Z'
status: BLOCKED
billerParticipantId: 0
billerApprovedName: string
billerContactEmail: string
billerContactPhone: string
billerReference: string
billerAccountId: string
billerAccountName: string
payerAliasType: EMAIL
payerAliasValue: "Email : example@mail.com. or\r\nPhone : +countrycode 7712345678."
payerParticipantId: 0
payerReference: string
payerLastAccessed: '2017-07-21T17:32:28Z'
billerLastAccessed: '2017-07-21T17:32:28Z'
amountDue: 0
amountCurrency: GBP
amountPaid: 0
paymentStatus: FULLPAID
dueDate: '2017-07-21T17:32:28Z'
dueDateExtensionsAllowed: true
expiryDate: '2017-07-21T17:32:28Z'
extensionDateRequested: true
requestedExtensionDate: '2017-07-21T17:32:28Z'
partialPaymentAllowed: true
partialPaymentsRemaining: 0
declineReasonCode: string
declineReasonText: string
withdrawReasonCode: string
withdrawReasonText: string
paymentInProgress: true
smartRequestMessages:
- smartRequestMessageId: string
senderParticipantId: 0
recipientParticipantId: 0
messageType: REQUESTTOPAY
messageDateTime: '2017-07-21T17:32:28Z'
messageBody: string
documentBatchId:
- string
'400':
description: Bad Request
content:
text/plain: {}
application/json: {}
text/json: {}
'401':
description: Unauthorized
content:
text/plain:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
examples:
default:
value: null
application/json:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
example:
code: string
errors: {}
type: string
title: string
status: 0
detail: string
instance: string
text/json:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
example:
code: string
errors: {}
type: string
title: string
status: 0
detail: string
instance: string
'403':
description: Forbidden
content:
text/plain: {}
application/json: {}
text/json: {}
'404':
description: Not Found
content:
text/plain: {}
application/json: {}
text/json: {}
'422':
description: Client Error
content:
text/plain:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
examples:
default:
value: null
application/json:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
example:
code: string
errors: {}
type: string
title: string
status: 0
detail: string
instance: string
text/json:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
example:
code: string
errors: {}
type: string
title: string
status: 0
detail: string
instance: string
/smartRequests/smartRequestMessages:
get:
tags:
- Ordo hosted
summary: Get all payment requests
description: Retrieve the details of all payment requests for a specified biller participant id. Note
- this information is also available via a webhook notification per payment request.
operationId: GetSmartRequestsAsync
parameters:
- name: participantId
in: header
description: Format - int32. System generated unique identifier of the participant.
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/GetSmartRequestsResponse'
examples:
default:
value: null
application/json:
schema:
$ref: '#/components/schemas/GetSmartRequestsResponse'
example:
participantId: 0
smartRequestDetails:
- id: string
threadId: string
creationDateTime: string
updatedDateTime: '2017-07-21T17:32:28Z'
status: BLOCKED
billerParticipantId: 0
billerApprovedName: string
billerReference: string
billerAccountName: string
payerAliasType: EMAIL
payerAliasValue: "Email : example@mail.com. or\r\nPhone : +countrycode 7712345678."
payerParticipantId: 0
payerReference: string
amountDue: 0
amountCurrency: GBP
amountPaid: 0
paymentStatus: FULLPAID
dueDate: '2017-07-21T17:32:28Z'
extensionDateRequested: true
paymentInProgress: true
text/json:
schema:
$ref: '#/components/schemas/GetSmartRequestsResponse'
example:
participantId: 0
smartRequestDetails:
- id: string
threadId: string
creationDateTime: string
updatedDateTime: '2017-07-21T17:32:28Z'
status: BLOCKED
billerParticipantId: 0
billerApprovedName: string
billerReference: string
billerAccountName: string
payerAliasType: EMAIL
payerAliasValue: "Email : example@mail.com. or\r\nPhone : +countrycode 7712345678."
payerParticipantId: 0
payerReference: string
amountDue: 0
amountCurrency: GBP
amountPaid: 0
paymentStatus: FULLPAID
dueDate: '2017-07-21T17:32:28Z'
extensionDateRequested: true
paymentInProgress: true
'400':
description: Bad Request
content:
text/plain: {}
application/json: {}
text/json: {}
'401':
description: Unauthorized
content:
text/plain:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
examples:
default:
value: null
application/json:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
example:
code: string
errors: {}
type: string
title: string
status: 0
detail: string
instance: string
text/json:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
example:
code: string
errors: {}
type: string
title: string
status: 0
detail: string
instance: string
'403':
description: Forbidden
content:
text/plain: {}
application/json: {}
text/json: {}
'404':
description: Not Found
content:
text/plain: {}
application/json: {}
text/json: {}
'422':
description: Client Error
content:
text/plain:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
examples:
default:
value: null
application/json:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
example:
code: string
errors: {}
type: string
title: string
status: 0
detail: string
instance: string
text/json:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
example:
code: string
errors: {}
type: string
title: string
status: 0
detail: string
instance: string
/smartRequests/withdrawSmartRequestMessageBDR:
post:
tags:
- Ordo hosted
summary: Withdraw a biller delivered payment request
description: Withdraw a biller delivered payment request if it is no longer needed.
operationId: PostWithdrawSmartRequestBDRAsync
requestBody:
description: Withdraw smart request object.
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/WithdrawSmartRequestMessage'
example:
senderParticipantId: 0
recipientParticipantId: 0
payerAliasType: EMAIL
payerAliasValue: "Email : example@mail.com\r\nPhone : +countrycode 7712345678."
smartRequestId: string
messageType: REQUESTTOPAY
withdrawReasonCode: string
withdrawReasonText: string
application/json:
schema:
$ref: '#/components/schemas/WithdrawSmartRequestMessage'
example:
senderParticipantId: 0
recipientParticipantId: 0
payerAliasType: EMAIL
payerAliasValue: "Email : example@mail.com\r\nPhone : +countrycode 7712345678."
smartRequestId: string
messageType: REQUESTTOPAY
withdrawReasonCode: string
withdrawReasonText: string
text/json:
schema:
$ref: '#/components/schemas/WithdrawSmartRequestMessage'
example:
senderParticipantId: 0
recipientParticipantId: 0
payerAliasType: EMAIL
payerAliasValue: "Email : example@mail.com\r\nPhone : +countrycode 7712345678."
smartRequestId: string
messageType: REQUESTTOPAY
withdrawReasonCode: string
withdrawReasonText: string
application/*+json:
schema:
$ref: '#/components/schemas/WithdrawSmartRequestMessage'
example:
senderParticipantId: 0
recipientParticipantId: 0
payerAliasType: EMAIL
payerAliasValue: "Email : example@mail.com\r\nPhone : +countrycode 7712345678."
smartRequestId: string
messageType: REQUESTTOPAY
withdrawReasonCode: string
withdrawReasonText: string
responses:
'201':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/WithdrawSmartRequestMessageResponse'
examples:
default:
value: null
application/json:
schema:
$ref: '#/components/schemas/WithdrawSmartRequestMessageResponse'
example:
senderParticipantId: 0
recipientParticipantId: 0
payerAliasType: EMAIL
payerAliasValue: "Email : example@mail.com\r\nPhone : +countrycode 7712345678."
smartRequestId: string
messageType: REQUESTTOPAY
withdrawReasonCode: string
withdrawReasonText: string
text/json:
schema:
$ref: '#/components/schemas/WithdrawSmartRequestMessageResponse'
example:
senderParticipantId: 0
recipientParticipantId: 0
payerAliasType: EMAIL
payerAliasValue: "Email : example@mail.com\r\nPhone : +countrycode 7712345678."
smartRequestId: string
messageType: REQUESTTOPAY
withdrawReasonCode: string
withdrawReasonText: string
'400':
description: Bad Request
content:
text/plain: {}
application/json: {}
text/json: {}
'401':
description: Unauthorized
content:
text/plain:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
examples:
default:
value: null
application/json:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
example:
code: string
errors: {}
type: string
title: string
status: 0
detail: string
instance: string
text/json:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
example:
code: string
errors: {}
type: string
title: string
status: 0
detail: string
instance: string
'403':
description: Forbidden
content:
text/plain: {}
application/json: {}
text/json: {}
'404':
description: Not Found
content:
text/plain: {}
application/json: {}
text/json: {}
'422':
description: Client Error
content:
text/plain:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
examples:
default:
value: null
application/json:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
example:
code: string
errors: {}
type: string
title: string
status: 0
detail: string
instance: string
text/json:
schema:
$ref: '#/components/schemas/OrdoValidationProblemDetails'
example:
code: string
errors: {}
type: string
title: string
status: 0
detail: string
instance: string
/smartRequests/newSmartRequestMessage:
post:
tags:
- Ordo hosted
summary: Create a new payment request that Ordo sends
description: "Create a new payment request.\r\nThis includes the Ordo platform delivering the request\
\ for payment via email or SMS."
operationId: PostSmartRequestAsync
requestBody:
description: Smart Request message object.
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/NewSmartRequestMessage'
example:
senderParticipantId: 0
recipientParticipantId: 0
billerParticipantId: 0
billerContactEmail: string
billerContactPhone: string
billerReference: string
billerAccountId: string
payerParticipantId: 0
payerAliasType: EMAIL
payerAliasValue: "Email : example@mail.com\r\nPhone : +countrycode 7712345678."
payerReference: string
amountDue: 0
amountCurrency: GBP
dueDate: '2017-07-21T17:32:28Z'
expiryDate: '2017-07-21T17:32:28Z'
partialPaymentAllowed: true
dueDateExtensionsAllowed: true
partialPaymentsRemaining: 0
attachmentBatchId: string
application/json:
schema:
$ref: '#/components/schemas/NewSmartRequestMessage'
example:
senderParticipantId: 0
recipientParticipantId: 0
billerParticipantId: 0
billerContactEmail: string
billerContactPhone: string
billerReference: string
billerAccountId: string
payerParticipantId: 0
payerAliasType: EMAIL
payerAliasValue: "Email : example@mail.com\r\nPhone : +countrycode 7712345678."
payerReference: string
amountDue: 0
amountCurrency: GBP
dueDate: '2017-07-21T17:32:28Z'
expiryDate: '2017-07-21T17:32:28Z'
partialPaymentAllowed: true
dueDateExtensionsAllowed: true
partialPaymentsRemaining: 0
attachmentBatchId: string
text/json:
schema:
$ref: '#/components/schemas/NewSmartRequestMessage'
example:
senderParticipantId: 0
recipientParticipantId: 0
billerParticipantId: 0
billerContactEmail: string
billerContactPhone: string
billerReference: string
billerAccountId: string
payerParticipantId: 0
payerAliasType: EMAIL
payerAliasValue: "Email : example@mail.com\r\nPhone : +countrycode 7712345678."
payerReference: string
amountDue: 0
amountCurrency: GBP
dueDate: '2017-07-21T17:32:28Z'
expiryDate: '2017-07-21T17:32:28Z'
partialPaymentAllowed: true
dueDateExtensionsAllowed: true
partialPaymentsRemaining: 0
attachmentBatchId: string
application/*+json:
schema:
$ref: '#/components/schemas/NewSmartRequestMessage'
example:
senderParticipantId: 0
recipientParticipantId: 0
billerParticipantId: 0
billerContactEmail: string
billerContactPhone: string
# --- truncated at 32 KB (127 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ordo/refs/heads/main/openapi/ordo-smart-request-manager.yml