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
Liquidity 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
Holds API
- Get Authorisation Hold by IDget

Notification Webhooks

Notifications API

Authentication API

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

External Authorisation API

External Auth API

Initiate Cash Transfer

post http://localhost:8080/v1/accounts/{accountId}/transfer

Path Params

accountId

uuid

required

Unique identifier (UUID) of the Account

Body Params

accountTransfer

object

Details of a transfer to Account using bank account details

amount

number

required

The amount to be transferred

category

string

Used to assign a category of the transfer

description

string

required

length between 1 and 255

Transfer description, will be seen by both sender and recipient

idempotencyKey

uuid

Unique value (UUID) used to identify this request and used to recognise any subsequent retries

internalTransfer

object

Details of a transfer to Account using AccountID

payIdTransfer

object

Details of a transfer to Account using PayID

reference

string

length between 0 and 35

Reference to be included with the transfer

senderCustomerHayId

uuid

required

Unique identifier (UUID) of the Customer (initiator of the transfer)

transferType

string

required

Transfer type. Possible values:

ACCOUNT: Transfer to Account using bank account details (requires accountTransfer object to be provided)
INTERNAL: Transfer to Account using AccountID, where recipient also Client's Customer with Shaype (requires internalTransfer object to be provided)
PAY_ID: Transfer to Account using PayID (requires payIdTransfer object to be provided)

Responses

Response body

object

outcome

string

Transaction outcome. Possible values:

ACCEPTED
INTERNAL_ERROR
REFUSED_ACCOUNT_BLOCKED
REFUSED_CUSTOMER_PREFERENCE
REFUSED_DAILY_TRANSFERS_OUT_LIMIT_BREACHED
REFUSED_FRAUD
REFUSED_INSUFFICIENT_FUNDS
REFUSED_INVALID_PAY_ID
REFUSED_LIMIT_BREACH
REFUSED_MAX_BALANCE_EXCEEDED
REFUSED_RECIPIENT_ACCOUNT_BLOCKED
REFUSED_ACCOUNT_CLOSED
REFUSED_RECIPIENT_ACCOUNT_CLOSED
REFUSED_TOTAL_INBOUND_DIRECT_DEBIT_DAILY_LIMIT_BREACHED
REFUSED_TOTAL_OUTBOUND_BPAY_DAILY_LIMIT_BREACHED
REFUSED_TOTAL_NET_VISA_DAILY_LIMIT_BREACHED
REFUSED_TOTAL_NON_SCHEME_DAILY_LIMIT_BREACHED
UNKNOWN

ACCEPTED INTERNAL_ERROR REFUSED_LIMIT_BREACH REFUSED_FRAUD REFUSED_CUSTOMER_PREFERENCE REFUSED_INSUFFICIENT_FUNDS REFUSED_ACCOUNT_BLOCKED REFUSED_RECIPIENT_ACCOUNT_BLOCKED REFUSED_ACCOUNT_CLOSED REFUSED_RECIPIENT_ACCOUNT_CLOSED REFUSED_INVALID_PAY_ID UNKNOWN REFUSED_DAILY_TRANSFERS_OUT_LIMIT_BREACHED REFUSED_MAX_BALANCE_EXCEEDED REFUSED_TOTAL_INBOUND_DIRECT_DEBIT_DAILY_LIMIT_BREACHED REFUSED_TOTAL_OUTBOUND_BPAY_DAILY_LIMIT_BREACHED REFUSED_TOTAL_NET_VISA_DAILY_LIMIT_BREACHED REFUSED_TOTAL_NON_SCHEME_DAILY_LIMIT_BREACHED

transactionId

uuid

Unique identifier (UUID) of the Transaction

Response body

object

details

string

Error details

message

string

Error description

status

string

HTTP response status

traceId

string

TraceID that can be used by HAY for troubleshooting the request

Response body

object

details

string

Error details

message

string

Error description

status

string

HTTP response status

traceId

string

TraceID that can be used by HAY for troubleshooting the request

Response body

object

details

string

Error details

message

string

Error description

status

string

HTTP response status

traceId

string

TraceID that can be used by HAY for troubleshooting the request

Response body

object

details

string

Error details

message

string

Error description

status

string

HTTP response status

traceId

string

TraceID that can be used by HAY for troubleshooting the request

Response body

object

details

string

Error details

message

string

Error description

status

string

HTTP response status

traceId

string

TraceID that can be used by HAY for troubleshooting the request

Updated over 1 year ago

Get Rule for Account by Rule ID

Groups API

Did this page help you?

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url http://localhost:8080/v1/accounts/accountId/transfer \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "transferType": "ACCOUNT"
8
}
9
'

Choose an example:

application/json

Updated over 1 year ago

Get Rule for Account by Rule ID

Groups API

Did this page help you?

API Endpoints
OpenAPI Specifications

Guidance
Security and authentication
Communications API (Webhooks)
GraphQL with Shaype authentication
GraphQL with external authentication
B2B Rest API
Creating customers and accounts

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

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

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

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

200Success

400Bad Request

403Forbidden

422Unprocessable Entity

500Internal Server Error

501Not Implemented