Release date
Apr 14, 2023
Release type
Informational – Optional action from platforms.
Summary
This new endpoint allows Platforms to use an API endpoint to fund a fiat account with Zero Hash in CERT. This functionality is currently available in the CERT Client Portal, but requires a user to login and use the deposit page to add funds to a fiat account. With this new endpoint a Platform more easily automates their end-to-end testing by programmatically funding accounts in Zero Hash’s CERT environment.
Action required
OPTIONAL - Platforms can optionally use this new feature. This will be available without any additional configuration changes.
Endpoints impacted
- (NEW - CERT Only)
POST /deposits/fund- Example Request:
{
"participant_code": "CUST01",
"asset": "USD",
"amount": "1.00",
"account_label": "general"
}
- Example Response
{
"message": {
"participant_code": "CUST01",
"asset": "USD",
"amount": "1.00",
"account_label": "general",
"account_group": "PLAT01",
"account_type": "available",
"reference_id": "21bdbb11-712f-4cb7-a178-4f277c80cde0"
}
}
Zero Hash will populate the account_group value using the platform_code of the Platform making the API request.
Zero Hash will also default the account_label value to “general”. Platforms are able to pass a specific value to this field if they need to fund an account with a different account_label. This can be useful when looking to fund float accounts for other Zero Hash products like rewards or awards. For example if a Platform wished to fund the rewards float account, they could pass a request in the POST /deposits/fund endpoint like the below:
{
"participant_code": "00SCXM",
"asset": "USD",
"amount": "100.00",
"account_label": "rewards"
}
Relevant documentation
Coming soon
As Zero Hash expands to additional countries we will make additional fiat currencies available. Currently we will only support USD.