Payout API (Coming Soon)

Transfer funds back to your user using the Payout API.

API Pricing Image

Overview

This API lets you transfer from a virtual bank account to any other bank account by passing your account_number & payment entity.

Problem

  • Users want to transfer their funds from their virtual bank account to the account of their choice.

Solution

  • API to create payouts from the virtual bank account to other accounts.

Endpoint

HTTP MethodResource
POST/tax-payment/accounts/{account_number}/payout

API Endpoint  Contact Us  Free Trial

Request

Follow the below guidelines to pass the account number and Payment Entity to make the payout.

Path Parameter

ParamTypeDescriptionExample
account_numberstringVirtual bank account numberHEY564578321596

Body

The Payment Entity is passed into the body.

Sample CURL Request

curl --request POST \
     --url https://api.sandbox.co.in/tax-payment/accounts/HEY564578321596/withdraw \
     --header 'Accept: application/json' \
     --header 'Authorization: xxxxxxx' \
     --header 'Content-Type: application/json' \
     --header 'x-api-key: xxxxxxxxxxxxx' \
     --data '
{
  "@entity": "payment",
  "payer": {
    "@entity": "payer",
    "bank_account": {
      "@entity": "bank_account",
      "account_number": "HEYSBX7874301518"
    },
    "name": "sandbox"
  },
  "payee": {
    "@entity": "payee",
    "name": "sandbox",
    "bank_account": {
      "@entity": "bank_account",
      "account_number": "0035458984318",
      "ifsc": "HDFC0000121"
    }
  },
  "amount": 2001,
  "payment_details": {
    "@entity": "payment_details",
    "description": "tax payment from Sandbox SDK",
    "mode": "NEFT",
    "notes": {},
    "transaction_id": "4cf88008-826d-4f2e-a197-a4363a10bef5"
  }
}

❗️

Test Environment Not Available

Response

The API responds back with the Payment Entity. An example response is shown below.

{
  "code": 200,
  "timestamp": 1631095323168,
  "transaction_id": "8831d466-6fe7-48ed-b478-7d1cb4e92572",
  "data": {
    "@entity": "payment",
    "payer": {
      "@entity": "payer",
      "bank_account": {
        "@entity": "bank_account",
        "account_number": "HEY598474301518"
      },
      "name": "sandbox"
    },
    "payee": {
      "@entity": "payee",
      "name": "sandbox",
      "bank_account": {
        "@entity": "bank_account",
        "account_number": "0035458984318",
        "ifsc": "HDFC0000121"
      }
    },
    "amount": 2001,
    "payment_details": {
      "@entity": "payment_details",
      "description": "tax payment from Sandbox SDK",
      "mode": "NEFT",
      "notes": {},
      "status": "Successful",
      "bank_transaction_id": "02145465459",
      "transaction_id": "4cf88008-826d-4f2e-a197-a4363a10bef5"
    }
  }
}

Response Caching

Response caching is not available for this API. Learn more about our response caching mechanism here

Wallet Charges

Since Payout API is a Paid API, a wallet charge will take place.

Versioning

This API is currently in major version 1.0. Refer to our versioning policies here