Get Secret Key
A secret key is generated for every account that is used in api requests.
User will get secrete key. Using this
secrete user can access all api which required secrete key.
The POST request will be send over HTTPS to the
endpoint.
Sample Request

Sample Response

How to generate verification hash?
Verification Hash has to be calculated with following combination using SHA256
algorithm and need to be send along with the authentication parameters in each server-to-server request.
Parameters required for creating hash are :
<userName><walletOwnerId>
Below is the description of fields used for generating hash:
- userName <Email or Phone number with country code of Merchant/Customer>
- walletOwnerId <Wallet Owner ID as shared by TWPayz>
Sample Code

Request Parameters
This reference lists all the standard flow parameters to be send in request.
| Parameter | Description | Format | Required |
|---|---|---|---|
| userName | Use userName for login. | A255 | Yes |
| walletOwnerId | Provided by Unique id. | N20
[0-9] |
Yes |
| verificationHash | Verification Hash has collected combination of parameters. | String | Yes |
Response Parameters
This reference list lists all the standard flow parameters to be received in response.
| Parameter | Description | Format | Required |
|---|---|---|---|
| customerId | Generated unique customer id on per user sign up. | N50
[0-9]{50} |
Yes |
| secKey | Generated secret key for per user. | String | Yes |
| status | Response status (SUCCESS/FAILED). | A [A-Z] |
Yes |
| responseCode | Response code | [a-zA-Z0-9] | Yes |
| customerName | Full name of the customer returned in the API response. | String | Yes |
| Response Code | Message |
|---|---|
| SUCCESS | Successful Login |
| FAILED | Fail to login |
| NOT_AVAILABLE | This User is not registered |
| INVALID TOKEN | Invalid Token access |
| All fields are mandatory | Each and every field is mandatory |