Jump to Content
API Guide
v2024-06-30
v2025-01-31
Log In
API Guide
Log In
v2025-01-31
API Guide
Lookup values and codes
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Β
Lookup values and codes
Ask AI
Learn about the different values and codes used in the API
