/

5 minute read

September 4, 2020

Direct Deposit

Use this view endpoint to retrieve data about direct deposits. Each row represents a single direct deposit. The data is derived from usage of Marqeta’s Direct Deposit product on the Marqeta platform.

This endpoint supports multiple response formats, query filtering, field filtering, sorting, pagination, and currency conversion. For more information about response options, see Response Customization.

Retrieve direct deposit detail data (JSON)

Action: GET
Endpoint: /views/directdeposit/detail

Retrieve direct deposit detail data. This endpoint returns a JSON object that contains an array of records matching your filter query.

Sample response body

The following sample shows a representative response for a GET request to the /views/directdeposit/detail?program=my_program&fields=direct_deposit_amount,settlement_date endpoint.

{
    "total": 58005,
    "is_more": true,
    "count": 10000,
    "info": {},
    "start_date": "2020-07-01T00:00:00+0000",
    "end_date": "2020-07-13T00:00:00+0000",
    "last_run_time": "",
    "schema": [
        {
            "field": "direct_deposit_amount",
            "type": "numeric(14,2)",
            "description": null,
            "display": "Direct Deposit Amount",
            "units": "USD",
            "has_total": true,
            "is_filter_only": false
        },
        {
            "field": "settlement_date",
            "type": "date",
            "description": "A date field provided by pin networks when a pindebit transaction occurs. This date is typically represented as the date in which the pin network expects that pin transaction to settle so it is usually forward dated 1 or days.",
            "display": "Settlement Date",
            "units": null,
            "has_total": false,
            "date_format": "YYYY-MM-DD",
            "is_filter_only": false
        }
    ],
    "records": [
        {
            "direct_deposit_amount": 29.65,
            "settlement_date": "2021-01-22T00:00:00.000Z"
        },
        {
            "direct_deposit_amount": 1635.65,
            "settlement_date": "2021-01-22T00:00:00.000Z"
        },
        ...
        {
            "direct_deposit_amount": 0.04,
            "settlement_date": "2021-01-21T00:00:00.000Z"
        }
    ]
}

Is this helpful?

Retrieve direct deposit detail data (file export)

Action: GET
Endpoint: /views/directdeposit/detail/{export_type}

Retrieve direct deposit detail data in a file. This endpoint asynchronously generates a file in the specified format and returns a job token for retrieving the file when it is completed. The file contains a list of records matching your filter query.

Query parameters

Fields Description

compress

string
Optional

Type of file compression for the exported file.

Allowable Values:

gz, zip

Default value:
gz

Sample response body

{
    "token":"111122226c444d8888888a9999ae11111db63da4.csv.gz"
}

Is this helpful?

Retrieve direct deposit detail schema

Action: GET
Endpoint: /views/directdeposit/detail/schema

Retrieve a JSON representation of the direct deposit view schema. The schema object contains an array of objects that describe the available columns and the data type of each column.

Sample response body

The following sample shows a representative response for a GET request to the /views/directdeposit/detail/schema?program=my_program endpoint. The schema can vary based on the data you are authorized to access (based on the credentials you provide in your request).

[
    {
        "field": "program",
        "type": "character varying(128)",
        "description": "The name of the card program.",
        "display": "Program",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "bank",
        "type": "character varying(128)",
        "description": "The bank under which the program operates.",
        "display": "Bank",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "company",
        "type": "character varying(128)",
        "description": "The name of the company associated with the card holder, if applicable.",
        "display": "Company",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "company_id",
        "type": "character varying(128)",
        "description": null,
        "display": "Company Id",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "originating_dfi_identification",
        "type": "character varying(128)",
        "description": "Originating Dfi Identification",
        "display": "Originating Dfi Identification",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "ach_transaction_id",
        "type": "bigint",
        "description": null,
        "display": "Ach Transaction Id",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "prefix",
        "type": "character varying(128)",
        "description": null,
        "display": "Prefix",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "ach_transaction_token",
        "type": "character varying(128)",
        "description": null,
        "display": "Ach Transaction Token",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "record_type",
        "type": "character varying(128)",
        "description": null,
        "display": "Record Type",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "processor_state",
        "type": "character varying(128)",
        "description": null,
        "display": "Processor State",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "reject_reason_code",
        "type": "character varying(128)",
        "description": null,
        "display": "Reject Reason Code",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "returned_as_reject",
        "type": "timestamp without time zone",
        "description": null,
        "display": "Returned As Reject",
        "units": null,
        "has_total": false,
        "date_format": "YYYY-MM-DD",
        "is_filter_only": false
    },
    {
        "field": "reference_token",
        "type": "character varying(128)",
        "description": null,
        "display": "Reference Token",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "memo",
        "type": "character varying(128)",
        "description": "Memo associated.",
        "display": "Memo",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "transition_token",
        "type": "character varying(128)",
        "description": null,
        "display": "Transition Token",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "ach_company_batch_header",
        "type": "character varying(128)",
        "description": null,
        "display": "Ach Company Batch Header",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "ach_entry_detail_record",
        "type": "character varying(128)",
        "description": null,
        "display": "Ach Entry Detail Record",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "ach_processed_file",
        "type": "character varying(128)",
        "description": null,
        "display": "Ach Processed File",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "ach_reject_network_submission",
        "type": "character varying(128)",
        "description": null,
        "display": "Ach Reject Network Submission",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "ach_transaction_created_time",
        "type": "timestamp without time zone",
        "description": null,
        "display": "Ach Transaction Created Time",
        "units": null,
        "has_total": false,
        "date_format": "YYYY-MM-DD",
        "is_filter_only": false
    },
    {
        "field": "ach_transaction_lmt",
        "type": "timestamp without time zone",
        "description": null,
        "display": "Ach Transaction Lmt",
        "units": null,
        "has_total": false,
        "date_format": "YYYY-MM-DD",
        "is_filter_only": false
    },
    {
        "field": "ach_detail_token",
        "type": "character varying(128)",
        "description": null,
        "display": "Ach Detail Token",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "ach_detail_record_type",
        "type": "character varying(128)",
        "description": null,
        "display": "Ach Detail Record Type",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "transaction_code",
        "type": "character varying(128)",
        "description": null,
        "display": "Transaction Code",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "receiving_dfi_identification",
        "type": "character varying(128)",
        "description": null,
        "display": "Receiving Dfi Identification",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "check_digit",
        "type": "character varying(128)",
        "description": null,
        "display": "Check Digit",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "dfi_account_number",
        "type": "character varying(128)",
        "description": null,
        "display": "Dfi Account Number",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "account_number_hash",
        "type": "character varying(128)",
        "description": null,
        "display": "Account Number Hash",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "direct_deposit_amount",
        "type": "numeric(14,2)",
        "description": null,
        "display": "Direct Deposit Amount",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "individual_identification_number",
        "type": "character varying(128)",
        "description": null,
        "display": "Individual Identification Number",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "individual_name",
        "type": "character varying(128)",
        "description": null,
        "display": "Individual Name",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "discretionary_data",
        "type": "character varying(128)",
        "description": null,
        "display": "Discretionary Data",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "addenda_record_indicator",
        "type": "character varying(128)",
        "description": null,
        "display": "Addenda Record Indicator",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "trace_number",
        "type": "character varying(128)",
        "description": null,
        "display": "Trace Number",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "trace_number2",
        "type": "character varying(128)",
        "description": null,
        "display": "Trace Number2",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "ach_detail_created_time",
        "type": "timestamp without time zone",
        "description": null,
        "display": "Ach Detail Created Time",
        "units": null,
        "has_total": false,
        "date_format": "YYYY-MM-DD",
        "is_filter_only": false
    },
    {
        "field": "ach_detail_lmt",
        "type": "timestamp without time zone",
        "description": null,
        "display": "Ach Detail Lmt",
        "units": null,
        "has_total": false,
        "date_format": "YYYY-MM-DD",
        "is_filter_only": false
    },
    {
        "field": "file_name",
        "type": "character varying(128)",
        "description": null,
        "display": "File Name",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "archived_file_path",
        "type": "character varying(128)",
        "description": null,
        "display": "Archived File Path",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "file_of_the_day",
        "type": "character varying(128)",
        "description": null,
        "display": "File Of The Day",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "rejected_network_submission_created_time",
        "type": "timestamp without time zone",
        "description": null,
        "display": "Rejected Network Submission Created Time",
        "units": null,
        "has_total": false,
        "date_format": "YYYY-MM-DD",
        "is_filter_only": false
    },
    {
        "field": "state",
        "type": "character varying(128)",
        "description": null,
        "display": "State",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "state_reason",
        "type": "character varying(128)",
        "description": null,
        "display": "State Reason",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "account_automatched",
        "type": "character varying(128)",
        "description": null,
        "display": "Account Automatched",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "cardholder",
        "type": "character varying(128)",
        "description": "Used in the chargebacks detail view to represent the financial impact to the account of a cardholder as it relates to a particular chargeback event",
        "display": "Cardholder",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "company_entry_description",
        "type": "character varying(128)",
        "description": null,
        "display": "Company Entry Description",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "settlement_date",
        "type": "date",
        "description": "A date field provided by pin networks when a pindebit transaction occurs. This date is typically represented as the date in which the pin network expects that pin transaction to settle so it is usually forward dated 1 or days.",
        "display": "Settlement Date",
        "units": null,
        "has_total": false,
        "date_format": "YYYY-MM-DD",
        "is_filter_only": false
    },
    {
        "field": "standard_entry_classcode",
        "type": "character varying(128)",
        "description": null,
        "display": "Standard Entry Classcode",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "reversed_after_graceperiod",
        "type": "integer",
        "description": null,
        "display": "Reversed After Graceperiod",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "company_discretionary_data",
        "type": "character varying(128)",
        "description": null,
        "display": "Company Discretionary Data",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "first_name",
        "type": "character varying(128)",
        "description": "The first name of the card holder.",
        "display": "First Name",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "last_name",
        "type": "character varying(128)",
        "description": "The last name of the card holder.",
        "display": "Last Name",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "user_token",
        "type": "character varying(128)",
        "description": "A unique identifier (within a given Marqeta Card Program) for a user record. All other refernces to a user token will be prefaced with account, business, parent or acting to specify which user token is referenced.",
        "display": "User Token",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "transaction_token",
        "type": "character varying(128)",
        "description": "The token of the transaction; unique within a program.",
        "display": "Transaction Token",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "currency",
        "type": "character varying(10)",
        "description": "The abbreviated currency code.",
        "display": "Currency",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "name_matching_score",
        "type": "numeric(14,2)",
        "description": null,
        "display": "Name Matching Score",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "originator_status_code",
        "type": "character varying(128)",
        "description": null,
        "display": "Originator Status Code",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "user_status",
        "type": "character varying(128)",
        "description": null,
        "display": "User Status",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "user_address1",
        "type": "character varying(765)",
        "description": "The street address associated with a user record.",
        "display": "User Address1",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "user_address2",
        "type": "character varying(765)",
        "description": "The street address associated with a user record.",
        "display": "User Address2",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "user_city",
        "type": "character varying(128)",
        "description": "The city associated with a user record address.",
        "display": "User City",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "user_state",
        "type": "character varying(128)",
        "description": "The state associated with a user record address.",
        "display": "User State",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "user_zip",
        "type": "character varying(128)",
        "description": "The zip code associated with a user record address.",
        "display": "User Zip",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "user_country",
        "type": "character varying(128)",
        "description": "The country associated with a user record address.",
        "display": "User Country",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    }
]

Is this helpful?

Have any feedback on this page?

If you feel we can do anything better, please let our team know.

We strive for the best possible developer experience.