Jump to Content
Documentation
API Endpoints
v1.5.8
Log In
API Endpoints
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.5.8
Documentation
API Endpoints
Cancels a VRP mandate
Search
JUMP TO
Single Payments
Client hosted
Get institutions list
get
Initiate payment request
post
Create a payment request with link
post
Withdraw a payment request
post
Recurring payment mandates
Client hosted
Creates a new sweeping VRP Mandate
post
Gets a list of institutions
get
VRP Client hosted - Creates a domestic-vrp-consent at the ASPSP and returns the authorization URL.
post
Retrieves an existing VRP mandate
get
Gets all VRP mandates associated with a participant
get
Gets a VRP Transaction
get
Gets VRP Transactions for VRP Mandate and Participant combo
get
Execute a payment using a VRP Mandate
post
Cancels a VRP Mandate
post
Recurring payment mandates
Ordo hosted
Creates a new sweeping VRP mandate
post
Execute a payment using a VRP mandate
post
Cancels a VRP mandate
post
Retrieves an existing VRP mandate
get
Gets all VRP mandates associated with a participant
get
Gets a VRP transaction
get
Gets VRP transactions for VRP mandate and Participant combo
get
Refunds
Processing refunds
Get payer's account information for a refund
get
ACCOUNT DATA
Account Data - Client Hosted
Gets a list of AIS enabled institutions
get
Creates a new AIS request
post
Execute a data request using an AIS consent
post
Gets transaction data held in storage
get
Retrieves an existing AIS consent
get
Gets all AIS consents associated with a participant
get
Cancels an AIS Request
post
Gets a data request
get
Gets data requests for AIS consent and Participant
get
Creates an AIS consent at the bank, and returns the authorisation URL
post
Account Verification - Client Hosted
Creates a new AV request
post
Initiate an AV request
post
Gets a list of AV enabled institutions
get
Get an AV request
get
Gets all AV accounts for a participant
get
Get AV account data
get
ACCOUNT DATA
Account Data - Ordo Hosted
Creates a new AIS request
post
Execute a data request using an AIS consent
post
Gets transaction data held in storage
get
Retrieves an existing AIS consent
get
Gets all AIS consents associated with a participant
get
Cancels an AIS Request
post
Gets transaction data held in storage
get
Gets data requests for AIS consent and Participant
get
User management
Participant
Create a new participant
post
Retrieve participant details
get
Update participant details
put
Delete a Participant.
delete
Retrieve participants associated with a user
get
Bank account configuration
Bank accounts
Retrieve bank account information
get
Delete a bank account
delete
Update a bank account
put
Add a bank account
post
Retrieve bank account details
get
Get biller account id by bank account
get
Config
Webhooks
Creates a webhook for a user
post
Creates a webhook for a participant
post
Deletes a webhook for a user
delete
Deletes a webhook for a participant
delete
Retrieve the webhooks stored against a user
get
Retrieve the webhooks stored against a participant
get
Customisation Participant
Create customisations specific to a participant
post
Retrieve customisations specific to a participant
get
Delete customisations specific to a participant
delete
Documents
Managing documents
Upload documents to Ordo platform
post
Retrieve a document
get
Retrieve documents within a specified batch
get
Powered by
Cancels a VRP mandate
post
https://test.api.ordopay.com/obi/v1/CancelVRPMandate
Cancels a VRP mandate
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
RESPONSE
Click
Try It!
to start a request and see the response here!