- Created by user-e873e, last modified by user-5c3b0 on Jun 27, 2019
Overview
You can make use of the following Zeta Disbursement REST APIs during a payout scenario. This section explains about all RESTful operations including their functional behaviours, request and response parameters. You can also test them in an interactive Zeta API console. To get started, contact Zeta to register and get access to the Zeta API endpoints.
APIs presented here are only for happy flow without considering the payment exception cases. We shall publish the error codes soon.
Operation: Create a Payout
This operation enables you to create a transfer.
Functional Behaviour
POST | /optima/corporates/{corpID}/companies/{companyID}/programs/{programID}/disbursements/ |
Input Parameters
| Path Parameters | Description |
| corpID | A unique corporate ID assigned to the requester’s system |
| companyID | A unique company ID assigned to the requester’s system |
| programID | A unique program ID assigned to the requester’s system |
| Header Parameters | Description |
| Authorization | Value is "bearer token". Zeta will share this token with the requester. |
| Body Parameters | Description |
requestID | Transfer Request ID This is generated by the requester and should be unique in the requester's system. The response is idempotent on this combination. |
type | User account type. We shall support “to_bank_account”, “to_cloud_card” in future. |
amount | Value is in paises. Possible values supported for currencies is “INR” for now. |
| beneficiary | Information of the beneficiary for whom payment transfer is requested. name: Name of the user to which transfer needs to be initiated email: Email address of the user to which transfer needs to be initiated phoneNumber: Phone number of the user to which transfer needs to be initiated pan: PAN number of the user |
| description (optional) | Custom description that you wish to populate in the response payload |
| scheduledAt (optional) | Custom field that you wish to populate in the response payload. Supported value is "now". |
| attributes (optional) | Custom attribute that you wish to populate in the response payload |
{
"Authorization": "Bearer nknkdfgj444474848jfnmccvnmADDFFF"
}
{
"requestID": "requestId_hello_12317",
"type": "to_wallet",
"amount":{
"value": 10000,
"currency": "INR"
},
"beneficiary": {
"id": "Dir-13",
"name":"Anthony D'souza",
"email":"ds@zeta.in",
"phoneNumber": "Phone number of the user",
"crn": "786057",
"cardID": "Card ID of the user"
"employeeID": "2288426"
"pan": "PAN of the user",
},
"description": "test payout",
"scheduledAt": "now",
"attributes": {
"age1": 10
}
}
Output Parameters
Parameters | Description |
|---|---|
requestID | Transfer Request ID same as in request payload |
status | “SUCCESS” or “PENDING” or “FAILED” |
{
"id": 35,
"requestID": "requestId_hello_12317",
"type": "to_wallet",
"corpID": 3171,
"companyID": 9443,
"programID": 16592,
"amount": {
"currency": "INR",
"amount": 10000
},
"crn": "786057",
"cardID": "Card ID of the user"
"employeeID": 2288426,
"description": "test payout",
"attributes": {
"age": "10"
},
"status": "SUCCESS",
"scheduledAt": 1516559610000,
"createdAt": 1516559609000,
"updatedAt": 1516559613000
}
Payout Status Codes
The following payout status codes are shown to the corporate side post Zeta authorization.
Payout Status | Description |
|---|---|
SUCCESS | Beneficiary has received the transfer |
PENDING | Transfer to beneficiary is pending and need to be retried by the requester with the same requestID to get the updated status |
FAILED | Transfer to beneficiary failed. This could be due to low balance in the requester's funding account. |
Waiting for Beneficiary | Transfer successful, waiting for beneficiary to signup on zeta. |
To resolve any payout related issues, you may need to share requestID with Zeta.
Operation: Check a Beneficiary or User Existence
This operation enables you to check the status of the valid consumer account if the user exists in the Zeta.
Functional Behaviour
GET | /zeta/hasUser?identityType=[PHONE_NUMBER/EMAIL/crn/cardID/employeeID]& |
Input Parameters
| Query Parameters | Description |
identityType | User type supported as "PHONE_NUMBER" or "EMAIL" or "crn" or "cardID" or "employeeID" |
identity | Phone number or email address or card ID or employee ID or customer reference number associated with the user or beneficiary |
| Header Parameters | Description |
| Authorization | Value is "bearer token". Zeta will share this token with the requester. |
{
"Authorization": "Bearer nknkdhdj44447486748jfnmccvnmADDFFF"
}
Output Parameters
Parameters | Description |
|---|---|
userExists | "true" or "false" |
{
"userExists": true // [false],
}
On this page:
- No labels