Jump to Content

Home Guides API Reference

Guides API Reference

API Reference

Guides API Reference

Home Guides API Reference

Digital Platform - Card Management

/tenants/{tenantRef}/card-details
- Get card Detailspost
/tenants/{tenantRef}/card-status
- Update card statuspost
/tenants/{tenantRef}/fund-transfer-inquiry
- Validate whether card can be processed for transactionpost
/tenants/{tenantRef}/cards
- Create new card from existing cardpost

Alias Management

/tenants/{tenantRef}/merchant-alias/search
- Resolve Merchant Aliaspost
/{nodeType}/{nodeRef}/alias/{reference}
- Update Merchant Aliasput
- Delete Merchant Aliasdelete
/{nodeType}/{nodeRef}/alias
- Get all aliasget
- Create Merchant Aliaspost
/tenants/{tenantRef}/person-alias/{aliasRef}
- Update Person Aliasput
- Delete Person Aliasdelete
/tenants/{tenantRef}/person-alias
- Create Person Aliaspost
/tenants/{tenantRef}/person-alias/search/card
- Resolve Person Alias by Cardpost
/tenants/{tenantRef}/person-alias/search/alias
- Resolve Person Aliaspost

Reporting

/{nodeType}/{nodeRef}/invoices
- Get List of invoicesget
/{nodeType}/{nodeRef}/invoices/{invoiceRef}
- Get invoice detailsget
/{nodeType}/{merchantRef}/fraud-orders
- Get List of fraud override ordersget
/{nodeType}/{merchantRef}/fraud-orders/{orderRef}
- Get fraud order detailsget
/{nodeType}/{merchantRef}/reports
- Order Sales reportsget
/{nodeType}/{merchantRef}/reports/salesReports
- Order Sales reportsget
/{nodeType}/{merchantRef}/orders
- Get List of ordersget
/{nodeType}/{merchantRef}/orders/report
- Get orders report as jsonget
/{nodeType}/{merchantRef}/orders/{orderRef}
- Get order detailsget
/{nodeType}/{hierarchyRef}/payments
- Get List of Paymentsget
/{nodeType}/{hierarchyRef}/payments/{ref}
- Get Paymentget

Tenant operations

/tenants/{tenantRef}/merchants
- Onboard merchantspost
/tenants/{tenantRef}/details
- Get tenant detailsget

Transaction

/outlets/{outletId}/orders/{orderRef}/payments/{paymentRef}/fraud-override/REJECT
- Fraud override for existing paymentput
/outlets/{outletId}/orders/{orderRef}/payments/{paymentRef}/fraud-override/ACCEPT
- Fraud override for existing paymentput
/outlets/{outletId}/orders
- Create an orderpost
/outlets/{outletId}/orders/{ref}
- Retrieve order detailsget
/outlets/{outletId}/orders/{orderRef}/payments/{paymentRef}/card
- Accept Card for existing paymentput
/outlets/{outletId}/card/verify
- Verify cardput
/tenants/{tenantRef}/push-payments/{paymentRef}
- Retrieve payment detailsget
/{nodeType}/{nodeRef}/push-payments/{paymentRef}/refund
- Payment Refundpost
/tenants/{tenantRef}/push-payments
- Create a paymentpost
/push-payments/mids/{mid}/tids/{tid}/auth/{authCode}
- Retrieve payment details by mid, tid & auth codeget

Identity

/auth/access-token
- Generate access tokenpost

Asset Management

/{hierarchyType}/{hierarchyRef}/directories
- Get all directories for the hierarchyget
- Create Directorypost
/{hierarchyType}/{hierarchyRef}/directories/{reference}
/{hierarchyType}/{hierarchyRef}/directories/{directoryRef}/files/{reference}
/{hierarchyType}/{hierarchyRef}/directories/{directoryRef}/files
- Upload file to specified directorypost

Powered by

Digital Platform - Card Management

/tenants/{tenantRef}/card-details
- Get card Detailspost
/tenants/{tenantRef}/card-status
- Update card statuspost
/tenants/{tenantRef}/fund-transfer-inquiry
- Validate whether card can be processed for transactionpost
/tenants/{tenantRef}/cards
- Create new card from existing cardpost

Alias Management

/tenants/{tenantRef}/merchant-alias/search
- Resolve Merchant Aliaspost
/{nodeType}/{nodeRef}/alias/{reference}
- Update Merchant Aliasput
- Delete Merchant Aliasdelete
/{nodeType}/{nodeRef}/alias
- Get all aliasget
- Create Merchant Aliaspost
/tenants/{tenantRef}/person-alias/{aliasRef}
- Update Person Aliasput
- Delete Person Aliasdelete
/tenants/{tenantRef}/person-alias
- Create Person Aliaspost
/tenants/{tenantRef}/person-alias/search/card
- Resolve Person Alias by Cardpost
/tenants/{tenantRef}/person-alias/search/alias
- Resolve Person Aliaspost

Reporting

/{nodeType}/{nodeRef}/invoices
- Get List of invoicesget
/{nodeType}/{nodeRef}/invoices/{invoiceRef}
- Get invoice detailsget
/{nodeType}/{merchantRef}/fraud-orders
- Get List of fraud override ordersget
/{nodeType}/{merchantRef}/fraud-orders/{orderRef}
- Get fraud order detailsget
/{nodeType}/{merchantRef}/reports
- Order Sales reportsget
/{nodeType}/{merchantRef}/reports/salesReports
- Order Sales reportsget
/{nodeType}/{merchantRef}/orders
- Get List of ordersget
/{nodeType}/{merchantRef}/orders/report
- Get orders report as jsonget
/{nodeType}/{merchantRef}/orders/{orderRef}
- Get order detailsget
/{nodeType}/{hierarchyRef}/payments
- Get List of Paymentsget
/{nodeType}/{hierarchyRef}/payments/{ref}
- Get Paymentget

Tenant operations

/tenants/{tenantRef}/merchants
- Onboard merchantspost
/tenants/{tenantRef}/details
- Get tenant detailsget

Transaction

/outlets/{outletId}/orders/{orderRef}/payments/{paymentRef}/fraud-override/REJECT
- Fraud override for existing paymentput
/outlets/{outletId}/orders/{orderRef}/payments/{paymentRef}/fraud-override/ACCEPT
- Fraud override for existing paymentput
/outlets/{outletId}/orders
- Create an orderpost
/outlets/{outletId}/orders/{ref}
- Retrieve order detailsget
/outlets/{outletId}/orders/{orderRef}/payments/{paymentRef}/card
- Accept Card for existing paymentput
/outlets/{outletId}/card/verify
- Verify cardput
/tenants/{tenantRef}/push-payments/{paymentRef}
- Retrieve payment detailsget
/{nodeType}/{nodeRef}/push-payments/{paymentRef}/refund
- Payment Refundpost
/tenants/{tenantRef}/push-payments
- Create a paymentpost
/push-payments/mids/{mid}/tids/{tid}/auth/{authCode}
- Retrieve payment details by mid, tid & auth codeget

Identity

/auth/access-token
- Generate access tokenpost

Asset Management

/{hierarchyType}/{hierarchyRef}/directories
- Get all directories for the hierarchyget
- Create Directorypost
/{hierarchyType}/{hierarchyRef}/directories/{reference}
/{hierarchyType}/{hierarchyRef}/directories/{directoryRef}/files/{reference}
/{hierarchyType}/{hierarchyRef}/directories/{directoryRef}/files
- Upload file to specified directorypost

Powered by

Order Sales reports

get https://example.com/reporting/{nodeType}/{merchantRef}/reports/salesReports

Language

Credentials

Header

Click Try It! to start a request and see the response here!