Jump to Content
API Guide
v2024-06-30
v2025-01-31
Log In
API Guide
Log In
v2025-01-31
API Guide
📚 Glossary
All
Pages
Start typing to search…
JUMP TO
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 Organisation
post
🕵️
Get Organisation
get
✏️
Update Organisation
put
🗑️
Offboard Organisation
del
🚦
Organisation statuses
🔔
Organisation webhook events
Verifying an Organisation
📘 Verifying an organisation basics
🕵️♀️
Verifying an organisation
🖥️
Verification flow
post
🧪
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 Accounts
get
🔗
Connect
get
🏦
Get Bank Capabilities by ID
get
🏦
Get Bank Capabilities
get
🗑️
Delete Organisation Bank Account
del
Making Payments
📘
Make payments basics
🧾
Create pay run
post
📁
Get pay run
get
🛒
Checkout
post
❌
Cancel pay run
post
📄
Get Beneficiary Bank Account Fields
get
💱
Get indicative FX rate for currency conversion
get
📋
Get pay run reconciliation
get
🚦
Payment statuses
🔔
Payment webhooks
Webhooks
📘
Webhooks basics
🔑
Gets the public key for a webhook key id
get
🪝
Register webhook
post
📋
List existing webhooks for Partner
get
✏️
Update webhook
put
🗑️
Delete existing webhook
del
Migration Guides
🛠️
Migrate from v2024-06-30
Getting Started
Powered by
📚 Glossary
Ask AI
Learn the different words commonly used across our documentation
