Simulate an App Deposit (Sandbox)
Sandbox only. Credits the App as if a deposit reached its ACH deposit details, through the same refill path a real deposit takes. Creates Sandbox deposit details first if the App has none. Requires organization credentials.
Sandbox only. Credits the App as if a deposit reached its ACH deposit details, through the same refill path a real deposit takes. Creates Sandbox deposit details first if the App has none.
Requires organization credentials.
api_keyAuthorizationBasic <token>app_id*stringId of the App
uuidapplication/json- body
amount*integerAmount in cents, up to $1,000,000.
1 <= value <= 100000000rail?stringHow the deposit arrives. Deposit details generated in the
Dashboard accept ach and rtp. Details set up by Dots for
wire funding accept ach and wire.
"ach""ach""wire""rtp"returned?booleanReturn the deposit after it credits the App. The refill fails and the credit is taken back out of the App's wallet.
falseThe refill, completed or, when returned is set, failed.
application/json- response
id?stringuuidcreated?stringdate-timeuser_id?stringuuidstatus?string"created""pending""failed""completed""reversed""canceled""flagged"error?stringWhy this transfer failed, as a stable Dots code. These codes are ours, not the payout provider's, so they stay the same no matter how a payout is routed. Branch on this rather than on error_message.
account_closed- the receiving account is closedaccount_not_found- the receiving account could not be foundinvalid_account_details- the receiving account details are invalid; collect them againname_mismatch- the recipient's name does not match the name on the receiving accountaccount_blocked- the receiving account cannot accept this transfertransfer_refused- the receiving bank refused the transferinsufficient_funds- the account had insufficient fundslimit_exceeded- the transfer exceeds a limit on the receiving accountamount_too_small- the amount is below the minimum for this destinationamount_too_large- the amount is above the maximum for this destinationdestination_not_supported- this payout destination is not supported; the recipient needs a different payout methodrecipient_info_required- more recipient information is required before this transfer can be sentrecipient_action_required- the recipient must sign in to their payout account and choose how to receive this transferrecipient_account_incomplete- the recipient must finish setting up or verifying their external payout account, outside of Dots, before they can receive this transferdeclined_for_risk- the transfer was declinedcard_unusable- the receiving card cannot accept this transfertemporarily_unavailable- the transfer could not be completed; retrying may succeedunknown- the transfer could not be completed, and we have no more specific code for it New codes may be added over time, so treat an unrecognized code the way you treatunknown. Omitted entirely when the transfer has no error, and always present whenerror_messageis.
"account_closed""account_not_found""invalid_account_details""name_mismatch""account_blocked""transfer_refused""insufficient_funds""limit_exceeded""amount_too_small""amount_too_large""destination_not_supported""recipient_info_required""recipient_action_required""recipient_account_incomplete""declined_for_risk""card_unusable""temporarily_unavailable""unknown"error_message?stringWhy this transfer failed, as a sanitized message safe to show to the recipient.
The wording is not part of the API contract and may change at any time, so do not parse it or compare against it. Branch on error instead.
Omitted entirely when the transfer has no error.
sender_details?|Who sent the money for a refill that arrived from an outside bank account by ACH, RTP, FedNow or wire, as reported by the sending bank.
Only present on refill transfers. null when no sender details were reported, such as for a wire Dots credited manually or a refill you created through the API. Any field may be null when the sending bank did not report it.
type?stringThe type of this transfer.
refill- refill of an API App or Organization's Dots Walletpayout- payout to a Userbalance- balance transfer between Dots Wallets, such as from an API App to a User's Dots Walletpayment- payment from a User to an API Appverification_debit- $1 debit from a User's bank account that verifies it during onboardingsettlement- legacy, currently unusedpayable- payable for Accounts Payable
"refill""payout""balance""payment""verification_debit""settlement""payable"amount?stringTransfer amount in cents.
external_data?transactions?array<>payout_link_id?stringID of the payout-link that the transfer belongs to.
uuidmetadata?||Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
curl -X POST 'https://api.dots.dev/api/v2/apps/497f6eca-6276-4993-bfeb-53cbbbba6f08/simulate/deposit' \ -H 'Content-Type: application/json' \ -d '{ "amount": 1}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created": "2019-08-24T14:15:22Z", "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5", "status": "created", "error": "account_closed", "error_message": "string", "sender_details": { "name": "string", "bank_name": "string", "routing_number": "string", "account_number_last4": "string", "company_identification": "string", "trace_number": "string", "reference": "string", "memo": "string" }, "type": "refill", "amount": "string", "external_data": { "account_id": "string", "external_id": "string", "platform": "ach" }, "transactions": [ { "id": 0, "amount": "string", "created": "2019-08-24T14:15:22Z", "source_name": "string", "destination_name": "string", "type": "balance", "metadata": "string", "transfer_id": "d4a2d8dd-7def-4545-a062-761683b9aa05", "transfer": {} } ], "payout_link_id": "50673cb3-bf8b-4fdc-9f5f-114b168da4ab", "metadata": "string"}Get App ACH Deposit Details
Bank details for funding an App's wallet by ACH or wire. Send these to your finance team or your bank; deposits arrive in the App's wallet. Requires organization credentials. The App must be enrolled for deposits; contact support if it is not.
Retrieve Organization Details
Get details about the authenticated organization, including its current balance.