Skip to main content
POST
/
businesses
/
{id}
/
financialAccounts
Add a business financial account
curl --request POST \
  --url https://api.guile.app/businesses/{id}/financialAccounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account": {
    "id": "<string>",
    "accessToken": "<string>"
  },
  "isDefault": true
}
'
{
  "routingNumber": "<string>",
  "type": "checking",
  "isDefault": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "maskedAccountNumber": "<string>",
  "eligiblePayoutMethods": [
    "standard"
  ],
  "financialInstitutionName": "<string>"
}

Path Parameters

​
id
string<uuid>
required

The payment processor business identifier. The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

Body

application/json

Properties required to add a linked financial account within the Guile platform.

​
account
object
required

Representation of an account to add for the business.

​
isDefault
boolean

Indicates whether this account is the default account.

Response

Created.

A read-only reference to a financial account.

​
routingNumber
string
required

The routing and transit number associated with the financial account.

​
type
enum<string>
required

The type of financial account.

Available options:
checking,
savings,
moneyMarket,
cashManagement
​
isDefault
boolean
required

Indicates whether this financial account is the default financial account.

​
id
string<uuid>
required

The unique identifier for the financial account reference.

​
maskedAccountNumber
string
required

The masked financial account number. The last 4 digits of the account are unmasked.

​
eligiblePayoutMethods
enum<string>[]
required

Supported payout methods for this financial account.

The method used for the payout. Standard typically means T+2 days through ACH batch processing. Instant expediates payments for an additional processing fee. Instant payouts be be limited based on availability and other factors.

Available options:
standard,
instant
​
financialInstitutionName
string

The name of the financial institution for this account, if available.