Version: 1.0.2

Internal Transfer

Move funds between two accounts in ledger (same customer/different customers). This API is useful to support internal transfer between two different customer accounts. This is also useful in the fintech context while trying to automate the movement funds between accounts of the same customer.

Method: POST

{{URL}}/rpc/paymentv2
Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
Type Mandatory	Enum Valid Values: REMITTANCE CARDPAY INTERNAL_TRANSFER WITHDRAW DEPOSIT ADMIN_DEPOSIT
ReferenceId Mandatory	String Sample Value: REF0000000002
InstructedAmount Mandatory	Amount: Number Mandatory In Smallest Currency Unit Example: 7 Currency: String Mandatory Example: USD
FeeAmount	Amount: Number Mandatory In Smallest Currency Unit Example: 7 Currency: String Mandatory Example: USD
TaxAmount	Amount: Number Mandatory In Smallest Currency Unit Example: 1 Currency: String Mandatory Example: USD
DebtorAccount	AccountNumber: String Example: 98652221851 Required only for ACH payment mode InstitutionId: String Example: 101115302 Reference: String Example: txn000013 Required only for PG, QRCODE, EFT, TELLER, BENEFIT, CHEQUE payment mode Party: AccountVerificationId: String Example: 5e9f246bd6571f2280d3d7b4 KycId: String Example: 5e9f1696d6571f272c5bcc0f
CreditorAccount	AccountNumber: String Mandatory Account Number from add account Response Sample Value: 9865321478 InstitutionId: String Sample Value: 011000028 IdentificationType: Enum Valid Values: SAVINGS CHECKINGS WALLET IFSCCode: String Sample Value: HDFC0001866 CardNumber: String Sample Value: 5102589999999913 ExpiryDate: String Expiry date in the YYYY-MM format Sample Value: 2022-12` Party Name: String Sample Value: John Deo Identification: String Sample Value: 859630248 IdentificationType: String Sample Value: SSN DateOfBirth: String Sample Value: 19930222 Address: Line1: String Sample Value: 1200 street Line2: String Sample Value: 2nd main road TownName: String Sample Value: chennai PostCode: String Sample Value: 600042 State: String Sample Value: TN Country: String Sample Value: IN Identification: Type: String Type of Identification Sample Value: SSN Value: String Identifying document number Sample Value: 324345435 PhoneNumber: String Sample Value: 45215478

cURL
C#
Go
NodeJS

curl --location --globoff '{{URL}}/rpc/paymentv2' \
--data '{"method":"ledger.internal.transfer","id":"1","params":{"payload":{"channel":"INTERNAL","transactionType":"INTERNAL_TRANSFER","product":"BANK","program":"BANK","transactionDateTime":"2021-01-19 06:20:25","reference":"REF1200000000004","reason":"Settlement","transactionAmount":{"amount":"100","currency":"USD"},"creditorAccount":{"identification":"200519831228778","identificationType":"ACCOUNT_NUMBER"},"debtorAccount":{"identification":"200382281733437","identificationType":"ACCOUNT_NUMBER"}}}, "api":{"credential":"{{Credential}}","signature":"{{signature}}","apiKey":"{{ApiKey}}"}}'

using System;
using RestSharp;
using System.Threading;
using System.Threading.Tasks;
namespace HelloWorldApplication {
  class HelloWorld {
    static async Task Main(string[] args) {
      var options = new RestClientOptions("{{URL}}/rpc/paymentv2")
      {
        MaxTimeout = -1,
      };
      var client = new RestClient(options);
      var request = new RestRequest("", Method.Post);
      request.AddHeader("Signature", "{{signature}}");
      request.AddHeader("Content-Type", "application/json");
      var body = @"{""method"":""ledger.internal.transfer"",""id"":""1"",""params"":{""payload"":{""channel"":""INTERNAL"",""transactionType"":""INTERNAL_TRANSFER"",""product"":""BANK"",""program"":""BANK"",""transactionDateTime"":""2021-01-19 06:20:25"",""reference"":""REF1200000000004"",""reason"":""Settlement"",""transactionAmount"":{""amount"":""100"",""currency"":""USD""},""creditorAccount"":{""identification"":""200519831228778"",""identificationType"":""ACCOUNT_NUMBER""},""debtorAccount"":{""identification"":""200382281733437"",""identificationType"":""ACCOUNT_NUMBER""}}}, ""api"":{""credential"":""{{Credential}}"",""signature"":""{{signature}}"",""apiKey"":""{{ApiKey}}""}}";
      request.AddStringBody(body, DataFormat.Json);
      RestResponse response = await client.ExecuteAsync(request);
      Console.WriteLine(response.Content);
    }
  }
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "%7B%7BURL%7D%7D/rpc/paymentv2"
  method := "POST"

  payload := strings.NewReader(`{"method":"ledger.internal.transfer","id":"1","params":{"payload":{"channel":"INTERNAL","transactionType":"INTERNAL_TRANSFER","product":"BANK","program":"BANK","transactionDateTime":"2021-01-19 06:20:25","reference":"REF1200000000004","reason":"Settlement","transactionAmount":{"amount":"100","currency":"USD"},"creditorAccount":{"identification":"200519831228778","identificationType":"ACCOUNT_NUMBER"},"debtorAccount":{"identification":"200382281733437","identificationType":"ACCOUNT_NUMBER"}}}, "api":{"credential":"{{Credential}}","signature":"{{signature}}","apiKey":"{{ApiKey}}"}}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Signature", "{{signature}}")
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '{{URL}}',
  'path': '/rpc/paymentv2',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "method": "ledger.internal.transfer",
  "id": "1",
  "params": {
    "payload": {
      "channel": "INTERNAL",
      "transactionType": "INTERNAL_TRANSFER",
      "product": "BANK",
      "program": "BANK",
      "transactionDateTime": "2021-01-19 06:20:25",
      "reference": "REF1200000000004",
      "reason": "Settlement",
      "transactionAmount": {
        "amount": "100",
        "currency": "USD"
      },
      "creditorAccount": {
        "identification": "200519831228778",
        "identificationType": "ACCOUNT_NUMBER"
      },
      "debtorAccount": {
        "identification": "200382281733437",
        "identificationType": "ACCOUNT_NUMBER"
      }
    }
  },
  "api": {
    "credential": "{{Credential}}",
    "signature": "{{signature}}",
    "apiKey": "{{ApiKey}}"
  }
});

req.write(postData);

req.end();

Body

{
    "method": "ledger.internal.transfer",
    "id": "1",
    "params": {
        "payload": {
            "channel": "API",
            "transactionType": "INTERNAL_TRANSFER",
            "product": "LEDGER",
            "program": "100000000000005",
            "transactionDateTime": "2021-01-19 06:20:25",
            "reference": "REF1200000000004",
            "reason": "Settlement",
            "transactionAmount": {
                "amount": "100",
                "currency": "USD"
            },
            "creditorAccount": {
                "identification": "200656417727934",
                "identificationType": "ACCOUNT_NUMBER"
            },
            "debtorAccount": {
                "identification": "200524894086671",
                "identificationType": "ACCOUNT_NUMBER"
            }
        },
        "api": {
            "credential": "Basic Key",
            "signature": "{{signature}}",
            "apiKey": "a8000fa5e9f1498b9f45b78f95e00dae"
        }
    }
}

Response: 200

{
    "id": "1",
    "result": {
        "api": {
            "type": "INTERNAL_TRANSFER_ACK",
            "reference": "REF1200000000004",
            "dateTime": "2023-05-02 16:31:25"
        },
        "account": {
            "accountId": "200656417727934",
            "balanceCents": 100,
            "status": "ACTIVE"
        },
        "transactionNumber": "QA00000000007005",
        "transactionStatus": "COMPLETED",
        "transactionAmountCents": 100,
        "originalRequestBase64": "eyJjaGFubmVsIjoiQVBJIiwidHJhbnNhY3Rpb25UeXBlIjoiSU5URVJOQUxfVFJBTlNGRVIiLCJwcm9kdWN0IjoiTEVER0VSIiwicHJvZ3JhbSI6IjEwMDAwMDAwMDAwMDAwNSIsInRyYW5zYWN0aW9uRGF0ZVRpbWUiOiIyMDIxLTAxLTE5IDA2OjIwOjI1IiwicmVmZXJlbmNlIjoiUkVGMTIwMDAwMDAwMDAwNCIsInJlYXNvbiI6IlNldHRsZW1lbnQiLCJ0cmFuc2FjdGlvbkFtb3VudCI6eyJhbW91bnQiOiIxMDAiLCJjdXJyZW5jeSI6IlVTRCJ9LCJkZWJ0b3JBY2NvdW50Ijp7ImlkZW50aWZpY2F0aW9uIjoiMjAwNTI0ODk0MDg2NjcxIiwiaWRlbnRpZmljYXRpb25UeXBlIjoiQUNDT1VOVF9OVU1CRVIifSwiY3JlZGl0b3JBY2NvdW50Ijp7ImlkZW50aWZpY2F0aW9uIjoiMjAwNjU2NDE3NzI3OTM0IiwiaWRlbnRpZmljYXRpb25UeXBlIjoiQUNDT1VOVF9OVU1CRVIifX0=",
        "processId": "PL23050200007005"
    },
    "header": {
        "reference": "REF1200000000004",
        "apiKey": "a8000fa5e9f1498b9f45b78f95e00dae",
        "signature": "MEQCIHiJ1nUS4jBW8hSfCDE86ihaqj+rADvlz1xkzs0MqtQsAiAmDsY3CGUtlXO3wJSiW67pnRUXdonPinEVS4FI1NgxcA=="
    }
}

Internal Transfer

Method: POST​

Headers​

Example​

Body​

Response: 200​

Method: POST

Headers

Example

Body

Response: 200