DirectDebitAccount
A direct debit account.
Operations
Every route this entity exposes. Each route links to its own reference on this page.
| Method | Route | SDK operation | Returns |
|---|---|---|---|
POST |
/profiles/{profileId}/direct-debit-accounts |
create |
Direct debit account created successfully |
GET |
/profiles/{profileId}/direct-debit-accounts |
list |
List of direct debit accounts matching the filters |
Examples
One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.
Golang
Construct client as shown in the Golang setup, then call the operations:
direct_debit_accounts, err := client.DirectDebitAccount(nil).List(map[string]any{"profile_id": 1, "currency": "example", "type": "example"}, nil)
if err != nil {
panic(err)
}
fmt.Println(direct_debit_accounts)
created, err := client.DirectDebitAccount(nil).Create(map[string]any{"profile_id": 1}, nil)
if err != nil {
panic(err)
}
fmt.Println(created)
Lua
Construct client as shown in the Lua setup, then call the operations:
local direct_debit_accounts, err = client:DirectDebitAccount():list({ profile_id = 1, currency = "example", type = "example" })
local created, err = client:DirectDebitAccount():create({ profile_id = 1 })
PHP
Construct client as shown in the PHP setup, then call the operations:
$direct_debit_accounts = $client->DirectDebitAccount()->list(["profile_id" => 1, "currency" => "example", "type" => "example"]);
$created = $client->DirectDebitAccount()->create(["profile_id" => 1]);
Python
Construct client as shown in the Python setup, then call the operations:
direct_debit_accounts = client.DirectDebitAccount().list({"profile_id": 1, "currency": "example", "type": "example"})
created = client.DirectDebitAccount().create({ "profile_id": 1 })
Ruby
Construct client as shown in the Ruby setup, then call the operations:
direct_debit_accounts = client.DirectDebitAccount.list({ "profile_id" => 1, "currency" => "example", "type" => "example" })
created = client.DirectDebitAccount.create({ "profile_id" => 1 })
TypeScript
Construct client as shown in the TypeScript setup, then call the operations:
const direct_debit_accounts = await client.DirectDebitAccount().list({ profile_id: 1, currency: "example", type: "example" })
const created = await client.DirectDebitAccount().create({ profile_id: 1 })
Fields
| Field | Type | Required | Description |
|---|---|---|---|
currency |
string |
No | Currency of the bank account. |
details |
object |
No | Bank account details |
id |
integer |
No | Direct debit account ID |
type |
string |
No | Payment type for which the account is used. |
create
POST /profiles/{profileId}/direct-debit-accounts
Operation ID: directDebitAccountCreate.
Authentication: bearer token (UserToken).
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
profileId |
path |
integer (int64) |
Yes | Your profile ID. |
X-External-Correlation-Id |
header |
string (uuid) |
No | Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more. |
Request body
application/json
| Property | Type | Required | Description |
|---|---|---|---|
currency |
string |
No | Currency of the bank account. 3-character currency code, USD for ACH direct debits, CAD for EFT direct debits. |
details |
object |
No | Bank account details. |
details.accountNumber |
string |
No | A valid bank account number. |
details.accountType |
enum: CHECKING, SAVINGS |
No | Bank account type. - CHECKING , Checking account (USD, CAD) - SAVINGS , Savings account (USD, CAD) |
details.routingNumber |
string |
No | A valid ABA routing number. For CAD direct debits, the routing number is a combination of an institution number + transit number. |
type |
enum: ACH, EFT |
No | Payment type for which the account is used. - ACH , US direct debit (USD) - EFT , CA direct debit (CAD) |
Responses
200: Direct debit account created successfully
application/json
| Property | Type | Required | Description |
|---|---|---|---|
currency |
string |
No | Currency of the bank account. 3-character currency code, USD for ACH, CAD for EFT |
details |
object |
No | Bank account details |
details.accountNumber |
string |
No | A valid bank account number |
details.accountType |
enum: CHECKING, SAVINGS |
No | Bank account type. - CHECKING , Checking account (USD, CAD) - SAVINGS , Savings account (USD, CAD) |
details.routingNumber |
string |
No | A valid ABA routing number. For CAD direct debits, the routing number is a combination of an institution number + transit number |
id |
integer (int64) |
No | Direct debit account ID |
type |
enum: ACH, EFT |
No | Payment type for which the account is used. - ACH , US direct debit (USD) - EFT , CA direct debit (CAD) |
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header
application/json
The response is object.
list
GET /profiles/{profileId}/direct-debit-accounts
Operation ID: directDebitAccountGet.
Authentication: bearer token (UserToken).
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
profileId |
path |
integer (int64) |
Yes | Your profile ID. |
type |
query |
enum: ACH, EFT |
Yes | Payment type for which the account is used. - ACH , US direct debit (USD) - EFT , CA direct debit (CAD) |
currency |
query |
string |
Yes | Currency of the bank account. 3-character currency code, USD for ACH direct debits, CAD for EFT direct debits. |
X-External-Correlation-Id |
header |
string (uuid) |
No | Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more. |
Responses
200: List of direct debit accounts matching the filters
application/json
| Property | Type | Required | Description |
|---|---|---|---|
[].currency |
string |
No | Currency of the bank account. 3-character currency code, USD for ACH, CAD for EFT |
[].details |
object |
No | Bank account details |
[].details.accountNumber |
string |
No | A valid bank account number |
[].details.accountType |
enum: CHECKING, SAVINGS |
No | Bank account type. - CHECKING , Checking account (USD, CAD) - SAVINGS , Savings account (USD, CAD) |
[].details.routingNumber |
string |
No | A valid ABA routing number. For CAD direct debits, the routing number is a combination of an institution number + transit number |
[].id |
integer (int64) |
No | Direct debit account ID |
[].type |
enum: ACH, EFT |
No | Payment type for which the account is used. - ACH , US direct debit (USD) - EFT , CA direct debit (CAD) |
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header
application/json
The response is object.