Testing Deposit Events

Users can examine the system's behavior without making an actual deposit. By using this endpoint, customers can initiate a mock deposit. This type of deposit does not impact the balance and is intended for quick testing and integration.

Before calling this endpoint, the customers must create a deposit tracking session for their users.

Creating A Fake Deposit For Testing Callback Url API Endpoint

POST https://api-prod.alfa-instap-cpt.uk/pgpub/mock/deposit

By using this endpoint, one can simulate a deposit and activate the customer's webhook URL.

When the system triggers the customer's deposit callback URL after calling this endpoint, it sets the deposit value to ZERO for security reasons.

Headers

Name	Type	Description
content-type*	string	application/json
x-api-key*	string	Replace your API key
x-payload-hash*	string	Replace your calculated HMAC hash. See API Security.

Request Body

Name	Type	Description
userId*	string	STRING [Min 1,Max 4000] Characters The unique ID of the user. Mock/fake deposit will be triggered for this user.
blockChainCurrency*	string	STRING 3 Characters The payment is mocked for this blockchain. Supported values are BTC,LTC,USDT_TRON,DOGE, XRP, TRX or ETH.
blockChainAmount*	number	NUMBER The amount of the fake payment.

200: OK Success

{
    "mockDepositResult": {
        "relatedSessionToken": "TOKEN",
        "detailedLogs": [
            "DETAILED LOG 1",
            "DETAILED LOG 2",
            "DETAILED LOG 3",
            "SUCCESS.",
        ]
    }
}

The system successfully created a mock deposit and pushed it to our event source. With detailed logs, one can gain insight into the operation status.

400: Bad Request errorHmacNotActiveForTheUser

If HMAC security is not activated for the user, the system will reject the request. See Enabling HMAC.

401 payloadDoesNotComply

If the validation fails for the payload, the system will return this error code as a response, containing the invalid parameter.

400: Bad Request errorHmacDoesNotMatch

The customers must sign the body of this request with their HAMC secret. For comparing the x-payload-hash, our system also signs the same request payload with the customer's HMAC secret. The system will return this error code if the calculated payload does not match the system's computed hash. Please see the API Security section.