Jump to Content
Shaype® Docs
HomeGuidesAPI ReferenceGraphQLChangelog
v1.0

Log InShaype® Docs
API Reference
Log In
v1.0HomeGuidesAPI ReferenceGraphQLChangelog
All
Guides
Reference
Changelog
Pages
Start typing to search…

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 Debit (Deprecated)post
    • 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

Batch API

  • Batch API
    • Get batchesget
    • Creates a batchpost
    • Get batch itemsget

OpenAPI Specifications

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

API
B2B REST API
Communications API
Authentication API

Updated 22 days ago


Security and authentication
Did this page help you?

Updated 22 days ago


Security and authentication
Did this page help you?
  1. API Endpoints
  2. OpenAPI Specifications
  1. Guidance
  2. Security and authentication
  3. Communications API (Webhooks)
  4. GraphQL with Shaype authentication
  5. GraphQL with external authentication
  6. B2B Rest API
  7. Creating customers and accounts
  1. B2B Operations API
  2. PayID API
  3. Register PayIDpost
  4. Get PayIDs by Account IDget
  5. Update PayID statuspatch
  6. Resolve PayID to bank accountget
  7. Update PayID detailspost
  8. Get PayID de-register historyget
  9. Check PayID availabilityget
  10. Get PayID detailsget
  11. BPAY API
  12. Update BPAY Billerpatch
  13. Retrieve BPAY Billerget
  14. Validate BPAYpost
  15. Initiate BPAY paymentpost
  16. Create BPAY Biller for Account IDpost
  17. BPAY billers for accountget
  18. Stacks API
  19. Transfer funds from Stack to Accountpost
  20. Transfer funds from Account to Stackpost
  21. Get all Stack Transactions by Stack IDget
  22. Close Stackpost
  23. Update Stackput
  24. Transfer funds from Stack to Stack of an Accountpost
  25. Get all Stack Transactions by Account IDget
  26. Create new stackpost
  27. Get all Stacks by Account IDget
  28. PayTo API
  29. Check if BSB supports PayToget
  30. Make Adhoc Paymentpost
  31. Suspend Mandate by Payerpatch
  32. Resolve Mandate pending action by Payerpatch
  33. Release Mandate by Payerpatch
  34. Cancel Mandate by Payerpatch
  35. Get Mandate Actions by Payerget
  36. Amend Mandate by Payerput
  37. Get Mandate by IDget
  38. Get Mandates by debtor account numbersget
  39. Suspend Mandate by Initiatorpatch
  40. Search payments instructions by Mandate IDget
  41. Resolve Mandate by Initiatorpatch
  42. Release Mandate by Initiatorpatch
  43. Set amount of Scheduled Payment Initiation Request by Initiatorpatch
  44. Amend Mandate payment termspatch
  45. Get Payment instruction status by Mandate ID and Payment instruction IDget
  46. Cancel Mandate by Initiatorpatch
  47. Get Mandate Actions by Initiatorget
  48. Amend Mandate by Initiatorput
  49. Create Mandatepost
  50. Returns all Mandate IDs for a Shaype Account ID.get
  51. Transactions API
  52. Get Transaction by IDget
  53. Create Debit Transaction for Accountpost
  54. Create Credit Transaction for Accountpost
  55. Search Transactionspost
  56. Create Debit Transaction for Account (DEPRECATED)post
  57. Create Credit Transaction for Account (DEPRECATED)post
  58. Scheduled Payments API
  59. Cancel Scheduled Paymentpost
  60. Get Scheduled Payment by Payment ID for an Accountget
  61. Get Scheduled Payments by Account IDget
  62. KYC API
  63. Approve Sanctions Checkpost
  64. Approve Document Checkpost
  65. Approve AML Checkpost
  66. Create new identity verification case and first submissionpost
  67. Customers API
  68. Unblock Customerpost
  69. Update Customer statuspatch
  70. Block Customerpost
  71. Update Customer detailspatch
  72. Get Customer by IDget
  73. Get Cards by Customer IDget
  74. Get Account by Customer IDget
  75. Create Account for Customer - (To be DEPRECATED - Use POST /v1/accounts instead)post
  76. Search Customerspost
  77. Create Customerpost
  78. Get all Customersget
  79. Direct Debits API
  80. Get outbound Direct Debit by IDget
  81. Create outbound Direct Debitpost
  82. Get outbound Direct Debits by dateget
  83. Get outbound Direct Debit by IDget
  84. Create outbound Direct Debit (Deprecated)post
  85. Get outbound Direct Debits by dateget
  86. Merchant Category Codes API
  87. Get all Merchant Category Codesget
  88. Liquidity API
  89. Update liquidity alerting Thresholdput
  90. Create liquidity alerting Thresholdpost
  91. Get all liquidity alerting Thresholdsget
  92. Get client Liquidityget
  93. Utilities API
  94. Generate mock Receive A Payment Instruction (RAPAIN).post
  95. Generate mock NPP inbound transaction.post
  96. Generate mock Mandate notification for Payer.post
  97. Generate mock Mandate notification for Initiator.post
  98. Generate mock NPP inbound transaction v2.post
  99. Generate mock inbound DE request.post
  100. Trigger mock card Hold and Settlementpost
  101. Trigger mock card Holdpost
  102. Trigger mock ATM card transactionpost
  103. Create stub for search payment instructions for a mandate.post
  104. Cards API
  105. Unblock Cardpost
  106. Enrol card to rewardspost
  107. Renew Cardpost
  108. Replace Cardpost
  109. Unblock Card PINpost
  110. Get Card PIN statusget
  111. Change Card PINput
  112. Update Card preferencespatch
  113. Get preferences by Card IDget
  114. Get provisioning data by Card IDget
  115. Get wallets by Card IDget
  116. Convert Cardpost
  117. Cancel Cardpost
  118. Block Cardpost
  119. Activate Cardpost
  120. Get Card by IDget
  121. Create Card for Customerpost
  122. Tokens API
  123. Exchange External Token for a Shaype token to be used when calling our GraphQL APIspost
  124. Retrieve an elevation header to be used for GraphQL APIs that require step up accesspost
  125. Products API
  126. Gets all productsget
  127. Accounts API
  128. Initiate Cash Transferpost
  129. Get Rule for Account by Rule IDget
  130. Delete Rule from Accountdelete
  131. Create Rule for Accountpost
  132. Get all Rules by Account IDget
  133. Set limit for Accountput
  134. Delete limit from Accountdelete
  135. Get all limits by Account IDget
  136. Create Custom Data for Accountpost
  137. Delete Custom Data from Accountdelete
  138. Search accountspost
  139. Creates an Accountpost
  140. Unblock Accountpost
  141. Initiate Cash Transfer (DEPRECATED)post
  142. Update Account Risk Levelpatch
  143. Get Risk Level by Account IDget
  144. Update Account overdraft limitpatch
  145. Update Account max balancepatch
  146. Get all Authorisation Holds by Account IDget
  147. Closes an accountpost
  148. Get all Cards by Account IDget
  149. Block Account and Customerpost
  150. Get Account by IDget
  151. Groups API
  152. Remove a Customer from a Grouppost
  153. Add Customers to Grouppost
  154. Create Account for Group - (To be DEPRECATED - Use POST /v1/accounts instead)post
  155. Update Group detailspatch
  156. Get Account by Group IDget
  157. Create Grouppost
  158. Holds API
  159. Get Authorisation Hold by IDget
  1. Notification Webhooks
  2. Notifications API
  3. Notification - emailpost
  4. Notification - eventpost
  5. Notification - SMSpost
  6. Generic Notification - eventpost
  1. Authentication API
  2. Security API
  3. Retrieve public keysget
  4. Magic Link API
  5. Request Magic Link emailpost
  6. Redirect Magic Link to Appget
  7. Token API
  8. Issue Access and Refresh Tokenspost
  9. Re-issue Access Tokenpost
  10. Exchange External Tokenpost
  11. Elevate Access Tokenpost
  12. Logout API
  13. Demote an elevated Installationpost
  14. Log Out an Installationpost
  15. Passcode API
  16. Set a Passcode for Userpost
  17. Reset the Passcodepost
  18. Log-in Userpost
  19. Start Forgotten Passcode flowpost
  20. Change Passcodepost
  21. Request Passcode Challengepost
  22. Email Bypass API
  23. Validate the VERIFY OTPget
  24. Request a VERIFY OTPpost
  1. External Authorisation API
  2. External Auth API
  3. Authorise a new transactionpost
  4. Increase an existing hold amountpatch
  5. Authorise a new card holdpost
  1. Batch API
  2. Batch API
  3. Get batch itemsget
  4. Creates a batchpost
  5. Get batchesget