Jump to Content
Shaype® Docs
HomeGuidesAPI ReferenceGraphQLChangelog
v1.0

Log InShaype® Docs
API Reference
Log In
v1.0HomeGuidesAPI ReferenceGraphQLChangelog

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 detailsget
    • Check PayID availabilityget
    • Get PayID de-register historyget
    • Update PayID detailspost
    • Resolve PayID to bank accountget
    • Update PayID statuspatch
    • Get PayIDs by Account IDget
    • Register PayIDpost
  • BPAY API
    • BPAY billers for accountget
    • Create BPAY Biller for Account IDpost
    • Initiate BPAY paymentpost
    • Validate BPAYpost
    • Retrieve BPAY Billerget
    • Update BPAY Billerpatch
  • Stacks API
    • Get all Stacks by Account IDget
    • Create new stackpost
    • Get all Stack Transactions by Account IDget
    • Transfer funds from Stack to Stack of an Accountpost
    • Update Stackput
    • Close Stackpost
    • Get all Stack Transactions by Stack IDget
    • Transfer funds from Account to Stackpost
    • Transfer funds from Stack to Accountpost
  • PayTo API
    • Returns all Mandate IDs for a Shaype Account ID.get
    • Create Mandatepost
    • Amend Mandate by Initiatorput
    • Get Mandate Actions by Initiatorget
    • Cancel Mandate by Initiatorpatch
    • Get Payment instruction status by Mandate ID and Payment instruction IDget
    • Amend Mandate payment termspatch
    • Set amount of Scheduled Payment Initiation Request by Initiatorpatch
    • Release Mandate by Initiatorpatch
    • Resolve Mandate by Initiatorpatch
    • Search payments instructions by Mandate IDget
    • Suspend Mandate by Initiatorpatch
    • Get Mandates by debtor account numbersget
    • Get Mandate by IDget
    • Amend Mandate by Payerput
    • Get Mandate Actions by Payerget
    • Cancel Mandate by Payerpatch
    • Release Mandate by Payerpatch
    • Resolve Mandate pending action by Payerpatch
    • Suspend Mandate by Payerpatch
    • Make Adhoc Paymentpost
    • Check if BSB supports PayToget
  • Transactions API
    • Create Credit Transaction for Account (DEPRECATED)post
    • Create Debit Transaction for Account (DEPRECATED)post
    • Search Transactionspost
    • Create Credit Transaction for Accountpost
    • Create Debit Transaction for Accountpost
    • Get Transaction by IDget
  • Scheduled Payments API
    • Get Scheduled Payments by Account IDget
    • Get Scheduled Payment by Payment ID for an Accountget
    • Cancel Scheduled Paymentpost
  • KYC API
    • Create new identity verification case and first submissionpost
    • Approve AML Checkpost
    • Approve Document Checkpost
    • Approve Sanctions Checkpost
  • Customers API
    • Get all Customersget
    • Create Customerpost
    • Search Customerspost
    • Create Account for Customer - (To be DEPRECATED - Use POST /v1/accounts instead)post
    • Get Account by Customer IDget
    • Get Cards by Customer IDget
    • Get Customer by IDget
    • Update Customer detailspatch
    • Block Customerpost
    • Update Customer statuspatch
    • Unblock Customerpost
  • Direct Debits API
    • Get outbound Direct Debits by dateget
    • Create outbound Direct Debitpost
    • Get outbound Direct Debit by IDget
    • Get outbound Direct Debits by dateget
    • Create outbound Direct Debitpost
    • Get outbound Direct Debit by IDget
  • Merchant Category Codes API
    • Get all Merchant Category Codesget
  • Liquidity API
    • Get client Liquidityget
    • Get all liquidity alerting Thresholdsget
    • Create liquidity alerting Thresholdpost
    • Update liquidity alerting Thresholdput
  • Utilities API
    • Create stub for search payment instructions for a mandate.post
    • Trigger mock ATM card transactionpost
    • Trigger mock card Holdpost
    • Trigger mock card Hold and Settlementpost
    • 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 Customerpost
    • Get Card by IDget
    • Activate Cardpost
    • Block Cardpost
    • Cancel Cardpost
    • Convert Cardpost
    • Get wallets by Card IDget
    • Get provisioning data by Card IDget
    • Get preferences by Card IDget
    • Update Card preferencespatch
    • Change Card PINput
    • Get Card PIN statusget
    • Unblock Card PINpost
    • Replace Cardpost
    • Renew Cardpost
    • Enrol card to rewardspost
    • Unblock Cardpost
  • 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
    • Get Account by IDget
    • Block Account and Customerpost
    • Get all Cards by Account IDget
    • Closes an accountpost
    • Get all Authorisation Holds by Account IDget
    • Update Account max balancepatch
    • Update Account overdraft limitpatch
    • Get Risk Level by Account IDget
    • Update Account Risk Levelpatch
    • Initiate Cash Transfer (DEPRECATED)post
    • Unblock Accountpost
    • Creates an Accountpost
    • Search accountspost
    • Delete Custom Data from Accountdelete
    • Create Custom Data for Accountpost
    • Get all limits by Account IDget
    • Delete limit from Accountdelete
    • Set limit for Accountput
    • Get all Rules by Account IDget
    • Create Rule for Accountpost
    • Delete Rule from Accountdelete
    • Get Rule for Account by Rule IDget
    • Initiate Cash Transferpost
  • Groups API
    • Create Grouppost
    • Get Account by Group IDget
    • Update Group detailspatch
    • Create Account for Group - (To be DEPRECATED - Use POST /v1/accounts instead)post
    • Add Customers to Grouppost
    • Remove a Customer from a Grouppost
  • Holds API
    • Get Authorisation Hold by IDget

Notification Webhooks

  • Notifications API
    • Generic Notification - eventpost
    • Notification - SMSpost
    • Notification - eventpost
    • Notification - emailpost

Authentication API

  • Security API
    • Retrieve public keysget
  • Magic Link API
    • Redirect Magic Link to Appget
    • Request Magic Link emailpost
  • Token API
    • Elevate Access Tokenpost
    • Exchange External Tokenpost
    • Re-issue Access Tokenpost
    • Issue Access and Refresh Tokenspost
  • Logout API
    • Log Out an Installationpost
    • Demote an elevated Installationpost
  • Passcode API
    • Request Passcode Challengepost
    • Change Passcodepost
    • Start Forgotten Passcode flowpost
    • Log-in Userpost
    • Reset the Passcodepost
    • Set a Passcode for Userpost
  • Email Bypass API
    • Request a VERIFY OTPpost
    • Validate the VERIFY OTPget

External Authorisation API

  • External Auth API
    • Authorise a new card holdpost
    • Increase an existing hold amountpatch
    • Authorise a new transactionpost

OpenAPI Specifications

You can download OpenAPI specifications for our services from the table below.

API
B2B REST API
Communications API
Authentication API