Account Holder Funding Sources
Use the
For more information on users and businesses, see About Account Holders.
Create ACH source
Copy section link
Action:
Endpoint:
Create an ACH funding source for an existing account holder. Specify the account holder of the funding source by passing a user or business token.
When adding an ACH funding source, a small amount is deposited in the bank account as a test. The test deposit should be reflected in the account after two to three business days. You must then make an API call to verify the deposit amount in order to activate the ACH account. See "Verify or Update ACH Funding Source" on this page for more information.
The response body returns details about the account, including the verification status. Possible ACH verification status values include
Body field details
Copy section link
Fields | Description |
---|---|
token
string
|
The unique identifier of the funding source. If you do not include a token, the system will generate one automatically. This token is necessary for use in other calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. Allowable Values: 36 char max |
user_token OR business_token
string
|
Specifies the owner of the funding source. Allowable Values: Existing user or business token. Send a GET request to /users to retrieve user tokens or to /businesses to retrieve business tokens.
Default value: false
|
account_number
string
|
The ACH account number. Allowable Values: 36 char max |
name_on_account
string
|
The name on the ACH account. Allowable Values: 40 char max |
routing_number
string
|
The routing number for the ACH account. Allowable Values: 9 digits |
account_type
string
|
The type of account. Allowable Values: checking, savings, corporate |
is_default_account
boolean
|
If there are multiple funding sources, this field specifies which source is used by default in funding calls. If there is only one funding source, the system ignores this field and always uses that source. If you do not specify this field upon creation, the system sets it to false .
Allowable Values: true , false
Default value: false
|
verification_override
boolean
|
Allows the ACH funding source to be used regardless of its verification status. Allowable Values: true , false
Default value: false
|
verification_notes
string
|
Free-form text field for holding notes about verification. This field is returned only if verification_override = true .
Allowable Values: 255 char max |
Retrieve ACH source
Copy section link
Action:
Endpoint:
Retrieve a specific ACH funding source.
The response body returns details about the account, including the verification status. Possible ACH verification status values are:
URL path parameters
Copy section link
Fields | Description |
---|---|
funding_source_token
string
|
Identifies the ACH funding source to retrieve. Allowable Values: Existing ACH funding source token. Send a GET request to /fundingsources/user/{user_token} to retrieve existing funding source tokens for a user or to /fundingsources/business/{business_token} to retrieve existing funding source tokens for a business.
|
Retrieve ACH verification amounts
Copy section link
Action:
Endpoint:
In your sandbox environment, retrieve the amounts used to verify the association with your ACH account.
Use this endpoint for testing purposes only. In production, verification amounts are retrieved from the bank statement of the account holder.
URL path parameters
Copy section link
Fields | Description |
---|---|
funding_source_token
string
|
Identifies the ACH funding source for which you want to retrieve verification deposit amounts. Allowable Values: Existing ACH funding source token. Send a GET request to /fundingsources/user/{user_token} to retrieve existing funding source tokens for a user or to /fundingsources/business/{business_token} to retrieve existing funding source tokens for a business.
|
Verify or update ACH source
Copy section link
Action:
Endpoint:
Verify or update an ACH funding source.
If you are verifying the ACH source, include the verification amounts in the body of the request. ACH verification will fail if the verification amounts are not entered in the correct order.
If you are updating the ACH source, include the
URL path parameters
Copy section link
Fields | Description |
---|---|
funding_source_token
string
|
Identifies the ACH funding source to verify. Allowable Values: Existing ACH funding source token. Send a GET request to /fundingsources/user/{user_token} to retrieve existing funding source tokens for a user or to /fundingsources/business/{business_token} to retrieve existing funding source tokens for a business.
|
Body field details
Copy section link
Fields | Description |
---|---|
active
boolean
|
Indicates whether the ACH funding source is active. Allowable Values: true , false
|
verify_amount1
decimal
|
Verification amount. Allowable Values: Format: 0.00 |
verify_amount2
decimal
|
Verification amount. Allowable Values: Format: 0.00 |
Create payment card source
Copy section link
Action:
Endpoint:
Create a payment card funding source for an existing account holder. Returns the card type and the last 4 digits of the card, and sets the
Marqeta retains only a tokenized representation of the card number.
Note
This endpoint is only available to its current users.
Body field details
Copy section link
Fields | Description |
---|---|
token
string
|
The unique identifier of the funding account. If you do not include a token, the system will generate one automatically. As this token is necessary for use in other calls, we recommend that you define a simple and easy to remember string rather than letting the system generate a token for you. This value cannot be updated. Allowable Values: 36 char max |
postal_code
string
|
Postal code of the account holder (user or business). Allowable Values: 10 char max |
account_number
string
|
Payment card account number. Allowable Values: 16-digit number |
exp_date
string
|
Payment card expiration date. Allowable Values: mmyy |
user_token OR business_token
string
|
Specifies the owner of the funding source. Allowable Values: Existing user or business token. Send a GET request to /users to retrieve user tokens or to /businesses to retrieve business tokens.
|
cvv_number
string
|
Payment card CVV2 number. Allowable Values: 3-4 characters |
is_default_account
boolean
|
If there are multiple funding sources, this field specifies which source is used by default in funding calls. If there is only one funding source, the system ignores this field and always uses that source. If you do not specify this field upon creation, the system sets it to false .
Allowable Values: true , false
Default value: false
|
Retrieve payment card source
Copy section link
Action:
Endpoint:
Retrieve a specific payment card funding source.
Note
This endpoint is only available to its current users.
URL path parameters
Copy section link
Fields | Description |
---|---|
funding_source_token
string
|
Identifies the payment card funding source you want to retrieve. Allowable Values: Existing payment card funding source token. Send a GET request to /fundingsources/user/{user_token} to retrieve existing funding source tokens for a user or to /fundingsources/business/{business_token} to retrieve existing funding source tokens for a business.
|
Update payment card source
Copy section link
Action:
Endpoint:
Update a payment card funding source. Only the values of parameters in the request are modified; all others are left unchanged.
Note
This endpoint is only available to its current users.
URL path parameters
Copy section link
Fields | Description |
---|---|
funding_source_token
string
|
Identifies the payment card funding source you want to retrieve. Allowable Values: Existing payment card funding source token. Send a GET request to /fundingsources/user/{user_token} to retrieve existing funding source tokens for a user or to /fundingsources/business/{business_token} to retrieve existing funding source tokens for a business.
|
Body field details
Copy section link
Fields | Description |
---|---|
active
boolean
|
Indicates whether the card funding source is active. Allowable Values: true , false
Default value: true
|
exp_date
string
|
The expiration date for the payment card. Allowable Values: mmyy |
is_default_account
boolean
|
If there are multiple funding sources, this field specifies which source is used by default in funding calls. If there is only one funding source, the system ignores this field and always uses that source. Allowable Values: true , false
Default value: false
|
List sources for a user
Copy section link
Action:
Endpoint:
List funding sources associated with a specific user.
This endpoint supports field filtering.
URL path parameters
Copy section link
Fields | Description |
---|---|
user_token
string
|
Identifies the owner of the funding sources you want to list. Allowable Values: Existing user token. Send a GET request to /users to retrieve existing user tokens.
|
Query parameters
Copy section link
Fields | Description |
---|---|
type
string
|
Type of funding source to return: ACH or payment card. Leave unspecified to return both types. Allowable Values: paymentcard, ach Default value: |
List sources for a business
Copy section link
Action:
Endpoint:
List funding sources associated with a specific business.
This endpoint supports field filtering.
URL path parameters
Copy section link
Fields | Description |
---|---|
business_token
string
|
Identifies the business whose funding sources you want to retrieve. Allowable Values: Existing business token. Send a GET request to /businesses to retrieve existing business tokens.
|
Query parameters
Copy section link
Fields | Description |
---|---|
type
string
|
Type of funding source to return: ACH or payment card. Leave unspecified to return both types. Allowable Values: paymentcard, ach Default value: |
Set default source
Copy section link
Action:
Endpoint:
Configure either an ACH funding source or a payment card funding source as the default funding source.
A default funding source is used when you omit the
URL path parameters
Copy section link
Fields | Description |
---|---|
funding_source_token
string
|
Specifies the funding source to use by default. You can set the default only to an ACH or payment card funding source. Allowable Values: Existing ACH or payment card funding source token. Send a GET request to /fundingsources/user/{user_token} to retrieve existing funding source tokens for a user or to /fundingsources/business/{business_token} to retrieve existing funding source tokens for a business.
|