For AI agents: the docs index is at https://developer.shaype.com/llms.txt. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Home Guides API Reference GraphQL Changelog

v1.0

API Reference

v1.0Home Guides API Reference GraphQL Changelog

API Endpoints

OpenAPI Specifications

Guidance

Security and authentication
Creating customers and accounts

B2B Operations API

BPAY API
Stacks API
Micro Lending API
- Gets whether the customer is enrolled for micro-lendingget
- Enrolls the customer for micro-lending (idempotent per customer)post
Transactions API
Scheduled Payments API
KYC API
Click to Pay API
Direct Debits API
Merchant Category Codes API
- Get all Merchant Category Codesget
Liquidity API
CoP API
- Validate account holder namepost
Utilities API
Cards API
Accounts API
Groups API
FX API
PayID API
PayTo API
Customers API
Direct Entry API
- Get Direct Entry transaction status by IDget
Perks API
NPP
- Check if a Branch Identifier is eligible for NPP paymentsget
NPP 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
Holds API
- Get Authorisation Hold by IDget

Notification Webhooks

Notifications API

Authentication API

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

Batch API

Batch API

External authorisation API

Authorisation holds API
- Create a new card authorisation holdpost
- Update existing authorisation hold amountpatch
Transactions API
- Create a new transactionpost

Powered by

Retrieve public keys

get

https://auth.staging.hay.co/.well-known/jwks.json

Responses

400

Bad Request

500

Internal error

Updated 6 months ago

Redirect Magic Link to App

Did this page help you?

Language

Loading…

Response

Choose an example:

application/json

Updated 6 months ago

Redirect Magic Link to App

Did this page help you?