Generate Deposits

Learn how to generate deposits

On generating a deposit request, the system initiates the creation of the deposit and then redirects the user to the provided payment link.

You must transmit all necessary information to facilitate the completion of the deposit request. Upon receipt of this information, our system will reply with the payment metadata, which includes an external link for the user to access and view their payment details.

Note:** If not all required fields are provided in your request, the API endpoint will return an error response.

INR Deposit Request

import axios from 'axios';

const options = {
  method: 'POST',
  url: 'https:/api.aqua.test.krayondigital.com/main/api/v1/deposits',
  headers: {
    accept: 'application/json',
    'content-type': 'application/json',
    'Bearer': 'YOUR-API-TOKEN'
  },
  data: {
    "amount": "500",
    "reference_id": "payment_1",
    "description": "first payment for the organization",
    "currency": "INR",
    "customer": {
      "reference_id": "krayon_1337",
      "country_code": "IN",
      "email": "[email protected]",
      "first_name": "elon",
      "last_name": "mush",
      "phone": "919895270111",
    },
    "billing_address": {
      "country_code": "IN",
      "address_line1": "Address Line 1",
    },
    "payment_method": "UPI",
    "type": "DEPOSIT"
  }
};

axios
  .request(options)
  .then(function (response) {
    console.log(response.data);
  })
  .catch(function (error) {
    console.error(error);
  });
import requests
import requests

url = "https:/api.aqua.test.krayondigital.com/main/api/v1/deposits"

payload = {
  "amount": "500",
  "reference_id": "payment_1",
  "description": "first payment for the organization",
  "currency": "INR",
  "customer": {
    "reference_id": "krayon_1337",
    "country_code": "IN",
    "email": "[email protected]",
    "first_name": "elon",
    "last_name": "mush",
    "phone": "919895270111",
  },
  "billing_address": {
    "country_code": "IN",
    "address_line1": "Address Line 1",
  },
  "payment_method": "UPI",
  "type": "DEPOSIT"
}

headers = {
    "accept": "application/json",
    "content-type": "application/json"
 		"Bearer": "YOUR-API-TOKEN"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)
{
  "amount": "500",
  "reference_id": "payment_1",
  "description": "first payment for the organization",
  "currency": "INR",
  "customer": {
    "reference_id": "krayon_1337",
    "country_code": "IN",
    "email": "[email protected]",
    "first_name": "elon",
    "last_name": "mush",
    "phone": "919895270111",
  },
  "billing_address": {
    "country_code": "IN",
    "address_line1": "Address Line 1",
  },
  "payment_method": "UPI",
  "type": "DEPOSIT",
  "webhook_url": "https://krayondigital.webhook.com",
}

Response

{
  "data": {
    "id": "8c7d6aac220c495fa50670a46b458e9d",
    "organization": "org_aAgoWL5DjwSvQSf0",
    "wallet": None,
    "status": "PENDING",
    "amount": 500.0,
    "currency": "INR",
    "symbol": "USDT",
    "type": "DEPOSIT",
    "payment_method": "UPI",
    "description": "this is the payment description",
    "qr_code": "upi://pay?pa=INNOV781.29@CMSIDFC&pn=Krayon Digital&tn=121237361371281&tr=1278361287361287312&am=500.0&cu=INR",
    "return_url": "https://www.krayondigital.com",
    "redirect_url": "https://prod.teal.krayondigital/checkouts/8c7d6aac220c495fa50670a46b458e9d",
    "created_at": "2023-01-01 10:57:49"
  }

NGN Deposit Request

import axios from 'axios';

const options = {
  method: 'POST',
  url: 'https:/api.aqua.test.krayondigital.com/main/api/v1/deposits',
  headers: {
    accept: 'application/json',
    'content-type': 'application/json',
    'Bearer': 'YOUR-API-TOKEN'
  },
  data: {
    "amount": "2500",
    "reference_id": "payout_1",
    "description": "first payout for the organization",
    "currency": "NGN",
    "customer": {
      "reference_id": "krayon_1337",
      "country_code": "NG",
      "email": "[email protected]",
      "first_name": "elon",
      "last_name": "mush",
      "phone": "23408084111223",
      "account_number": "1111111111"
    },
    "billing_address": {
      "country_code": "NG",
      "address_line1": "Address Line 1",
    },
    "payment_method": "NETBANKING",
    "type": "DEPOSIT"
  }
};

axios
  .request(options)
  .then(function (response) {
    console.log(response.data);
  })
  .catch(function (error) {
    console.error(error);
  });
import requests
import requests

url = "https:/api.aqua.test.krayondigital.com/main/api/v1/deposits"

payload = {
    "amount": "500",
    "reference_id": "payout_1",
    "description": "first payout for the organization",
    "currency": "INR",
    "customer": {
      "reference_id": "krayon_1337",
      "country_code": "IN",
      "email": "[email protected]",
      "first_name": "elon",
      "last_name": "mush",
      "phone": "919895270111",
      "account_number": "1111111111"
    },
    "billing_address": {
      "country_code": "IN",
      "address_line1": "Address Line 1",
      "city": "Mumbai",
      "state": "Maharashtra",
      "postalCode": "1234567",
    },
    "additional_parameters":{
        "bank_code":"KKBK00000000"
    },
    "payment_method": "IMPS",
    "type": "WITHDRAWAL"
  }

headers = {
    "accept": "application/json",
    "content-type": "application/json"
 		"Bearer": "YOUR-API-TOKEN"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)
{
    "amount": "500",
    "reference_id": "payout_1",
    "description": "first payout for the organization",
    "currency": "INR",
    "customer": {
      "reference_id": "krayon_1337",
      "country_code": "IN",
      "email": "[email protected]",
      "first_name": "elon",
      "last_name": "mush",
      "phone": "919895270111",
      "account_number": "1111111111"
    },
    "billing_address": {
      "country_code": "IN",
      "address_line1": "Address Line 1",
      "city": "Mumbai",
      "state": "Maharashtra",
      "postalCode": "1234567",
    },
    "additional_parameters":{
        "bank_code":"KKBK00000000"
    },
    "payment_method": "IMPS",
    "type": "WITHDRAWAL"
}

Please check the limits and payment methods for each region. Payment Methods
Please check deposits API ref for more information and response object fields. Create deposit
Please check the deposit object for more information. Deposit Object