One API v1.0
On this page4 sections
Build with AI 6 packages
A build package is every page for one task, with the API operations they use. Copy the prompt into a coding assistant, or hand it the package itself: slim links to each page, full inlines all of them in one document.
- Take a paymentEverything needed to take a payment end to end with One API, from credentials through the hosted page to the webhook that confirms it, and the test cases that prove each outcome before you go live.
- Take a recurring paymentEverything needed to collect from a customer on a schedule with One API, from the consent the customer gives once through to each collection and the webhook that reports it.
- Migrate a payin from the Payments API to One APIEverything needed to move an existing redirect payin onto One API, with the legacy guide and its One API counterpart side by side.
Ozow OneAPI encompassing all REST API integrations possible with Ozow.
Servers
https://one.ozow.com/v1Productionhttps://stagingone.ozow.com/v1Staging
Authentication
Authenticationoauth2token URLhttps://one.ozow.com/v1/tokenpayments- Allows for all payment and transaction functionality, such as retrieving data and making payment requests.
payouts- Allows for all payout specific functionality.
refunds- Allows for initiating refunds and retrieving refund data.
settlements- Allows for retrieving settlement information.
subscriptions- Allows for creating and managing recurring payment subscriptions.
webhooks- Allows for management of webhook endpoints.
WebSocket
Some transactions complete over a socket instead of a redirect. A payment request that can use one returns a requiredActionOptions entry whose action is websocket, with the endpoint to connect to in its uri.
Operations
Authentication
Exchange your credentials for the token every other call is made with.
Bank account
Look up a bank, and check that an account exists and belongs to who you think.
Payments
Take a payment, from creating the request to following it to an outcome.
- GET Get Payment Methods
/paymentmethods - GET Get Regions
/regions - POST Request Payment
/payments - GET List Payments
/payments - GET Get Payment Status by Id
/payments/{id} - POST Cancel Payment Request
/payments/{id}/cancel - GET List Transactions for Payment
/payments/{id}/transactions - POST Request Transaction for Payment
/payments/{id}/transactions
Refunds
Return money from a completed payment, in full or in part.
Settlements
What Ozow has paid into your bank account, and the line items behind it.
Subscriptions
Recurring collections against a mandate the payer authorised once.
- POST Create Subscription
/subscriptions - GET List Subscriptions
/subscriptions - GET Get Subscription by Id
/subscriptions/{subscriptionId} - POST Create Subscription Transaction
/subscriptions/{subscriptionId}/transactions - GET List Subscription Transactions
/subscriptions/{subscriptionId}/transactions - POST Cancel Subscription
/subscriptions/{subscriptionId}/cancel
Transactions
What happened to a payment, looked up after the fact.
- POST Request Transaction
/transactions - GET List Transactions
/transactions - GET Get Transaction Status by Id
/transactions/{id} - POST Process Transaction Step
/transactions/{id} - POST Request Refund
/transactions/{id}/refunds - GET Get Refunds
/transactions/{id}/refunds - GET Get Transaction Notifications
/transactions/{id}/notifications - POST Resend Transaction Notifications
/transactions/{id}/notifications/resend
Webhooks management
Subscribe to events, and replay one your server missed.
- GET List Webhook Subscriptions
/webhooks - POST Create Webhook Subscription
/webhooks - GET Get Webhook Subscription
/webhooks/{id} - PUT Update Webhook Subscription
/webhooks/{id} - DELETE Delete Webhook Subscription
/webhooks/{id} - POST Replay Failed Messages
/webhooks/{id}/replay - GET Get Webhook Secret
/webhooks/{id}/secret