# Xfers Intents API

**Canonical:** https://apis.io/apis/xfers/xfers-intents-api/  
**Provider:** Xfers — https://apis.io/providers/xfers/  
**Base URL:** https://www.xfers.io/api  
**Documentation:** https://docs.xfers.io/Singapore

Xfers Intents API is one of 20 APIs that [Xfers](https://apis.io/providers/xfers/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Intents. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

**For user case 1:** When a user is performing a top-up via [GET /transfer_info](http://docs.xfers.io/#get-transfer-info), they might forget to enter their contact number which is needed for our system to identify them. The Intents API solves this issue by requiring the user to transfer a unique amount to Xfers which will be used to identify them. The difference between the `unique_amount` and the actual `amount` will be very small, and Xfers provides the difference for free to the user. Note that this only acts as a backup, and the user should enter his contact number in the comments section when doing a bank transfer whenever possible. Example: Jane wishes to transfer 5000 Indonesian Rupiah via `/intents`. 1. She makes a HTTP GET request to `/user/transfer_info` to get the correct Xfers bank to transfer to (we have many banks!). The response tells her to transfer to Bank Central Asia (BCA). 2. She makes a HTTP POST request to create an intent. The response tells her to make a bank transfer of 4999 to Xfers. 3. Jane makes a transfer of 4999 to Xfers BCA. Within a few minutes, Xfers detects the transfer and tops up Jane’s Xfers account with 5000. Xfers absorbs the difference for free. 4. If `notify_url` is given, Xfers will send a callback to this url. Note the above scenario is only valid when disable_va is set to True **For user case 2:** Intent can also be use a means to get callback notifications from Xfers when a user successfully fund their virtual account on Xfers. Example: Jane wishes to transfer 5000 Indonesian Rupiah via `/intents` to her virtual Xfers account and get a callback notification when it successful 1. She makes a HTTP POST request to create an intent with disable_va set to false(default) and provide a `notify_url`. The response will provide a list of virtual account nos she can fund her account with from a list of bank that Xfers support. 2. Jane makes a transfer of 500 to the Xfers BCA Virtual account that the intent api provide. Within a few minutes, Xfers detects the transfer and tops up Jane’s Xfers account with 5000. 3. Since `notify_url` is provided, Xfers will send a callback to this url.

## Machine-readable artifacts (4)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/xfers/refs/heads/main/openapi/xfers-intents-api-openapi.yml
- **Documentation** — https://docs.xfers.io/Singapore
- **Documentation** — https://docs.xfers.io/V3/Indonesia
- **Documentation** — https://docs.xfers.io/indonesia/payment-gateway

## Other Xfers APIs (12)

- [Xfers Bank Account API](https://apis.io/apis/xfers/xfers-bank-account-api/)
- [Xfers Charge API](https://apis.io/apis/xfers/xfers-charge-api/)
- [Xfers Convenience Store Transfers API](https://apis.io/apis/xfers/xfers-convenience-store-transfers-api/)
- [Xfers cutting_edge API](https://apis.io/apis/xfers/xfers-cutting-edge-api/)
- [Xfers Direct Bank Transfer Payments API](https://apis.io/apis/xfers/xfers-direct-bank-transfer-payments-api/)
- [Xfers Disbursements API](https://apis.io/apis/xfers/xfers-disbursements-api/)
- [Xfers E-signature API](https://apis.io/apis/xfers/xfers-e-signature-api/)
- [Xfers Fixed Virtual Account Bank Transfers API](https://apis.io/apis/xfers/xfers-fixed-virtual-account-bank-transfers-api/)
- [Xfers Loans API](https://apis.io/apis/xfers/xfers-loans-api/)
- [Xfers Modify Payments API](https://apis.io/apis/xfers/xfers-modify-payments-api/)
- [Xfers Payment Queries API](https://apis.io/apis/xfers/xfers-payment-queries-api/)
- [Xfers Payment Queries (Hide first) API](https://apis.io/apis/xfers/xfers-payment-queries-hide-first-api/)

## Tags

Intents

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/xfers/xfers-intents-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/xfers/.