Create a transfer with chain

POSThttps://api.omise.co/transfers

Create a transfer with merchant_id parameter to link it to a charge chain. This enables manual marketplace transfers with full control over timing and amount.

---

🔑API Credentials

▼

---

Request Parameters

Required - 2 fieldsRequired Parameters

▼

`amount`INTEGER(required)

Transfer amount in smallest currency unit (satangs for THB, cents for USD, yen for JPY).

Example:85000

Constraints:Minimum: 1 (smallest unit)

`recipient`STRING(required)

Recipient ID to receive the transfer. Must be a verified recipient.

Example:"recp_test_5xuy4w91xqz7d1w9u0t"

Recommended - 1 fieldRecommended Parameters

▼

Additional - 1 fieldAdditional Parameters

▼

---

Responses

200

Successful creation

Transfer created successfully. The transfer will be sent to the recipient's bank account within 24 hours.

Response includes:

• id - Transfer ID
• amount - Transfer amount
• recipient - Recipient ID
• sent - Whether transfer has been sent to bank
• paid - Whether recipient has received funds

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Missing required fields (amount, recipient)
• Invalid amount (negative or zero)
• Invalid recipient ID format
• Invalid merchant_id (charge ID) format

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

422

Unprocessable entity

Transfer cannot be processed due to business logic constraints.

Common causes:

• Insufficient balance for transfer
• Recipient not verified
• Recipient inactive or revoked
• Transfer amount exceeds limits

---

Code samples

cURL

curl https://api.omise.co/transfers \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "amount=85000" \
  -d "recipient=recp_test_5xuy4w91xqz7d1w9u0t" \
  -d "merchant_id=chrg_test_5xuy4w91xqz7d1w9u0t"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

transfer = Omise::Transfer.create({
  amount: 85000,
  recipient: 'recp_test_5xuy4w91xqz7d1w9u0t',
  merchant_id: 'chrg_test_5xuy4w91xqz7d1w9u0t'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

transfer = omise.Transfer.create(
    amount=85000,
    recipient='recp_test_5xuy4w91xqz7d1w9u0t',
    merchant_id='chrg_test_5xuy4w91xqz7d1w9u0t'
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const transfer = await omise.transfers.create({
  amount: 85000,
  recipient: 'recp_test_5xuy4w91xqz7d1w9u0t',
  merchant_id: 'chrg_test_5xuy4w91xqz7d1w9u0t'
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$transfer = OmiseTransfer::create([
    'amount' => 85000,
    'recipient' => 'recp_test_5xuy4w91xqz7d1w9u0t',
    'merchant_id' => 'chrg_test_5xuy4w91xqz7d1w9u0t'
]);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Transfer transfer = client.transfers().create()
    .amount(85000L)
    .recipient("recp_test_5xuy4w91xqz7d1w9u0t")
    .merchantId("chrg_test_5xuy4w91xqz7d1w9u0t")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var transfer = await client.Transfers.Create(new CreateTransferRequest
{
    Amount = 85000,
    Recipient = "recp_test_5xuy4w91xqz7d1w9u0t",
    MerchantId = "chrg_test_5xuy4w91xqz7d1w9u0t"
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

transfer, _ := client.Transfers().Create(&operations.CreateTransfer{
    Amount:     85000,
    Recipient:  "recp_test_5xuy4w91xqz7d1w9u0t",
    MerchantId: "chrg_test_5xuy4w91xqz7d1w9u0t",
})

---

Error and result codes

Common Error Codes

Code	Description	Resolution
bad_request	Missing or invalid parameters	Check all required fields are provided
authentication_failure	Invalid API key	Verify your secret key is correct
insufficient_balance	Not enough balance for transfer	Check account balance
recipient_not_verified	Recipient not verified	Recipient must be verified before receiving transfers
recipient_inactive	Recipient is inactive	Check recipient status

Transfer Status Fields

Field	Description
sent	Whether transfer has been sent to bank (false = pending, true = sent)
paid	Whether recipient has received funds (false = in transit, true = completed)
sent_at	Timestamp when transfer was sent to bank
paid_at	Timestamp when recipient received funds

---

Try it out

Required - 2 fields

▼

amount(Required)

recipient(Required)

Recommended - 1 fields

▼

Additional - 1 fields

▼