Skip to main content
POST
Simulate credit
Use this endpoint to simulate crediting funds to a deposit account. Simulate a direct deposit of funds to a user account by including the deposit account number of the account to be credited. You can find the account number in the account_number field of the response when you create a new deposit account. Alternatively, you can retrieve it by sending a GET request to the /depositaccounts/user/{user_token} endpoint. For more information, see Direct Deposit. You can view the full request body structure on the Simulations 2.0 — Direct Deposits page.

Request body

See Request Body.

Sample request body

JSON

Response body

See Response Body.

Sample response body

JSON

Body

application/json
account_number
string
required

The account number of the user to debit or credit.

amount
number
required

Amount of the transaction.

settlement_date
string<date-time>
required

Date when the credit or debit is applied.

company_discretionary_data
string

Company-specific data provided by the direct deposit originator.

Maximum string length: 20
company_entry_description
string

Company-specific data provided by the direct deposit originator.

Maximum string length: 10
company_identification
string

Alphanumeric code that identifies the direct deposit originator.

Maximum string length: 10
company_name
string

Name of the direct deposit originator.

Maximum string length: 16
earlyPayEligible
boolean
default:false

Indicates whether the transaction is eligible for early pay.

individual_identification_number
string

Accounting number by which the recipient is known to the direct deposit originator.

Maximum string length: 22
individual_name
string

Identity of the direct deposit recipient.

Maximum string length: 35
standard_entry_class_code
string

Three-letter code identifying the type of entry.

Maximum string length: 3
token
string

Unique identifier of the direct deposit transaction.

If you do not include a token, the system generates one automatically. This token is used in other API calls. Marqeta recommends that you enter a string that you can remember for the token, rather than having the system generate a token for you. This value cannot be updated.

Maximum string length: 36

Response

Created

type
enum<string>

Whether funds are being debited from or credited to the account.

Available options:
CREDIT,
DEBIT
state
enum<string>

Current status of the direct deposit record.

Available options:
PENDING,
APPLIED,
REVERSED,
REJECTED
state_reason
string

Explains the current state of the direct deposit record.

state_reason_code
string

A standard code describing the reason for the current state.

token
string

Unique identifier of the direct deposit record.

user_token
string

Unique identifier of the user associated with the direct deposit record.

amount
number

Amount being debited or credited.

business_token
string

Unique identifier of the business associated with the direct deposit record.

company_discretionary_data
string

Company-specific data provided by the direct deposit originator.

company_entry_description
string

Description of the purpose of the direct deposit.

company_identification
string

Alphanumeric code that identifies the direct deposit originator.

company_name
string

Name of the direct deposit originator.

created_time
string<date-time>

Date and time when the deposit account was created, in UTC.

direct_deposit_account_token
string

Unique identifier of the affected deposit account.

individual_identification_number
string

Accounting number by which the recipient is known to the direct deposit originator.

individual_name
string

Name of the direct deposit recipient.

last_modified_time
string<date-time>

Date and time when the direct deposit account was last modified, in UTC.

settlement_date
string<date-time>

Date and time when the credit or debit is applied, in UTC.

standard_entry_class_code
string

Three-letter code identifying the type of entry.