Retrieve a transfer

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

Retrieve details of a specific transfer using its ID. Returns the transfer object including status, amount, recipient information, and timestamps.

---

Request Parameters

Required - 1 fieldRequired Parameters

▼

`id`STRING(required)

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

Example:"trsf_test_5xuy4w91xqz7d1w9u0t"

---

Responses

200

Successful transaction

Transfer retrieved successfully. Returns complete transfer object with all attributes.

Returned transfer attributes:

• object - Always "transfer"
• id - Transfer identifier (pattern: trsf_test_* or trsf_*)
• livemode - Boolean indicating live (true) or test (false) mode
• amount - Transfer amount in smallest currency unit
• currency - Three-letter ISO 4217 currency code
• fee - Omise transfer fee in smallest currency unit
• total_fee - Fee plus VAT in smallest currency unit
• net - Amount minus total_fee (actual amount recipient receives)
• recipient - Recipient object or ID (expandable)
• bank_account - Destination bank account details
• sendable - Boolean indicating if transfer can be sent
• sent - Boolean indicating if transfer has been sent
• paid - Boolean indicating if transfer has been paid
• fail_fast - Boolean indicating retry behavior on failure
• failure_code - Error code if transfer failed
• failure_message - Error message if transfer failed
• metadata - Custom key-value pairs
• created_at - ISO 8601 creation timestamp
• sent_at - ISO 8601 timestamp when transfer was sent
• paid_at - ISO 8601 timestamp when transfer was paid

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

5xx

Server error

Server-side error occurred. These are rare but should be handled gracefully.

How to handle:

• Retry the request with exponential backoff
• Check status.omise.co for service incidents
• See Error Handling for detailed guidance

---

Code samples

cURL

curl https://api.omise.co/transfers/trsf_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

transfer = Omise::Transfer.retrieve('trsf_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

transfer = omise.Transfer.retrieve('trsf_test_5xuy4w91xqz7d1w9u0t')

Node.js

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

const transfer = await omise.transfers.retrieve('trsf_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$transfer = OmiseTransfer::retrieve('trsf_test_5xuy4w91xqz7d1w9u0t');

Java

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

Transfer transfer = client.transfers()
    .get("trsf_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var transfer = await client.Transfers.Get("trsf_test_5xuy4w91xqz7d1w9u0t");

Go

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

transfer, _ := client.Transfers().Get("trsf_test_5xuy4w91xqz7d1w9u0t")

---

🔑API Credentials

▼

Try it out

Required - 1 fields

▼

id(Required)

Your IP: ...Loading...