Skip to content
Console
Menu

Alerts and status pages

App store purchases

Credits

Knowledge

KV

Notifications

Organizations

Storage

Workflows

API reference

Getting Started

Authentication

KV Store

Bank transfer accounts

Receiving bank account configuration for one environment.

Receiving bank account configuration for one environment.

Service Sylphx Money · Resource type money.sylphx.com/BankTransferAccount · Name pattern orgs/{org}/projects/{project}/envs/{env}/bank_transfer_accounts/{bank_transfer_account} · Shape singleton

#Fields

FieldTypeWhat it is
namestringResource name.
uidstringStable resource identity. Output only.
metaResourceMetaResource metadata. Output only.
account_holderstringVerified beneficiary name. Required.
bank_namestringReceiving bank name. Required.
bank_codestringReceiving bank routing or clearing code. Required.
account_numberstringReceiving account number, including branch digits. Required.
fps_idstringVerified FPS identifier displayed to the payer.
fps_qr_payloadstringOriginal bank-issued FPS Common QR payload; never an invented account template.
currency_codestringISO 4217 receiving account currency. Required.
enabledboolWhether new bank-transfer checkouts may be created.
region_codestringISO 3166-1 alpha-2 country of the receiving bank. Required.
qr_profilestringOptional EMV merchant-presented QR country profile: hk_fps.

#Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGetBankTransferAccount through the project-scoped bank transfer API.
PATCHupdateUpdateBankTransferAccount through the project-scoped bank transfer API.

#get

GetBankTransferAccount through the project-scoped bank transfer API.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/bank_transfer_accounts/bank-transfer-account · scope billing:read · effect read · Request, response and examples

#update

UpdateBankTransferAccount through the project-scoped bank transfer API.

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/bank_transfer_accounts/bank-transfer-account · scope billing:bank_accounts:write · effect write · Request, response and examples