Skip to main content
POST
/
send
/
send_instructions
Create a send instruction
curl --request POST \
  --url https://staging-api.chip-in.asia/api/send/send_instructions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checksum: <checksum>' \
  --header 'epoch: <epoch>' \
  --data '
{
  "bank_account_id": 1,
  "amount": "100",
  "description": "Vendor payout for invoice INV-2024-0892",
  "email": "recipient@example.com",
  "reference": "INV-2024-0892",
  "send_recipient_receipt": true
}
'
import requests

url = "https://staging-api.chip-in.asia/api/send/send_instructions"

payload = {
    "bank_account_id": 1,
    "amount": "100",
    "description": "Vendor payout for invoice INV-2024-0892",
    "email": "recipient@example.com",
    "reference": "INV-2024-0892",
    "send_recipient_receipt": True
}
headers = {
    "epoch": "<epoch>",
    "checksum": "<checksum>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    epoch: '<epoch>',
    checksum: '<checksum>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    bank_account_id: 1,
    amount: '100',
    description: 'Vendor payout for invoice INV-2024-0892',
    email: 'recipient@example.com',
    reference: 'INV-2024-0892',
    send_recipient_receipt: true
  })
};

fetch('https://staging-api.chip-in.asia/api/send/send_instructions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://staging-api.chip-in.asia/api/send/send_instructions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'bank_account_id' => 1,
    'amount' => '100',
    'description' => 'Vendor payout for invoice INV-2024-0892',
    'email' => 'recipient@example.com',
    'reference' => 'INV-2024-0892',
    'send_recipient_receipt' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "checksum: <checksum>",
    "epoch: <epoch>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://staging-api.chip-in.asia/api/send/send_instructions"

	payload := strings.NewReader("{\n  \"bank_account_id\": 1,\n  \"amount\": \"100\",\n  \"description\": \"Vendor payout for invoice INV-2024-0892\",\n  \"email\": \"recipient@example.com\",\n  \"reference\": \"INV-2024-0892\",\n  \"send_recipient_receipt\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("epoch", "<epoch>")
	req.Header.Add("checksum", "<checksum>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://staging-api.chip-in.asia/api/send/send_instructions")
  .header("epoch", "<epoch>")
  .header("checksum", "<checksum>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bank_account_id\": 1,\n  \"amount\": \"100\",\n  \"description\": \"Vendor payout for invoice INV-2024-0892\",\n  \"email\": \"recipient@example.com\",\n  \"reference\": \"INV-2024-0892\",\n  \"send_recipient_receipt\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://staging-api.chip-in.asia/api/send/send_instructions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["epoch"] = '<epoch>'
request["checksum"] = '<checksum>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"bank_account_id\": 1,\n  \"amount\": \"100\",\n  \"description\": \"Vendor payout for invoice INV-2024-0892\",\n  \"email\": \"recipient@example.com\",\n  \"reference\": \"INV-2024-0892\",\n  \"send_recipient_receipt\": true\n}"

response = http.request(request)
puts response.read_body
{
  "id": 50,
  "bank_account_id": 1,
  "amount": "100.00",
  "state": "completed",
  "email": "recipient@example.com",
  "description": "Vendor payout for invoice INV-2024-0892",
  "reference": "INV-2024-0892",
  "send_recipient_receipt": true,
  "created_at": "2023-07-20T10:41:25.190Z",
  "updated_at": "2023-07-20T10:41:25.302Z"
}
{
  "message": "Bad request",
  "code": 400,
  "data": {}
}
{
  "message": "Unauthorized",
  "code": 401,
  "data": {}
}
{
  "message": "You are not authorized to perform this action",
  "code": 403,
  "data": {}
}
{
  "message": "Record not found",
  "code": 404,
  "data": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
epoch
integer<int64>
required

Unix epoch timestamp Unix timestamp (seconds).

Example:

1619740800

​
checksum
string
required

Refer to checksum calculation

Body

application/json

Request body for creating a send instruction.

​
bank_account_id
integer<int64>
required

The ID returned by the Add Bank Account endpoint.

Example:

1

​
amount
string
required

Amount in floating point with maximum of 2 decimal places.

Pattern: ^[0-9]{1,}\.{0,1}[0-9]{0,2}$
Example:

12.44

​
email
string<email>
required
Example:

"recipient@example.com"

​
description
string
required
Example:

"Vendor payout for invoice INV-2024-0892"

​
reference
string
required

Can be any value.

Example:

"INV-2024-0892"

​
send_recipient_receipt
boolean
default:false

When true, a receipt is delivered to the recipient's email. When false (default), no receipt is emailed to the recipient.

Example:

true

Response

Successful response

A send instruction that initiates a payout to a recipient bank account.

​
bank_account_id
integer<int64>
required

The ID returned by the Add Bank Account endpoint.

Example:

1

​
amount
string
required

Amount in floating point with maximum of 2 decimal places.

Pattern: ^[0-9]{1,}\.{0,1}[0-9]{0,2}$
Example:

12.44

​
email
string<email>
required
Example:

"recipient@example.com"

​
description
string
required
Example:

"Vendor payout for invoice INV-2024-0892"

​
reference
string
required

Can be any value.

Example:

"INV-2024-0892"

​
id
integer<int64>
read-only

This ID must be stored for future reference.

Example:

1

​
state
enum<string>
  • received: The instruction has been received, but processing has not started.
  • enquiring: The instruction is pending verification.
  • executing: The instruction is pending execution.
  • reviewing: The instruction requires further attention. Contact your account manager for troubleshooting.
  • accepted: The instruction has been accepted by the service provider but not yet completed. This is commonly related to a beneficiary bank system outage during the request. Successful instructions will be set to completed within 24 hours, while unsuccessful instructions will be reviewed before being marked as rejected.
  • completed: The instruction has completed execution and the recipient should have received the payment.
  • rejected: The instruction has been rejected.
  • deleted: The instruction has been deleted.
Available options:
received,
enquiring,
executing,
reviewing,
accepted,
completed,
rejected,
deleted
​
receipt_url
string
read-only

Generated receipt URL.

Example:

"https://www.chip-in.asia/receipts/send/95712b0c"

​
slug
string
read-only

Generated receipt slug.

Example:

"95712b0c"

​
created_at
string<date-time>
read-only

Object creation time in UTC.

​
updated_at
string<date-time>
read-only

Object updated time in UTC.

​
send_recipient_receipt
boolean

When true, a receipt is delivered to the recipient's email. When false, no receipt is emailed to the recipient.

Example:

true