data
Dwolla Lua API for KosmoKrator Agents
Agent-facing Lua documentation and function reference for the Dwolla KosmoKrator integration.Lua Namespace
Agents call this integration through app.integrations.dwolla.*.
Use lua_read_doc("integrations.dwolla") inside KosmoKrator to discover the same reference at runtime.
Call Lua from the Headless CLI
Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic
Dwolla workflow without starting an interactive agent session.
kosmo integrations:lua --eval 'dump(app.integrations.dwolla.create_application_access_token({body = "example_body"}))' --json kosmo integrations:lua --eval 'print(docs.read("dwolla"))' --json
kosmo integrations:lua --eval 'print(docs.read("dwolla.create_application_access_token"))' --json Workflow file
Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.
local dwolla = app.integrations.dwolla
local result = dwolla.create_application_access_token({body = "example_body"})
dump(result) kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json integrations:lua exposes app.integrations.dwolla, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.dwolla.default.* or app.integrations.dwolla.work.* when you configured named credential accounts.
MCP-only Lua
If the script only needs configured MCP servers and does not need Dwolla, use the narrower mcp:lua command.
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json Agent-Facing Lua Docs
This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.
Dwolla Integration
Use the dwolla integration to manage Dwolla customers, beneficial owners, documents, funding sources, transfers, mass payments, labels, events, webhook subscriptions, exchanges, KBA sessions, and sandbox simulations.
All endpoint tools are generated from Dwolla’s official OpenAPI repository at https://github.com/Dwolla/dwolla-openapi. Runtime API calls use Authorization: Bearer <access_token>. dwolla_create_application_access_token uses OAuth client credentials with Basic authentication and a form-encoded body.
Common Tools
dwolla_create_application_access_tokenexchangesclient_idandclient_secretfor an OAuth access token.dwolla_list_and_search_customers,dwolla_create_customer,dwolla_get_customer, anddwolla_updatecover customer lifecycle operations.- Beneficial owner, document, funding source, transfer, mass payment, webhook subscription, event, exchange, label, KBA, and sandbox simulation tools map directly to the official Dwolla API paths.
- Multipart document upload tools accept local file paths in the
bodyobject for file fields.
Request Shape
Path, query, and header parameters are exposed as snake_case tool parameters. JSON, Dwolla HAL JSON, form-encoded, and multipart request bodies are passed through the body object and should match the official Dwolla schema for the endpoint.
Return Shape
JSON responses are returned as decoded arrays/objects from Dwolla. Empty successful responses return { success = true, status = <http_status>, location = <location_header> } when a Location header is present.
Examples
local root = app.integrations.dwolla.get_root({})
local customers = app.integrations.dwolla.list_and_search_customers({
limit = 25,
search = "example"
})
local token = app.integrations.dwolla.create_application_access_token({
body = { grant_type = "client_credentials" }
})
Use fake customer IDs, funding source IDs, transfer IDs, document paths, webhook URLs, client IDs, and access tokens in tests and examples. Never store real bank, customer, routing, account, SSN, OAuth, or webhook-secret data in fixtures or Lua examples.
Raw agent markdown
# Dwolla Integration
Use the `dwolla` integration to manage Dwolla customers, beneficial owners, documents, funding sources, transfers, mass payments, labels, events, webhook subscriptions, exchanges, KBA sessions, and sandbox simulations.
All endpoint tools are generated from Dwolla's official OpenAPI repository at `https://github.com/Dwolla/dwolla-openapi`. Runtime API calls use `Authorization: Bearer <access_token>`. `dwolla_create_application_access_token` uses OAuth client credentials with Basic authentication and a form-encoded body.
## Common Tools
- `dwolla_create_application_access_token` exchanges `client_id` and `client_secret` for an OAuth access token.
- `dwolla_list_and_search_customers`, `dwolla_create_customer`, `dwolla_get_customer`, and `dwolla_update` cover customer lifecycle operations.
- Beneficial owner, document, funding source, transfer, mass payment, webhook subscription, event, exchange, label, KBA, and sandbox simulation tools map directly to the official Dwolla API paths.
- Multipart document upload tools accept local file paths in the `body` object for file fields.
## Request Shape
Path, query, and header parameters are exposed as snake_case tool parameters. JSON, Dwolla HAL JSON, form-encoded, and multipart request bodies are passed through the `body` object and should match the official Dwolla schema for the endpoint.
## Return Shape
JSON responses are returned as decoded arrays/objects from Dwolla. Empty successful responses return `{ success = true, status = <http_status>, location = <location_header> }` when a Location header is present.
## Examples
```lua
local root = app.integrations.dwolla.get_root({})
local customers = app.integrations.dwolla.list_and_search_customers({
limit = 25,
search = "example"
})
local token = app.integrations.dwolla.create_application_access_token({
body = { grant_type = "client_credentials" }
})
```
Use fake customer IDs, funding source IDs, transfer IDs, document paths, webhook URLs, client IDs, and access tokens in tests and examples. Never store real bank, customer, routing, account, SSN, OAuth, or webhook-secret data in fixtures or Lua examples. local result = app.integrations.dwolla.create_application_access_token({body = "example_body"})
print(result) Functions
create_application_access_token Write
Generate an application access token using OAuth 2.0 client credentials flow for server-to-server authentication. Requires client ID and secret sent via Basic authentication header with grant_type=client_credentials in the request body. Returns a bearer access token with expiration time for authenticating API requests scoped to your application. Essential for secure API access. Official Dwolla endpoint: POST /token.
- Lua path
app.integrations.dwolla.create_application_access_token- Full name
dwolla.dwolla_create_application_access_token
| Parameter | Type | Required | Description |
|---|---|---|---|
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
get_root Read
Retrieve the API root entry point to discover available resources and endpoints based on your OAuth access token permissions. Returns HAL+JSON with navigation links to accessible resources including accounts, customers, events, and webhook subscriptions depending on token scope. Essential for API exploration, dynamic resource discovery, and building adaptive client applications that respond to available permissions. Official Dwolla endpoint: GET /.
- Lua path
app.integrations.dwolla.get_root- Full name
dwolla.dwolla_get_root
| Parameter | Type | Required | Description |
|---|---|---|---|
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
get_account Read
Returns basic account information for your authorized Main Dwolla Account, including account ID, name, and links to related resources such as funding sources, transfers, and customers. Official Dwolla endpoint: GET /accounts/{id}.
- Lua path
app.integrations.dwolla.get_account- Full name
dwolla.dwolla_get_account
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Account's unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
create_funding_source Write
Create a funding source by adding a bank account to a Main Dwolla Account. This endpoint allows you to connect a checking or savings account using either manual bank account details or an exchange resource. For more information about funding sources, see the [Funding Sources API Reference](https://developers.dwolla.com/docs/api-reference/funding-sources). Official Dwolla endpoint: POST /funding-sources.
- Lua path
app.integrations.dwolla.create_funding_source- Full name
dwolla.dwolla_create_funding_source
| Parameter | Type | Required | Description |
|---|---|---|---|
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
list_funding_sources Read
Get a list of all funding sources associated with a specific Main Dwolla Account. This endpoint returns both bank accounts and balance funding sources, with detailed information about each funding source's status, type, and available processing channels. Official Dwolla endpoint: GET /accounts/{id}/funding-sources.
- Lua path
app.integrations.dwolla.list_funding_sources- Full name
dwolla.dwolla_list_funding_sources
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Account's unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
removed | string | no | Filter removed funding sources. Boolean value. Defaults to `true` |
list_and_search_transfers Read
Returns a paginated, searchable list of transfers associated with the specified Main Dwolla account. Supports advanced filtering by amount range, date range, transfer status, and correlation ID. Results are limited to 10,000 transfers per query; use date range filters for historical data beyond this limit. Official Dwolla endpoint: GET /accounts/{id}/transfers.
- Lua path
app.integrations.dwolla.list_and_search_transfers- Full name
dwolla.dwolla_list_and_search_transfers
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Account's unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
search | string | no | A string to search on fields `firstName`, `lastName`, `email`, `businessName`, Customer ID, and Account ID |
start_amount | string | no | Only include transactions with an amount equal to or greater than `startAmount` |
end_amount | string | no | Only include transactions with an amount equal to or less than `endAmount` |
start_date | string | no | Only include transactions created after this date. ISO-8601 format `YYYY-MM-DD` |
end_date | string | no | Only include transactions created before this date. ISO-8601 format `YYYY-MM-DD` |
status | string | no | Filter on transaction status. Possible values are `pending`, `processed`, `failed`, or `cancelled` |
correlation_id | string | no | A string value to search on if `correlationId` was specified for a transaction |
limit | string | no | Number of search results to return. Defaults to 25 |
offset | string | no | Number of search results to skip. Use for pagination |
list_mass_payments Read
Returns a paginated list of mass payments created by your Main Dwolla account. Results are sorted by creation date in descending order (newest first) and can be filtered by correlation ID. Official Dwolla endpoint: GET /accounts/{id}/mass-payments.
- Lua path
app.integrations.dwolla.list_mass_payments- Full name
dwolla.dwolla_list_mass_payments
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Account's unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
limit | number | no | Maximum number of results to return |
offset | number | no | How many results to skip. |
correlation_id | string | no | Correlation ID to search by. |
list_and_search_customers Read
Returns a paginated list of customers sorted by creation date. Supports fuzzy search across customer names, business names, and email addresses, plus exact filtering by email and verification status. Default limit is 25 customers per page, maximum 200. Official Dwolla endpoint: GET /customers.
- Lua path
app.integrations.dwolla.list_and_search_customers- Full name
dwolla.dwolla_list_and_search_customers
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | number | no | How many results to return |
offset | number | no | How many results to skip |
search | string | no | Searches on certain fields |
status | string | no | Filter by customer status |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
create_customer Write
Creates a new customer with different verification levels and capabilities. Supports personal verified customers (individuals), business verified customers (businesses), unverified customers, and receive-only users. Customer type determines transaction limits, verification requirements, and available features. Official Dwolla endpoint: POST /customers.
- Lua path
app.integrations.dwolla.create_customer- Full name
dwolla.dwolla_create_customer
| Parameter | Type | Required | Description |
|---|---|---|---|
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
get_customer Read
Retrieve identifying information for a specific customer. The returned data varies by customer type - verified customers include contact details, address information, and verification status, while unverified customers and receive-only users contain basic contact information only. Official Dwolla endpoint: GET /customers/{id}.
- Lua path
app.integrations.dwolla.get_customer- Full name
dwolla.dwolla_get_customer
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Customer unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
update Read
Update Customer information, upgrade an unverified Customer to a verified Customer, suspend a Customer, deactivate a Customer, reactivate a Customer, and update a verified Customer's information to retry verification. Official Dwolla endpoint: POST /customers/{id}.
- Lua path
app.integrations.dwolla.update- Full name
dwolla.dwolla_update
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Customer unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
list_business_classifications Read
Returns a directory of business and industry classifications required for creating business verified customers. Each business classification contains multiple industry classifications. The industry classification ID must be provided in the businessClassification parameter during business customer creation for verification. Official Dwolla endpoint: GET /business-classifications.
- Lua path
app.integrations.dwolla.list_business_classifications- Full name
dwolla.dwolla_list_business_classifications
| Parameter | Type | Required | Description |
|---|---|---|---|
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
retrieve_business_classification Read
Returns a specific business classification with its embedded industry classifications. Use this endpoint to browse available industry options within a business category and obtain the industry classification ID required for the businessClassification parameter when creating business verified customers. Official Dwolla endpoint: GET /business-classifications/{id}.
- Lua path
app.integrations.dwolla.retrieve_business_classification- Full name
dwolla.dwolla_retrieve_business_classification
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | business classification unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
list_beneficial_owners_customer Read
Returns all beneficial owners associated with a business verified customer. Beneficial owners are individuals who directly or indirectly own 25% or more of the company's equity. Includes personal information, verification status, and address details for each owner. Official Dwolla endpoint: GET /customers/{id}/beneficial-owners.
- Lua path
app.integrations.dwolla.list_beneficial_owners_customer- Full name
dwolla.dwolla_list_beneficial_owners_for_customer
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Customer unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
create_beneficial_owner_customer Write
Creates a new beneficial owner for a business verified customer. Beneficial owners are individuals who own 25% or more of the company's equity. Requires personal information, address, and SSN or passport for identity verification. Official Dwolla endpoint: POST /customers/{id}/beneficial-owners.
- Lua path
app.integrations.dwolla.create_beneficial_owner_customer- Full name
dwolla.dwolla_create_beneficial_owner_for_customer
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Customer ID for which to create a Beneficial Owner |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
retrieve_beneficial_owner Read
Returns detailed information for a specific beneficial owner, including personal information, address, and verification status. The verification status indicates the owner's identity verification progress and affects the business customer's transaction capabilities. Official Dwolla endpoint: GET /beneficial-owners/{id}.
- Lua path
app.integrations.dwolla.retrieve_beneficial_owner- Full name
dwolla.dwolla_retrieve_beneficial_owner
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Beneficial owner unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
update_beneficial_owner Write
Updates a beneficial owner's information to retry verification when their status is "incomplete". Only beneficial owners with incomplete verification status can be updated. Used to correct information that caused initial verification to fail. Official Dwolla endpoint: POST /beneficial-owners/{id}.
- Lua path
app.integrations.dwolla.update_beneficial_owner- Full name
dwolla.dwolla_update_beneficial_owner
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Beneficial owner unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
delete_beneficial_owner Write
Permanently removes a beneficial owner from a business customer. This action is irreversible and the beneficial owner cannot be retrieved after removal. Removing a beneficial owner will change the customer's certification status to "recertify". Official Dwolla endpoint: DELETE /beneficial-owners/{id}.
- Lua path
app.integrations.dwolla.delete_beneficial_owner- Full name
dwolla.dwolla_delete_beneficial_owner
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Beneficial owner unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
get_beneficial_ownership_status_customer Read
Returns the certification status of beneficial ownership for a business verified customer. Status indicates whether beneficial owner information has been certified and affects the customer's ability to send funds. Possible values include uncertified, certified, and recertify. Official Dwolla endpoint: GET /customers/{id}/beneficial-ownership.
- Lua path
app.integrations.dwolla.get_beneficial_ownership_status_customer- Full name
dwolla.dwolla_get_beneficial_ownership_status_for_customer
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Customer unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
certify_beneficial_ownership_customer Read
Updates the beneficial ownership certification status to "certified", confirming that all beneficial owner information is accurate and complete. This action enables the business customer to send funds and is required to complete the verification process. Official Dwolla endpoint: POST /customers/{id}/beneficial-ownership.
- Lua path
app.integrations.dwolla.certify_beneficial_ownership_customer- Full name
dwolla.dwolla_certify_beneficial_ownership_for_customer
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Customer unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
list_customer_documents Read
Returns all identity verification documents submitted for a customer. Includes document status, verification results, document type (passport, driver's license, etc.), and failure reasons if verification was rejected. Used to track document submission and verification progress during the business verification process. Official Dwolla endpoint: GET /customers/{id}/documents.
- Lua path
app.integrations.dwolla.list_customer_documents- Full name
dwolla.dwolla_list_customer_documents
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | customer unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
create_customer_document Write
Uploads an identity verification document for a customer using multipart form-data. Required when a customer has "document" status during the verification process. Official Dwolla endpoint: POST /customers/{id}/documents.
- Lua path
app.integrations.dwolla.create_customer_document- Full name
dwolla.dwolla_create_customer_document
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | customer unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
list_beneficial_owner_documents Read
Returns all identity verification documents submitted for a beneficial owner. Includes document status, verification results, document type (passport, driver's license, etc.), and failure reasons if verification was rejected. Used to track document submission and verification progress during the business verification process. Official Dwolla endpoint: GET /beneficial-owners/{id}/documents.
- Lua path
app.integrations.dwolla.list_beneficial_owner_documents- Full name
dwolla.dwolla_list_beneficial_owner_documents
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | beneficial owner unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
create_beneficial_owner_document Write
Uploads an identity verification document for a beneficial owner using multipart form-data. Required when a beneficial owner has "document" status during the business verification process. Official Dwolla endpoint: POST /beneficial-owners/{id}/documents.
- Lua path
app.integrations.dwolla.create_beneficial_owner_document- Full name
dwolla.dwolla_create_beneficial_owner_document
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | beneficial owner unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
retrieve_document Read
Returns detailed information about a specific identity verification document, including its status, type, and verification results. Used to track document submission and verification progress during the business verification process. Official Dwolla endpoint: GET /documents/{id}.
- Lua path
app.integrations.dwolla.retrieve_document- Full name
dwolla.dwolla_retrieve_document
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Document unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
initiate_kba_customer Read
Creates a new KBA (Knowledge-Based Authentication) session for a personal Verified Customer. Returns a KBA identifier that represents the session and is used to retrieve authentication questions for customer verification. Official Dwolla endpoint: POST /customers/{id}/kba.
- Lua path
app.integrations.dwolla.initiate_kba_customer- Full name
dwolla.dwolla_initiate_kba_for_customer
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the Customer for initiating a KBA session |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | no | Request body matching the official Dwolla OpenAPI schema. |
get_kba_questions Read
Returns the KBA questions for a specific KBA session. The questions are used to verify the customer's identity during the KBA process. Official Dwolla endpoint: GET /kba/{id}.
- Lua path
app.integrations.dwolla.get_kba_questions- Full name
dwolla.dwolla_get_kba_questions
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the KBA session to retrieve questions for |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
verify_kba_questions Write
Submits customer answers to KBA questions for identity verification. Requires four question-answer pairs with questionId and answerId values. Returns verification status indicating whether the customer passed or failed the KBA authentication. Official Dwolla endpoint: POST /kba/{id}.
- Lua path
app.integrations.dwolla.verify_kba_questions- Full name
dwolla.dwolla_verify_kba_questions
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The id of the KBA session to verify questions for. |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
list_customer_funding_sources Read
Returns all funding sources for a customer, including bank accounts, debit card funding sources, and Dwolla balance (verified customers only). Shows verification status, limited account details, and creation dates. Card funding sources include masked card information. Supports filtering to exclude removed funding sources using the removed parameter. Official Dwolla endpoint: GET /customers/{id}/funding-sources.
- Lua path
app.integrations.dwolla.list_customer_funding_sources- Full name
dwolla.dwolla_list_customer_funding_sources
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Customer's unique identifier |
removed | string | no | Filter removed funding sources. Boolean value. Defaults to `true` |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
create_customer_funding_source Write
Creates a bank account or debit card funding source for a customer. Supports multiple methods including manual entry with routing/account numbers, instant verification using existing open banking connections, debit card addition via Exchange, and virtual account numbers. Bank funding sources require verification before transfers can be initiated. Official Dwolla endpoint: POST /customers/{id}/funding-sources.
- Lua path
app.integrations.dwolla.create_customer_funding_source- Full name
dwolla.dwolla_create_customer_funding_source
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Customer's unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
get_funding_source Read
Returns detailed information for a specific funding source, including its type, status, and verification details. Supports bank accounts (via Open Banking), debit card funding sources, and Dwolla balance (verified customers only). Debit card funding sources include masked card details such as brand, last four digits, expiration date, and cardholder name. Official Dwolla endpoint: GET /funding-sources/{id}.
- Lua path
app.integrations.dwolla.get_funding_source- Full name
dwolla.dwolla_get_funding_source
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Funding source unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
update_or_remove_funding_source Write
Updates a bank funding source's details or soft deletes it. When updating, you can change the name (any status) or modify routing/account numbers and account type (unverified status only). When removing, the funding source is soft deleted and can still be accessed but marked as removed. Official Dwolla endpoint: POST /funding-sources/{id}.
- Lua path
app.integrations.dwolla.update_or_remove_funding_source- Full name
dwolla.dwolla_update_or_remove_funding_source
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Funding source unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
get_micro_deposits Read
Returns the status and details of micro-deposits for a funding source to check verification eligibility. Includes deposit status (pending, processed, failed), creation timestamp, and failure details with ACH return codes if deposits failed. Use this endpoint to determine when micro-deposits are ready for verification. Official Dwolla endpoint: GET /funding-sources/{id}/micro-deposits.
- Lua path
app.integrations.dwolla.get_micro_deposits- Full name
dwolla.dwolla_get_micro_deposits
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the FS that previously had micro-deposits initiated |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
initiate_or_verify_micro_deposits Write
Handles micro-deposit bank verification process. Make a request without a request body to initiate two small deposits to the customer's bank account. Include deposit amounts to verify the received values and complete verification. Official Dwolla endpoint: POST /funding-sources/{id}/micro-deposits.
- Lua path
app.integrations.dwolla.initiate_or_verify_micro_deposits- Full name
dwolla.dwolla_initiate_or_verify_micro_deposits
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the FS to initiate or verify micro-deposit |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | no | Request body matching the official Dwolla OpenAPI schema. |
get_funding_source_balance Read
Returns the current balance for a specific funding source. For bank accounts, includes available and closing balances; for Dwolla balance, includes balance and total amounts; for settlement accounts (bankUsageType = card-network), includes available balance only. Supports bank accounts (via Open Banking), Dwolla balance (verified customers only), and settlement accounts for card network processing. Official Dwolla endpoint: GET /funding-sources/{id}/balance.
- Lua path
app.integrations.dwolla.get_funding_source_balance- Full name
dwolla.dwolla_get_funding_source_balance
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | ID of funding source to retrieve the balance for |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
get_van_routing Read
Returns the unique account and routing numbers for a Virtual Account Number (VAN) funding source. These numbers can be used by external systems to initiate ACH transactions that pull funds from or push funds to the associated Dwolla balance. Official Dwolla endpoint: GET /funding-sources/{id}/ach-routing.
- Lua path
app.integrations.dwolla.get_van_routing- Full name
dwolla.dwolla_get_van_routing
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | ID of VAN funding source to retrieve ACH details |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
create_demand_transfer_authorization Write
Create an on-demand transfer authorization that allows Customers to pre-authorize variable amount ACH transfers from their bank account for future payments. This authorization is used when creating Customer funding sources to enable flexible payment processing. Returns UI text elements including authorization body text and button text for display in your application's bank account addition flow. Official Dwolla endpoint: POST /on-demand-authorizations.
- Lua path
app.integrations.dwolla.create_demand_transfer_authorization- Full name
dwolla.dwolla_create_on_demand_transfer_authorization
| Parameter | Type | Required | Description |
|---|---|---|---|
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | no | Request body matching the official Dwolla OpenAPI schema. |
initiate_transfer Read
Initiate a transfer Official Dwolla endpoint: POST /transfers.
- Lua path
app.integrations.dwolla.initiate_transfer- Full name
dwolla.dwolla_initiate_transfer
| Parameter | Type | Required | Description |
|---|---|---|---|
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
idempotency_key | string | no | Idempotency-Key |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
get_transfer Read
Retrieve a transfer Official Dwolla endpoint: GET /transfers/{id}.
- Lua path
app.integrations.dwolla.get_transfer- Full name
dwolla.dwolla_get_transfer
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | ID of transfer to be retrieved |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
cancel_transfer Write
Cancel a pending transfer by setting its status to cancelled. Only transfers in pending status can be cancelled before processing begins. Returns the updated transfer resource with cancelled status. Use this endpoint to stop a bank transfer from further processing. Official Dwolla endpoint: POST /transfers/{id}.
- Lua path
app.integrations.dwolla.cancel_transfer- Full name
dwolla.dwolla_cancel_transfer
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | ID of transfer |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
list_customer_transfers Read
List and search transfers for a customer Official Dwolla endpoint: GET /customers/{id}/transfers.
- Lua path
app.integrations.dwolla.list_customer_transfers- Full name
dwolla.dwolla_list_customer_transfers
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Customer's unique identifier |
search | string | no | A string to search on fields `firstName`, `lastName`, `email`, `businessName` |
start_amount | string | no | Only include transactions with an amount equal to or greater than `startAmount` |
end_amount | string | no | Only include transactions with an amount equal to or less than `endAmount` |
start_date | string | no | Only include transactions created after this date. ISO-8601 format `YYYY-MM-DD` |
end_date | string | no | Only include transactions created before this date. ISO-8601 format `YYYY-MM-DD` |
status | string | no | Filter on transaction status. Possible values are `pending`, `processed`, `failed`, or `cancelled` |
correlation_id | string | no | A string value to search on if `correlationId` was specified for a transaction |
limit | string | no | Number of search results to return. Defaults to 25 |
offset | string | no | Number of search results to skip. Use for pagination |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
list_transfer_fees Read
Retrieve detailed fee information for a specific transfer by its unique identifier. Returns the total number of fees and individual fee transaction details including amounts, status, and links to source and destination accounts. Official Dwolla endpoint: GET /transfers/{id}/fees.
- Lua path
app.integrations.dwolla.list_transfer_fees- Full name
dwolla.dwolla_list_transfer_fees
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | ID of transfer to retrieve fees for |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
get_transfer_failure_reason Read
Retrieve a transfer failure reason Official Dwolla endpoint: GET /transfers/{id}/failure.
- Lua path
app.integrations.dwolla.get_transfer_failure_reason- Full name
dwolla.dwolla_get_transfer_failure_reason
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Transfer unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
initiate_mass_payment Read
Create a mass payment containing up to 5,000 individual payment items from a Dwolla Main Account or Verified Customer funding source. Supports optional metadata, correlation IDs for traceability, deferred processing, and expedited transfer options including same-day ACH clearing. Returns the location of the created mass payment resource with a unique identifier for tracking and management. Official Dwolla endpoint: POST /mass-payments.
- Lua path
app.integrations.dwolla.initiate_mass_payment- Full name
dwolla.dwolla_initiate_mass_payment
| Parameter | Type | Required | Description |
|---|---|---|---|
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
idempotency_key | string | no | Idempotency-Key |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
get_mass_payment Read
Retrieve detailed information for a mass payment by its unique identifier. Returns the current processing status (pending, processing, or complete), creation date, metadata, and links to the source funding source and payment items. Use this endpoint to monitor mass payment processing progress and determine when to check individual item results. Official Dwolla endpoint: GET /mass-payments/{id}.
- Lua path
app.integrations.dwolla.get_mass_payment- Full name
dwolla.dwolla_get_mass_payment
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Mass payment unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
update_mass_payment Write
Update the status of a deferred mass payment to control its processing lifecycle. Set status to `pending` to trigger processing and begin fund transfers, or `cancelled` to permanently cancel the mass payment before processing begins. Only applies to mass payments created with deferred status. Returns the updated mass payment resource with the new status. Official Dwolla endpoint: POST /mass-payments/{id}.
- Lua path
app.integrations.dwolla.update_mass_payment- Full name
dwolla.dwolla_update_mass_payment
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | ID of mass payment to update |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
list_mass_payment_items Read
Retrieve individual payment items within a mass payment with optional status filtering and pagination support. Each item represents a distinct payment with status indicators (failed, pending, success) showing whether a transfer was successfully created. Returns paginated item details including amount, destination, metadata, and error information for failed items. Supports filtering by status and standard pagination. Official Dwolla endpoint: GET /mass-payments/{id}/items.
- Lua path
app.integrations.dwolla.list_mass_payment_items- Full name
dwolla.dwolla_list_mass_payment_items
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Mass payment unique identifier |
limit | string | no | How many results to return |
offset | string | no | How many results to skip |
status | string | no | Filter by item status |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
get_mass_payment_item Read
Retrieve detailed information for a specific mass payment item by its unique identifier. Returns item status, amount, metadata, and links to the parent mass payment, associated transfer, and destination funding source. Use this endpoint to check the processing status and details of an individual item within a mass payment batch. Official Dwolla endpoint: GET /mass-payment-items/{itemId}.
- Lua path
app.integrations.dwolla.get_mass_payment_item- Full name
dwolla.dwolla_get_mass_payment_item
| Parameter | Type | Required | Description |
|---|---|---|---|
item_id | string | yes | ID of item to be retrieved in mass payment |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
list_customer_mass_payments Read
List mass payments for customer Official Dwolla endpoint: GET /customers/{id}/mass-payments.
- Lua path
app.integrations.dwolla.list_customer_mass_payments- Full name
dwolla.dwolla_list_customer_mass_payments
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Customer ID to get mass payments for |
correlation_id | string | no | A string value to search on if `correlationId` was specified for a transaction |
limit | number | no | Number of search results to return. Defaults to 25 |
offset | number | no | Number of search results to skip. Use for pagination |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
get_label Read
Retrieve details for a specific Label used to categorize and track funds within your account. Returns Label information including unique identifier, current amount with currency, and creation timestamp. Official Dwolla endpoint: GET /labels/{id}.
- Lua path
app.integrations.dwolla.get_label- Full name
dwolla.dwolla_get_label
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Label unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
remove_label Write
Delete a Label to stop tracking funds and remove it from your account. Returns success status if the Label is successfully removed. Use this to streamline your account management and remove unused Labels from your system. Official Dwolla endpoint: DELETE /labels/{id}.
- Lua path
app.integrations.dwolla.remove_label- Full name
dwolla.dwolla_remove_label
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | A label unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
list_customer_labels Read
Returns all labels for a specified Verified Customer, sorted by creation date (most recent first). Supports pagination with limit and offset parameters. Each label includes its current amount and creation timestamp. Official Dwolla endpoint: GET /customers/{id}/labels.
- Lua path
app.integrations.dwolla.list_customer_labels- Full name
dwolla.dwolla_list_customer_labels
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | ID of customer |
limit | string | no | How many results to return |
offset | string | no | How many results to skip |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
create_customer_label Write
Creates a new label for a Verified Customer with a specified amount. Labels help organize and track funds within a customer's balance. Returns the location of the created label resource in the response header. Official Dwolla endpoint: POST /customers/{id}/labels.
- Lua path
app.integrations.dwolla.create_customer_label- Full name
dwolla.dwolla_create_customer_label
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | ID of customer to create a label for |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
list_label_ledger_entries Read
Returns all ledger entries for a specific Label, sorted by creation date (newest first). Supports pagination with limit and offset parameters. Each ledger entry includes its amount, currency, and creation timestamp. Official Dwolla endpoint: GET /labels/{id}/ledger-entries.
- Lua path
app.integrations.dwolla.list_label_ledger_entries- Full name
dwolla.dwolla_list_label_ledger_entries
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | A label unique identifier |
limit | number | no | How many results to return |
offset | number | no | How many results to skip |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
create_label_ledger_entry Write
Create a new ledger entry to track fund adjustments on a Label by specifying a positive or negative amount value. Returns the location of the created ledger entry in the response header. Label amounts cannot go negative, so validation errors occur if the entry would result in a negative Label balance. Official Dwolla endpoint: POST /labels/{id}/ledger-entries.
- Lua path
app.integrations.dwolla.create_label_ledger_entry- Full name
dwolla.dwolla_create_label_ledger_entry
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The Id of the Label to update. |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
get_label_ledger_entry Read
Returns detailed information for a specific ledger entry on a Label, including its amount, currency, and creation timestamp. Official Dwolla endpoint: GET /ledger-entries/{ledgerEntryId}.
- Lua path
app.integrations.dwolla.get_label_ledger_entry- Full name
dwolla.dwolla_get_label_ledger_entry
| Parameter | Type | Required | Description |
|---|---|---|---|
ledger_entry_id | string | yes | A label ledger entry unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
create_label_reallocation Write
Reallocates funds between two labels belonging to the same Verified Customer. Moves the specified amount from the source label to the destination label, creating ledger entries for both. The reallocation only succeeds if the source label has sufficient funds. Official Dwolla endpoint: POST /label-reallocations.
- Lua path
app.integrations.dwolla.create_label_reallocation- Full name
dwolla.dwolla_create_label_reallocation
| Parameter | Type | Required | Description |
|---|---|---|---|
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
retrieve_label_reallocation Read
Retrieve details for a specific label reallocation that transfers funds between Labels. Returns reallocation information including source and destination Labels, amount transferred, status, and creation timestamp. Use this to track and audit fund movements between different Labels. Official Dwolla endpoint: GET /label-reallocations/{reallocationId}.
- Lua path
app.integrations.dwolla.retrieve_label_reallocation- Full name
dwolla.dwolla_retrieve_label_reallocation
| Parameter | Type | Required | Description |
|---|---|---|---|
reallocation_id | string | yes | Label reallocation unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
list_events Read
Returns a paginated list of events representing state changes to resources in your Dwolla application. Events track actions on customers, transfers, funding sources, and other resources, sorted by creation date (newest first). Events are retained for 30 days and are essential for webhook notifications and system activity monitoring. Official Dwolla endpoint: GET /events.
- Lua path
app.integrations.dwolla.list_events- Full name
dwolla.dwolla_list_events
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | number | no | How many results to return |
offset | number | no | How many results to skip |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
get_event Read
Returns detailed information for a specific event representing a state change that occurred on a resource in your Dwolla application. Includes the event topic, timestamp, resource links, and correlation ID if applicable. Official Dwolla endpoint: GET /events/{id}.
- Lua path
app.integrations.dwolla.get_event- Full name
dwolla.dwolla_get_event
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | ID of application event to get |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
list_webhook_subscriptions Read
Retrieve all webhook subscriptions that belong to an application including their configuration details and status. Returns subscription details including webhook endpoints, status, creation dates, and links to associated webhooks with total count. Essential for webhook management and monitoring subscription health. Official Dwolla endpoint: GET /webhook-subscriptions.
- Lua path
app.integrations.dwolla.list_webhook_subscriptions- Full name
dwolla.dwolla_list_webhook_subscriptions
| Parameter | Type | Required | Description |
|---|---|---|---|
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
create_webhook_subscription Write
Create a webhook subscription to deliver webhook notifications to a specified URL endpoint for your application. Requires a destination URL where Dwolla will send notifications and a secret key for webhook validation and security. Returns the location of the created subscription resource. Essential for establishing real-time event notifications and automated integrations with Dwolla's payment processing events. Official Dwolla endpoint: POST /webhook-subscriptions.
- Lua path
app.integrations.dwolla.create_webhook_subscription- Full name
dwolla.dwolla_create_webhook_subscription
| Parameter | Type | Required | Description |
|---|---|---|---|
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
get_webhook_subscription Read
Retrieve detailed information for a specific webhook subscription by its unique identifier. Returns subscription configuration including URL endpoint, creation date, and links to associated webhooks for comprehensive subscription management. Essential for monitoring webhook subscription status and accessing webhook delivery history. Official Dwolla endpoint: GET /webhook-subscriptions/{id}.
- Lua path
app.integrations.dwolla.get_webhook_subscription- Full name
dwolla.dwolla_get_webhook_subscription
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Webhook subscription unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
update_webhook_subscription Write
Update a webhook subscription to pause or resume webhook delivery notifications. Allows toggling the paused status to temporarily stop webhook notifications without deleting the subscription. Returns the updated subscription resource with the new paused status. Use this endpoint to manage webhook delivery during maintenance or troubleshooting periods. Official Dwolla endpoint: POST /webhook-subscriptions/{id}.
- Lua path
app.integrations.dwolla.update_webhook_subscription- Full name
dwolla.dwolla_update_webhook_subscription
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Webhook unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
delete Read
Delete a webhook subscription to permanently remove webhook notifications for your application. This action stops all future webhook deliveries and cannot be undone. Returns the deleted subscription resource for confirmation. Use this endpoint when webhook notifications are no longer needed or when cleaning up unused subscriptions. Official Dwolla endpoint: DELETE /webhook-subscriptions/{id}.
- Lua path
app.integrations.dwolla.delete- Full name
dwolla.dwolla_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Webhook unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
list_webhooks Read
List webhooks for a webhook subscription Official Dwolla endpoint: GET /webhook-subscriptions/{id}/webhooks.
- Lua path
app.integrations.dwolla.list_webhooks- Full name
dwolla.dwolla_list_webhooks
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Webhook subscription unique identifier |
limit | string | no | How many results to return |
offset | string | no | How many results to skip |
start_date | string | no | Only include webhooks created after this date. ISO-8601 format `YYYY-MM-DD` |
end_date | string | no | Only include webhooks created before this date. ISO-8601 format `YYYY-MM-DD` |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
get_webhook Read
Retrieve detailed information for a specific webhook by its unique identifier including delivery attempts and response data. Returns webhook details with topic, account information, delivery attempts containing request/response history, and links to subscription and retry resources. Essential for debugging webhook delivery issues, analyzing response data, and monitoring notification processing status. Official Dwolla endpoint: GET /webhooks/{id}.
- Lua path
app.integrations.dwolla.get_webhook- Full name
dwolla.dwolla_get_webhook
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Webhook unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
list_webhook_retries Read
Retrieve all retry attempts for a specific webhook including timestamps and delivery details. Returns a list of retry attempts with unique identifiers, timestamps, and links to the parent webhook with total count. Essential for tracking webhook delivery failures, analyzing retry patterns, and debugging webhook notification issues to ensure reliable event processing. Official Dwolla endpoint: GET /webhooks/{id}/retries.
- Lua path
app.integrations.dwolla.list_webhook_retries- Full name
dwolla.dwolla_list_webhook_retries
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Webhook unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
retry_webhook Read
Retry a webhook by its unique identifier to redeliver the notification to your endpoint. Creates a new retry attempt and returns the location of the new webhook resource. Essential for recovering from webhook delivery failures and ensuring reliable event notification processing in your application. Official Dwolla endpoint: POST /webhooks/{id}/retries.
- Lua path
app.integrations.dwolla.retry_webhook- Full name
dwolla.dwolla_retry_webhook
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Webhook unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | no | Request body matching the official Dwolla OpenAPI schema. |
simulate_bank_transfer_processing Read
Sandbox simulations (bank transfers, VAN transfers, or customer verification directives) Official Dwolla endpoint: POST /sandbox-simulations.
- Lua path
app.integrations.dwolla.simulate_bank_transfer_processing- Full name
dwolla.dwolla_simulate_bank_transfer_processing
| Parameter | Type | Required | Description |
|---|---|---|---|
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | no | Request body matching the official Dwolla OpenAPI schema. |
list_exchange_partners Read
Returns a list of all supported exchange partners. Each partner includes a unique ID, name, and status indicating whether they are active or inactive. Official Dwolla endpoint: GET /exchange-partners.
- Lua path
app.integrations.dwolla.list_exchange_partners- Full name
dwolla.dwolla_list_exchange_partners
| Parameter | Type | Required | Description |
|---|---|---|---|
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
get_exchange_partner Read
Returns details for a specific open banking provider that integrates with Dwolla. Includes partner name, status, and creation date. Use this to verify partner availability before creating exchanges and funding sources. Official Dwolla endpoint: GET /exchange-partners/{id}.
- Lua path
app.integrations.dwolla.get_exchange_partner- Full name
dwolla.dwolla_get_exchange_partner
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Exchange Partner resource unique identifier. |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
list_account_exchanges Read
Returns all exchanges for your Dwolla account. Exchanges represent connections between external bank accounts and your account through open banking partners. Includes exchange status, creation date, and associated partner information. Official Dwolla endpoint: GET /exchanges.
- Lua path
app.integrations.dwolla.list_account_exchanges- Full name
dwolla.dwolla_list_account_exchanges
| Parameter | Type | Required | Description |
|---|---|---|---|
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
create_account_exchange Write
Create an exchange for an account. The request body will vary based on the exchange partner. For Finicity, the request body will include finicity-specific fields. For MX Secure Exchange, the request body will include a token. For Flinks Secure Exchange, the request body will include a token. For Plaid Secure Exchange, the request body will include a token. Official Dwolla endpoint: POST /exchanges.
- Lua path
app.integrations.dwolla.create_account_exchange- Full name
dwolla.dwolla_create_account_exchange
| Parameter | Type | Required | Description |
|---|---|---|---|
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
get_exchange Read
Returns details for a specific exchange connection between Dwolla and an open banking partner for a customer's bank account. Includes exchange status, creation date, and links to the associated customer and exchange partner. Official Dwolla endpoint: GET /exchanges/{id}.
- Lua path
app.integrations.dwolla.get_exchange- Full name
dwolla.dwolla_get_exchange
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Exchange resource unique identifier. |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
list_customer_exchanges Read
Returns all exchanges for a specific customer. Exchanges represent connections between the customer's external bank accounts and open banking partners. Includes exchange status, creation date, and links to associated funding sources and partners. Official Dwolla endpoint: GET /customers/{id}/exchanges.
- Lua path
app.integrations.dwolla.list_customer_exchanges- Full name
dwolla.dwolla_list_customer_exchanges
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the Customer to list exchanges for |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
create_customer_exchange Write
Creates an exchange connection between a customer and Dwolla. Request body varies by partner (Plaid, MX, Flinks, Finicity, Checkout.com). For bank accounts, use Plaid, MX, Flinks, or Finicity to establish secure access to the customer's bank account data. For debit cards (Push to Card), use Checkout.com and pass the payment ID from Checkout.com Flow. Official Dwolla endpoint: POST /customers/{id}/exchanges.
- Lua path
app.integrations.dwolla.create_customer_exchange- Full name
dwolla.dwolla_create_customer_exchange
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The ID of the customer to create an exchange for |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
create_customer_exchange_session Write
Creates an exchange session for a customer. Use cases include: - **Plaid / MX**: Instant bank account verification (open banking). For faster verification as compared to traditional micro-deposits. - **Checkout.com**: Debit card capture for Push to Card. Create a session, then retrieve it to get `externalProviderSessionData` (payment session) for the Checkout.com Flow component. Official Dwolla endpoint: POST /customers/{id}/exchange-sessions.
- Lua path
app.integrations.dwolla.create_customer_exchange_session- Full name
dwolla.dwolla_create_customer_exchange_session
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Customer's unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |
retrieve_customer_exchange_session Read
Retrieve exchange session Official Dwolla endpoint: GET /exchange-sessions/{id}.
- Lua path
app.integrations.dwolla.retrieve_customer_exchange_session- Full name
dwolla.dwolla_retrieve_customer_exchange_session
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Exchange session's unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
create_re_auth_exchange_session Write
Creates a re-authentication exchange session to refresh a user's bank account connection when their existing authorization is no longer valid. Required when receiving an UpdateCredentials error during bank balance checks or when user re-authentication is needed. Official Dwolla endpoint: POST /exchanges/{id}/exchange-sessions.
- Lua path
app.integrations.dwolla.create_re_auth_exchange_session- Full name
dwolla.dwolla_create_re_auth_exchange_session
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Exchange's unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | no | Request body matching the official Dwolla OpenAPI schema. |
list_available_exchange_connections Read
Returns available exchange connections for a customer's bank accounts authorized through MX Connect. Each connection includes an account name and availableConnectionToken required to create exchanges and funding sources for transfers. Official Dwolla endpoint: GET /customers/{id}/available-exchange-connections.
- Lua path
app.integrations.dwolla.list_available_exchange_connections- Full name
dwolla.dwolla_list_available_exchange_connections
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Customer's unique identifier |
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
create_client_token Write
Create a client token Official Dwolla endpoint: POST /client-tokens.
- Lua path
app.integrations.dwolla.create_client_token- Full name
dwolla.dwolla_create_client_token
| Parameter | Type | Required | Description |
|---|---|---|---|
accept | string | yes | The media type of the response. Must be application/vnd.dwolla.v1.hal+json |
body | object | yes | Request body matching the official Dwolla OpenAPI schema. |