---
# @generated by sylphx-gen. Do not edit.
title: "Get a bank transfer account"
description: "`money.bank_transfer_accounts.get` (GET /v1/{name}): GetBankTransferAccount through the project-scoped bank transfer API."
type: reference
product: payments
summary: "GetBankTransferAccount through the project-scoped bank transfer API."
updated: 2026-09-28
nav: false
---

GetBankTransferAccount through the project-scoped bank transfer API.

- **Path** `GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/bank_transfer_accounts/bank-transfer-account`
- **Scope** `billing:read`
- **Effect** `read` — nothing is written.
- **Collection** [bank_transfer_accounts](/docs/api/bank_transfer_accounts)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | BankTransferAccount name, ending in default. Required. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | Resource name. |
| `uid` | `string` | Stable resource identity. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. Output only. |
| `account_holder` | `string` | Verified beneficiary name. Required. |
| `bank_name` | `string` | Receiving bank name. Required. |
| `bank_code` | `string` | Receiving bank routing or clearing code. Required. |
| `account_number` | `string` | Receiving account number, including branch digits. Required. |
| `fps_id` | `string` | Verified FPS identifier displayed to the payer. |
| `fps_qr_payload` | `string` | Original bank-issued FPS Common QR payload; never an invented account template. |
| `currency_code` | `string` | ISO 4217 receiving account currency. Required. |
| `enabled` | `bool` | Whether new bank-transfer checkouts may be created. |
| `region_code` | `string` | ISO 3166-1 alpha-2 country of the receiving bank. Required. |
| `qr_profile` | `string` | Optional EMV merchant-presented QR country profile: hk_fps. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`INVALID_STATE`](/docs/api/errors/INVALID_STATE) — The Resource is in a state that forbids the call.
- [`ETAG_MISMATCH`](/docs/api/errors/ETAG_MISMATCH) — The etag sent does not match the Resource's current etag.
- [`UNAVAILABLE`](/docs/api/errors/UNAVAILABLE) — The Resource store, the owning service's backend, or the key verifier's snapshot is unavailable; retry after Retry-After.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/bank_transfer_accounts/bank-transfer-account" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

```ts
const response = await sylphx.money.bankTransferAccounts.get({ name: 'orgs/acme/projects/shop/envs/production/bank_transfer_accounts/bank-transfer-account' })
```

**Rust**

```rust
let mut req = sylphx::money::GetBankTransferAccountRequest::default();
req.name = "orgs/acme/projects/shop/envs/production/bank_transfer_accounts/bank-transfer-account".to_string();
let response = sx.money().bank_transfer_accounts().get(req).await?;
```

**CLI**

```bash
sylphx money bank-transfer-accounts get orgs/acme/projects/shop/envs/production/bank_transfer_accounts/bank-transfer-account
```

**MCP**

```json
{ "method_id": "money.bank_transfer_accounts.get", "args": {"name":"orgs/acme/projects/shop/envs/production/bank_transfer_accounts/bank-transfer-account"} }
```