Jump to Content

Home Guides API Reference GraphQL Changelog

v1.0

API Reference

v1.0Home Guides API Reference GraphQL Changelog

All

Pages

Start typing to search…

API Endpoints

OpenAPI Specifications

Guidance

Security and authentication
Creating customers and accounts

B2B Operations API

PayID API
BPAY API
Stacks API
PayTo API
Transactions API
Scheduled Payments API
KYC API
Customers API
Direct Debits API
Merchant Category Codes API
- Get all Merchant Category Codesget
Liquidity API
Utilities API
Cards API
Tokens API
- Retrieve an elevation header to be used for GraphQL APIs that require step up accesspost
- Exchange External Token for a Shaype token to be used when calling our GraphQL APIspost
Products API
- Gets all productsget
Accounts API
Groups API
Holds API
- Get Authorisation Hold by IDget
FX API
NPP
- Check if a Branch Identifier is eligible for NPP paymentsget

Notification Webhooks

Notifications API

Authentication API

Security API
- Retrieve public keysget
Magic Link API
- Redirect Magic Link to Appget
- Request Magic Link emailpost
Token API
Logout API
- Log Out an Installationpost
- Demote an elevated Installationpost
Passcode API
Email Bypass API
- Request a VERIFY OTPpost
- Validate the VERIFY OTPget

External Authorisation API

External Auth API

Batch API

Batch API

Powered by

Check if a Branch Identifier is eligible for NPP payments

get

http://localhost:8080/v1/npp/eligibility/branch-identifiers/{branchIdentifier}

Language