Overview of bulk payouts sample response object.
Shown below is a sample response returned for a Upload file API.
{
"requestReferenceId": "req-1b980dd2c75b456782bc1a3acff481a0",
"status": "PENDING",
"message": "",
"_links": [
{
"rel": "status",
"href": "http://pluralqa.pinepg.in:8000/payouts/v2/payments?requestReferenceId=req-1b980dd2c75b456782bc1a3acff481a0"
}
]
}
The table below lists the various parameters returned in the upload file sample response object.
| Parameter | Type | Description |
|---|---|---|
| requestReferenceId | string | Unique identifier of the payout request in Plural database. Example: req-1b980dd2c75b456782bc1a3acff481a0 |
| status | string | Payout status. Example: PENDING |
| message | string | Corresponding message to the status. Example: Payment instruction pending to be executed |
| _links | object | An object that contains the payment link details. |
_Links [Child Object]
The table below lists the various parameters in the links child object. This object is part of the update scheduled payout sample response object.
| Parameter | Type | Description |
|---|---|---|
| rel | string | Relationship to the resource. Example: status |
| href | string | Link to access the resource. Example: http://pluralqa.pinepg.in:8000/payouts/v2/payments?paymentReferenceId=txn-a9304bb5bdd6444782466575afd023e4 |