Skip to main content
POST
/
api
/
v2
/
payout
/
fetch
Fetch Payout Status
curl --request POST \
  --url https://api.paytring.com/api/v2/payout/fetch \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "58833954xxxxxxx",
  "fetch_type": "normal"
}'
"{\n    \"status\": true,\n    \"payout\": {\n        \"transfer_status\": boolean,\n        \"error\": string,\n        \"transfer_id\": string,\n        \"ut_no\": null,\n        \"amount\": 111,\n        \"fund_source\": \"Cashfree\",\n        \"method\": \"neft\",\n        \"processed_at\": \"2020-12-16 09:17:42\",\n        \"transfer_status\": \"failed\",\n        \"beneficiary\": {\n            \"name\": \"Preetam\",\n            \"email\": \"preetam@mcsam.in\",\n            \"phone\": \"7027445661\",\n            \"vpa\": \"7027445661@paytm\",\n            \"account\": {\n                \"account_no\": \"917027445660\",\n                \"ifsc\": \"PYTM0123456\"\n            }\n        },\n        \"ack\": \"\"\n    }\n}"
This API is used to check the status of a payout created via Paytring.

​
Request Body

{
  "id": "string", // Payout ID received in response on create payout API
  "fetch_type": "string" // Option to do a hard pull of info directly from PG when required (e.g., 'normal', 'advance')
}

​
Responses

​
200 OK

{
  "status": true,
  "payout": {
    "transfer_status": "boolean",
    "error": "string",
    "transfer_id": "string",
    "ut_no": "null",
    "amount": 111,
    "fund_source": "Cashfree",
    "method": "neft",
    "processed_at": "2020-12-16 09:17:42",
    "transfer_status": "failed",
    "beneficiary": {
      "name": "Preetam",
      "email": "preetam@mcsam.in",
      "phone": "7027445661",
      "vpa": "7027445661@paytm",
      "account": {
        "account_no": "917027445660",
        "ifsc": "PYTM0123456"
      }
    },
    "ack": ""
  }
}

​
400 Bad Request

{
  "status": false,
  "error_code": "int",
  "error_message": "string"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
id
string
default:58833954xxxxxxx
required

Payout ID received in response on create payout API.

​
fetch_type
enum<string>
default:normal

This option allow user to do a hard pull of info directly from PG when required.

Available options:
normal,
advance

Response

200

The response is of type any.