Create Payout

Create Payout

curl --request POST \
  --url https://api.paytring.com/api/v2/payout/create \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pg": "<string>",
  "method": "<string>",
  "account_number": "<string>",
  "beneficiary_id": "<string>",
  "receipt_id": "<string>",
  "amount": "<string>",
  "pg_pool_id": "<string>",
  "notes": {
    "udf1": "<string>",
    "udf2": "<string>",
    "udf3": "<string>",
    "udf4": "<string>",
    "udf5": "<string>"
  }
}
'

"{\n    \"status\": true,\n    \"payment_status\": \"success\",\n    \"message\": \"Amount transfered successfully\",\n    \"transfer_id\": \"XXXXXXXXXXXXX\"\n}"

POST

api

payout

create

Create Payout

curl --request POST \
  --url https://api.paytring.com/api/v2/payout/create \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pg": "<string>",
  "method": "<string>",
  "account_number": "<string>",
  "beneficiary_id": "<string>",
  "receipt_id": "<string>",
  "amount": "<string>",
  "pg_pool_id": "<string>",
  "notes": {
    "udf1": "<string>",
    "udf2": "<string>",
    "udf3": "<string>",
    "udf4": "<string>",
    "udf5": "<string>"
  }
}
'

"{\n    \"status\": true,\n    \"payment_status\": \"success\",\n    \"message\": \"Amount transfered successfully\",\n    \"transfer_id\": \"XXXXXXXXXXXXX\"\n}"

This API is used to initiate a payout to accounts via IMPS, RTGS, or UPI transfer.

Request Body

{
  "pg": "string", // Payment gateway (e.g., 'decentro')
  "method": "string", // Transfer method (e.g., 'upi', 'imps')
  "account_number": "string", // Account number to be debited
  "beneficiary_id": "string", // Beneficiary ID
  "pg_pool_id": "string", // Paytring pool ID
  "receipt_id": "string", // Receipt ID
  "amount": "string", // Amount to transfer
  "notes": "object" // Additional notes
}

Responses

200 OK

{
  "status": true,
  "payment_status": "success",
  "message": "Amount transferred successfully",
  "transfer_id": "XXXXXXXXXXXXX"
}

400 Bad Request

{
  "status": false,
  "error": {
    "message": "Hash not verified.",
    "code": 158
  }
}

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

string

required

eg. decentro

method

string

required

eg. upi or imps

account_number

string

required

account no of to be debited from

beneficiary_id

string

required

beneficiary id to be added

receipt_id

string

required

amount

string

required

Amount will always be in paisa/cents.

pg_pool_id

string

required

Payment Gateway pool id

notes

object

Show child attributes

notes.udf1

string