For AI agents: visit https://developer.shaype.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

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

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
Direct Entry API
- Get Direct Entry transaction status by IDget
Perks API
- Gets the countries where perks are available (optionally filtered by service)get
Liquidity API
NPP
- Check if a Branch Identifier is eligible for NPP paymentsget
CoP 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
FX API
Holds API
- Get Authorisation Hold by IDget

Notification Webhooks

Notifications API

Authentication API

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

External Authorisation API

External Auth API

Batch API

Batch API

Balance authorisation API

/holds
- Create a new card authorisation holdpost
/holds/{holdId}
- Update existing authorisation hold amountpatch
/transactions
- Create a new transactionpost

Powered by

Update Group details

patch

http://localhost:18080/v0/groups/{groupHayId}

Path Params

groupHayId

uuid

required

Unique identifier (UUID) of the Group

Body Params

Describes the changes to be applied to Group record. Only the provided information will be updated. Business identifiers will be replaced as a whole (no partial updates are possible).

businessIdentifiers

object

Identifiers issued by the government to the entity represented by this Group

groupName

string

length between 1 and 100

Name of the Group

groupType

string

enum

Group type. Possible values:

BUSINESS: Non-individual / joint entity
PERSONAL: Joint account entity (default if no option selected)

Allowed:

Responses

Updated about 2 months ago

Get Account by Group ID

Create Account for Group - (To be DEPRECATED - Use POST /v1/accounts instead)

Did this page help you?

Language

Loading…

Response

Choose an example:

application/json

Updated about 2 months ago

Get Account by Group ID

Create Account for Group - (To be DEPRECATED - Use POST /v1/accounts instead)

Did this page help you?