Choose where deposits go
Chooses the ad account the organization's bank transfers and stablecoin deposits are added to, and returns the funding details.
Tool name: set-ad-account-funding-target.
Chooses the ad account the organization's bank transfers and stablecoin deposits are added to, and returns the funding details.
When to use
Use when the user names the ad account deposits should fund, or get-ad-account-funding shows no target. Later deposits go there, and deposits waiting for a choice are added to it at once.
Access
| Property | Value |
|---|---|
| Required scope | write |
| Publishes | No |
| Read-only | No |
| Destructive | No |
| Idempotent | Yes |
| Open world | Yes |
Input
| Field | Type | Required | Description |
|---|---|---|---|
requestId | string | Yes | The ad account request id, or its Koast reference (KST-…). At most 40 characters. |
adAccountId | string | Yes | The ad account deposits go to, act_…: one of the targets of the funding details. At most 40 characters. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
bank | object | null | Yes | Where to send a US bank transfer in USD: ACH, wire or RTP. Null while bank transfers are not offered. |
crypto | object[] | Yes | One deposit address per stablecoin and network. Only that coin on that network may be sent to it: another coin or network can be lost for good. Empty while crypto is not offered. |
target | object | null | Yes | The ad account deposits go to. Null until one is chosen, when the organization has more than one. |
targets | object[] | Yes | The ad accounts deposits can go to: the organization's shared USD ad accounts. |
minimumCents | integer | Yes | The smallest budget, in USD cents, a deposit is added for without Koast checking it first. |
onHold | boolean | Yes | True while deposits and payments for funds are on hold for the organization. The user contacts Koast support. |
deposits | object[] | Yes | The latest deposits, newest first. |
balances | object[] | Yes | What each of the organization's shared ad accounts has left to spend. |
REST equivalent
PUT /v1/ad-account-funding/target, Choose where deposits go. CLI: koast set-ad-account-funding-target.
Get ad account funding details
Reads the organization's funding details for adding funds to its ad accounts by bank transfer or stablecoin: the bank account to pay and its holder, the USDC and USDT deposit address per network, the ad account deposits go to, the latest deposits with what each added, and what each shared ad account has left to spend.
Add ad account funds
Starts adding funds to an ad account from an ad account request: prices the budget plus Koast's fee and the platform location fee, and returns the payment page (checkoutUrl) the user must open to pay.