Jump to Content
Home
Guides
API Reference
GraphQL
Changelog
v1.0
Log In
API Reference
Log In
v1.0
Home
Guides
API Reference
GraphQL
Changelog
GraphQL with external authentication
All
Pages
Start typing to search…
JUMP TO
API Endpoints
OpenAPI Specifications
Guidance
Security and authentication
B2B Rest API
GraphQL with external authentication
GraphQL with Shaype authentication
Communications API (Webhooks)
Creating customers and accounts
B2B Operations API
PayID API
Get PayID details
get
Check PayID availability
get
Get PayID de-register history
get
Update PayID details
post
Resolve PayID to bank account
get
Update PayID status
patch
Get PayIDs by Account ID
get
Register PayID
post
BPAY API
BPAY billers for account
get
Create BPAY Biller for Account ID
post
Initiate BPAY payment
post
Validate BPAY
post
Retrieve BPAY Biller
get
Update BPAY Biller
patch
Stacks API
Get all Stacks by Account ID
get
Create new stack
post
Get all Stack Transactions by Account ID
get
Transfer funds from Stack to Stack of an Account
post
Update Stack
put
Close Stack
post
Get all Stack Transactions by Stack ID
get
Transfer funds from Account to Stack
post
Transfer funds from Stack to Account
post
PayTo API
Returns all Mandate IDs for a Shaype Account ID.
get
Create Mandate
post
Amend Mandate by Initiator
put
Get Mandate Actions by Initiator
get
Cancel Mandate by Initiator
patch
Get Payment instruction status by Mandate ID and Payment instruction ID
get
Amend Mandate payment terms
patch
Set amount of Scheduled Payment Initiation Request by Initiator
patch
Release Mandate by Initiator
patch
Resolve Mandate by Initiator
patch
Search payments instructions by Mandate ID
get
Suspend Mandate by Initiator
patch
Get Mandates by debtor account numbers
get
Get Mandate by ID
get
Amend Mandate by Payer
put
Get Mandate Actions by Payer
get
Cancel Mandate by Payer
patch
Release Mandate by Payer
patch
Resolve Mandate pending action by Payer
patch
Suspend Mandate by Payer
patch
Make Adhoc Payment
post
Check if BSB supports PayTo
get
Transactions API
Create Credit Transaction for Account (DEPRECATED)
post
Create Debit Transaction for Account (DEPRECATED)
post
Search Transactions
post
Create Credit Transaction for Account
post
Create Debit Transaction for Account
post
Get Transaction by ID
get
Get Tags for Transaction
get
Modify Tags for a Transaction
post
Scheduled Payments API
Get Scheduled Payments by Account ID
get
Get Scheduled Payment by Payment ID for an Account
get
Cancel Scheduled Payment
post
KYC API
Create new identity verification case and first submission
post
Approve AML Check
post
Approve Document Check
post
Approve Sanctions Check
post
Customers API
Get all Customers
get
Create Customer
post
Search Customers
post
Create Account for Customer - (To be DEPRECATED - Use POST /v1/accounts instead)
post
Get Account by Customer ID
get
Get Cards by Customer ID
get
Get Customer by ID
get
Update Customer details
patch
Block Customer
post
Update Customer status
patch
Unblock Customer
post
Direct Debits API
Get outbound Direct Debits by date
get
Create outbound Direct Debit (Deprecated)
post
Get outbound Direct Debit by ID
get
Get outbound Direct Debits by date
get
Create outbound Direct Debit
post
Get outbound Direct Debit by ID
get
Merchant Category Codes API
Get all Merchant Category Codes
get
Liquidity API
Get client Liquidity
get
Get all liquidity alerting Thresholds
get
Create liquidity alerting Threshold
post
Update liquidity alerting Threshold
put
Utilities API
Create stub for search payment instructions for a mandate.
post
Trigger mock ATM card transaction
post
Trigger mock card Hold
post
Trigger mock card Hold and Settlement
post
Generate mock inbound DE request.
post
Generate mock NPP inbound transaction v2.
post
Generate mock Mandate notification for Initiator.
post
Generate mock Mandate notification for Payer.
post
Generate mock NPP inbound transaction.
post
Generate mock Receive A Payment Instruction (RAPAIN).
post
Cards API
Create Card for Customer
post
Get Card by ID
get
Activate Card
post
Block Card
post
Cancel Card
post
Convert Card
post
Get wallets by Card ID
get
Get provisioning data by Card ID
get
Get preferences by Card ID
get
Update Card preferences
patch
Change Card PIN
put
Get Card PIN status
get
Unblock Card PIN
post
Replace Card
post
Renew Card
post
Enrol card to rewards
post
Unblock Card
post
Tokens API
Retrieve an elevation header to be used for GraphQL APIs that require step up access
post
Exchange External Token for a Shaype token to be used when calling our GraphQL APIs
post
Products API
Gets all products
get
Accounts API
Get Account by ID
get
Block Account and Customer
post
Get all Cards by Account ID
get
Closes an account
post
Get all Authorisation Holds by Account ID
get
Update Account max balance
patch
Update Account overdraft limit
patch
Get Risk Level by Account ID
get
Update Account Risk Level
patch
Initiate Cash Transfer (DEPRECATED)
post
Unblock Account
post
Creates an Account
post
Search accounts
post
Delete Custom Data from Account
del
Create Custom Data for Account
post
Get all limits by Account ID
get
Delete limit from Account
del
Set limit for Account
put
Get all Rules by Account ID
get
Create Rule for Account
post
Delete Rule from Account
del
Get Rule for Account by Rule ID
get
Initiate Cash Transfer
post
Groups API
Create Group
post
Get Account by Group ID
get
Update Group details
patch
Create Account for Group - (To be DEPRECATED - Use POST /v1/accounts instead)
post
Add Customers to Group
post
Remove a Customer from a Group
post
Holds API
Get Authorisation Hold by ID
get
Conversion API
Create Conversion Quote
post
Notification Webhooks
Notifications API
Generic Notification - event
post
Notification - SMS
post
Notification - event
post
Notification - email
post
Authentication API
Security API
Retrieve public keys
get
Magic Link API
Redirect Magic Link to App
get
Request Magic Link email
post
Token API
Elevate Access Token
post
Exchange External Token
post
Re-issue Access Token
post
Issue Access and Refresh Tokens
post
Logout API
Log Out an Installation
post
Demote an elevated Installation
post
Passcode API
Request Passcode Challenge
post
Change Passcode
post
Start Forgotten Passcode flow
post
Log-in User
post
Reset the Passcode
post
Set a Passcode for User
post
Email Bypass API
Request a VERIFY OTP
post
Validate the VERIFY OTP
get
External Authorisation API
External Auth API
Create a new card authorisation hold
post
Update existing authorisation hold amount
patch
Create a new transaction
post
Batch API
Batch API
Get batches
get
Creates a batch
post
Get batch items
get
Powered by
GraphQL with external authentication
Ask AI
