Transfers API
The Transfers API allows you to transfer funds from your Omise account balance to recipient bank accounts. Transfers are the final step in the payout process, moving funds to merchants, vendors, or individuals.
Overviewโ
Transfers enable you to:
- Send funds to recipients - Transfer money from your Omise balance to bank accounts
- Schedule payouts - Control when funds are sent to recipients
- Track transfer status - Monitor pending, sent, paid, and failed transfers
- Manage metadata - Attach custom data for reconciliation and reporting
- Handle failures - Identify and retry failed transfers
Transfer Lifecycleโ
- Create - Initiate a transfer to a recipient
- Pending - Transfer is queued for processing
- Sent - Transfer has been submitted to the banking system
- Paid - Funds successfully reached the recipient's bank account
- Failed - Transfer failed (insufficient balance, invalid account, etc.)
Key Conceptsโ
Recipientsโ
Transfers require a recipient - a verified bank account destination. You must create a recipient before initiating transfers.
Balance Requirementsโ
Transfers deduct from your available balance. Ensure sufficient funds before creating transfers.
Processing Timeโ
- Thailand: 1-2 business days for local bank transfers
- International: 3-7 business days depending on destination country
Transfer Limitsโ
Transfer limits depend on your account settings and recipient verification status. Contact support for custom limits.
Authenticationโ
All transfer endpoints require your secret key for authentication. Never expose your secret key in client-side code.
Available Endpointsโ
| Method | Endpoint | Description |
|---|---|---|
| POST | /transfers | Create a new transfer |
| GET | /transfers/:id | Retrieve a specific transfer |
| GET | /transfers | List all transfers |
| PATCH | /transfers/:id | Update a transfer |
| DELETE | /transfers/:id | Cancel a pending transfer |
Common Use Casesโ
Marketplace Payoutsโ
Transfer funds to sellers after successful transactions with automatic fee deductions.
Affiliate Commissionsโ
Schedule monthly transfers to affiliates based on performance metrics stored in metadata.
Refunds to Bank Accountsโ
Process refunds directly to customer bank accounts instead of original payment method.
Vendor Paymentsโ
Pay suppliers and vendors with automated transfers integrated with your accounting system.
Best Practicesโ
- Verify recipients before initiating transfers
- Check balance to ensure sufficient funds
- Use metadata for reconciliation and tracking
- Implement webhooks to monitor transfer status changes
- Handle failures gracefully with retry logic
- Test thoroughly in test mode before processing live transfers
Related Resourcesโ
- Recipients API - Manage recipient bank accounts
- Balance API - Check available balance
- Transactions API - View transaction history
- Webhooks - Receive transfer status updates
Need help? Contact support@omise.co for transfer limits, processing times, or integration assistance.