Jump to Content

API Guide

All

Pages

Start typing to search…

Getting Started

👋Welcome
⚡️Quickstart guide

About the API

📚 Glossary
🔐Authentication
👤Managing your account
⏯️Rate Limiting
🚩Error Handling
🔁Idempotency
🔢Versioning
🔔Webhooks
🔍Lookup values and codes

How to Guides

🏢Setting up an organisation
💰Create a pay run and check it out
💸International Payments
🤑Collecting Fees
🗯️Promotions
😵‍💫Payment Failure Insights
📕Purpose Codes
📂Beneficiary Bank Account Fields

Organisations

📘 Organisation basics
🏢Create Organisationpost
🕵️Get Organisationget
✏️Update Organisationput
🗑️Offboard Organisationdel
🚦Organisation statuses
🔔Organisation webhook events

Verifying an Organisation

📘 Verifying an organisation basics
🕵️‍♀️Verifying an organisation
🖥️Verification flowpost
🧪Testing the verify flow
🔔Verify statuses and webhooks

Bank Accounts

📘Bank account basics
⚡Quickstart: Connect a test bank account
🧪Connecting test banks
🏦Get Organisation Bank Accountsget
🔗Connectget
🏦Get Bank Capabilities by IDget
🏦Get Bank Capabilitiesget
🗑️Delete Organisation Bank Accountdel

Making Payments

📘Make payments basics
🧾Create pay runpost
📁Get pay runget
🛒Checkoutpost
❌Cancel pay runpost
📄Get Beneficiary Bank Account Fieldsget
💱Get indicative FX rate for currency conversionget
📋Get pay run reconciliationget
🚦Payment statuses
🔔Payment webhooks

Webhooks

📘Webhooks basics
🔑Gets the public key for a webhook key idget
🪝Register webhookpost
📋List existing webhooks for Partnerget
✏️Update webhook put
🗑️Delete existing webhookdel

Migration Guides

🛠️Migrate from v2024-06-30

Getting Started

Powered by

Rate Limiting

Learn about the API's rate limits