MAmarqeta
Simulations 2.0 — Direct Deposits

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.

post/simulations/directdeposits/credit

Request

Request body

account_numberstring required

The account number of the user to debit or credit.

amountnumber required

Amount of the transaction.

company_discretionary_datastring

Company-specific data provided by the direct deposit originator.

company_entry_descriptionstring

Company-specific data provided by the direct deposit originator.

company_identificationstring

Alphanumeric code that identifies the direct deposit originator.

company_namestring

Name of the direct deposit originator.

earlyPayEligibleboolean

Indicates whether the transaction is eligible for early pay.

individual_identification_numberstring

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

individual_namestring

Identity of the direct deposit recipient.

settlement_datestring date-time required

Date when the credit or debit is applied.

standard_entry_class_codestring

Three-letter code identifying the type of entry.

tokenstring

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.

type'CREDIT' | 'DEBIT'

Provides information about whether funds are being debited from or credited to the account.

Response

Created

type'CREDIT' | 'DEBIT'

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

state'PENDING' | 'APPLIED' | 'REVERSED' | 'REJECTED'

Current status of the direct deposit record.

state_reasonstring

Explains the current state of the direct deposit record.

state_reason_codestring

A standard code describing the reason for the current state.

tokenstring

Unique identifier of the direct deposit record.

user_tokenstring

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

amountnumber

Amount being debited or credited.

business_tokenstring

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

company_discretionary_datastring

Company-specific data provided by the direct deposit originator.

company_entry_descriptionstring

Description of the purpose of the direct deposit.

company_identificationstring

Alphanumeric code that identifies the direct deposit originator.

company_namestring

Name of the direct deposit originator.

created_timestring date-time

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

direct_deposit_account_tokenstring

Unique identifier of the affected deposit account.

individual_identification_numberstring

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

individual_namestring

Name of the direct deposit recipient.

last_modified_timestring date-time

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

settlement_datestring date-time

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

standard_entry_class_codestring

Three-letter code identifying the type of entry.

Example response

{
  "token": "**DIRECT_DEPOSIT_TOKEN**",
  "user_token": "**USER_TOKEN**",
  "type": "CREDIT",
  "state": "PENDING",
  "state_reason": "testing",
  "amount": 10,
  "created_time": "2025-03-23T19:34:05Z",
  "direct_deposit_account_token": "**DIRECT_DEPOSIT_ACCT_TOKEN**",
  "last_modified_time": "2025-03-23T19:34:05Z",
  "settlement_date": "2025-02-03T13:22:42Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.