Update a transfer

PATCHhttps://api.omise.co/transfers/:id

Update transfer status information. This endpoint is primarily used by webhook callbacks to update transfer success/failure status and related details.

---

🔑API Credentials

▼

---

Request Parameters

Required - 1 fieldRequired Parameters

▼

`id`STRING(required)

Transfer ID (e.g., trsf_test_...). Provided in the URL path.

Example:"trsf_test_5xuy4w91xqz7d1w9u0t"

Additional - 3 fieldsAdditional Parameters

▼

`success`BOOLEAN(optional)

Indicates whether the transfer was successful or failed.

Example:true

`failure_code`STRING(optional)

Code indicating the type of failure. Required if success is false.

Example:"insufficient_balance"

Values:insufficient_balance, invalid_recipient, transfers_suspended, transfer_deleted, transfer_sent, transfer_failed

`failure_message`STRING(optional)

Human-readable description of the failure. Provides additional context about what went wrong.

Example:"Insufficient funds to complete the transfer"

---

Responses

200

Successful transaction

Transfer updated successfully. Returns the updated transfer object.

Updated transfer attributes:

• failure_code - Error code if transfer failed
• failure_message - Human-readable failure description
• Other transfer attributes remain unchanged

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Invalid failure_code value
• Missing failure_code when success is false
• Cannot update already completed transfer

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

404

Not found

Transfer not found.

Common causes:

• Invalid transfer ID
• Transfer does not belong to your account
• Transfer has been deleted
• Mixing test and live mode IDs

---

Code samples

cURL

curl https://api.omise.co/transfers/trsf_test_5xuy4w91xqz7d1w9u0t \
  -X PATCH \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "success=false" \
  -d "failure_code=insufficient_balance" \
  -d "failure_message=Insufficient funds to complete the transfer"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

transfer = Omise::Transfer.update('trsf_test_5xuy4w91xqz7d1w9u0t', {
  success: false,
  failure_code: 'insufficient_balance',
  failure_message: 'Insufficient funds to complete the transfer'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

transfer = omise.Transfer.update('trsf_test_5xuy4w91xqz7d1w9u0t',
    success=False,
    failure_code='insufficient_balance',
    failure_message='Insufficient funds to complete the transfer'
)

Node.js

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

const transfer = await omise.transfers.update('trsf_test_5xuy4w91xqz7d1w9u0t', {
  success: false,
  failure_code: 'insufficient_balance',
  failure_message: 'Insufficient funds to complete the transfer'
});

PHP

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

$transfer = OmiseTransfer::retrieve('trsf_test_5xuy4w91xqz7d1w9u0t');
$transfer->update([
    'success' => false,
    'failure_code' => 'insufficient_balance',
    'failure_message' => 'Insufficient funds to complete the transfer'
]);

Java

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

Transfer transfer = client.transfers()
    .update("trsf_test_5xuy4w91xqz7d1w9u0t")
    .success(false)
    .failureCode("insufficient_balance")
    .failureMessage("Insufficient funds to complete the transfer")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var transfer = await client.Transfers.Update("trsf_test_5xuy4w91xqz7d1w9u0t", new UpdateTransferRequest
{
    Success = false,
    FailureCode = "insufficient_balance",
    FailureMessage = "Insufficient funds to complete the transfer"
});

Go

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

transfer, _ := client.Transfers().Update("trsf_test_5xuy4w91xqz7d1w9u0t", &operations.UpdateTransfer{
    Success:        false,
    FailureCode:    "insufficient_balance",
    FailureMessage: "Insufficient funds to complete the transfer",
})

---

Error codes

Failure Codes

Code	Description
insufficient_balance	Not enough funds to complete transfer
invalid_recipient	Recipient ID not found or invalid
transfers_suspended	Transfers disabled on account
transfer_deleted	Transfer was deleted
transfer_sent	Transfer already sent
transfer_failed	Transfer processing failed

---

Try it out

Required - 1 fields

▼

id(Required)

Additional - 3 fields

▼