Jump to Content
PartnerAPI
API Reference
v2023-07-17

Log InPartnerAPI
API Reference
Log In
v2023-07-17API Reference

OVERVIEW

  • Getting Started
  • Managing your Account
  • About the API
    • Authentication
    • Idempotency
    • Versioning
    • Error Handling
    • Advanced
  • How-to Guides
    • Setting up an Organisation
    • Create and Pay a Pay Run
  • Webhooks

Payables API

  • Organisations
    • Get Organisation Bank Accountsget
    • Delete Organisation Bank Accountdel
    • Create Organisationpost
    • Update Organisationput
    • Offboard Organisationdel
    • Get Organisationget
    • Get Organisation by Partner Client IDget
    • Connectget
  • PayRun
    • Create pay runpost
    • Get pay runget
    • Cancel pay runpost
    • Checkoutget
  • Results
    • /get
  • Institution Codes
  • Roles
  • Statuses
  • Webhooks
    • Register webhookpost
    • List existing webhooks for Partnerget
    • Update webhookput
    • Delete existing webhookdel
Powered by 

Roles

Users

The following roles are accepted for users belonging to an organisation

  • Admin
  • Adviser
  • Standard

📘

Organisations need an active Admin

All Organisations require at least one active Admin user to be defined at the point of creation.

  • Table of Contents
    • Users