DOCS

New!

/

5 minute read

August 2, 2019

ACH Pending

Use this view endpoint to retrieve pending ACH data aggregated by transaction. The data is derived from the transaction-related messages sent to and from the Marqeta platform. It is available only for programs that are configured to use Automated Clearing House (ACH) bank accounts.

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 ACH pending data (JSON)

Action: GET
Endpoint: /views/achpendings

Retrieve pending ACH data aggregated by transaction. 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/achpendings?program=my_program&post_date=2018-02-01..2018-02-28&fields=acting_user_token,transaction_amount,post_date endpoint.

{
    "total": 3,
    "is_more": false,
    "count": 3,
    "info": {},
    "start_date": "2018-02-09T02:30:17+0000",
    "end_date": "2018-02-09T15:31:03+0000",
    "last_run_time": "2018-02-09T18:03:55Z",
    "schema": [
        {
            "field": "acting_user_token",
            "type": "character varying(50)",
            "display": "Acting User Token",
            "units": null,
            "hasTotal": false,
            "is_filter_only": false
        },
        {
            "field": "transaction_amount",
            "type": "numeric(25,2)",
            "display": "Transaction Amount",
            "units": null,
            "hasTotal": false,
            "is_filter_only": false
        },
        {
            "field": "post_date",
            "type": "timestamp without time zone",
            "display": "Post Date",
            "units": null,
            "hasTotal": false,
            "date_format": "YYYY-MM-DD",
            "is_filter_only": false
        }
    ],
    "records": [
        {
            "acting_user_token": "510adb9c-2ccc-4176-a55b-58b78bade26e",
            "transaction_amount": 300,
            "post_date": "2018-02-09T15:31:03.000Z"
        },
        {
            "acting_user_token": "7gfffe7e-08c3-4135-9506-1729ea03947w",
            "transaction_amount": 500,
            "post_date": "2018-02-09T02:50:16.000Z"
        },
        {
            "acting_user_token": "2a117b38-0d65-4d52-bfd4-194dae3582al",
            "transaction_amount": 150,
            "post_date": "2018-02-09T02:30:17.000Z"
        }
    ]
}

Is this helpful?

Retrieve ACH pending (file export)

Action: GET
Endpoint: /views/achpendings/{export_type}

Retrieve pending ACH data aggregated by transaction. 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.

Path parameters

Fields Description

export_type

string, required

File format in which to export the data.

Allowable Values: csv

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 ACH pending schema

Action: GET
Endpoint: /views/achpendings/schema

Retrieve a JSON representation of the pending ACH view schema for data aggregated by transaction. 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/achpendings/schema?program=my_program endpoint. The schema can vary based on the data aggregation level and the data you are authorized to access (based on the credentials you provide in your request).

[
    {
        "field": "post_date",
        "type": "timestamp without time zone",
        "display": "Post Date",
        "units": null,
        "hasTotal": false,
        "date_format": "YYYY-MM-DD",
        "is_filter_only": false
    },
    {
        "field": "transaction_timestamp_utc",
        "type": "timestamp without time zone",
        "display": "Transaction Timestamp Utc",
        "units": null,
        "hasTotal": false,
        "date_format": "YYYY-MM-DD",
        "is_filter_only": false
    },
    {
        "field": "transaction_timestamp_cst",
        "type": "timestamp without time zone",
        "display": "Transaction Timestamp Cst",
        "units": null,
        "hasTotal": false,
        "date_format": "YYYY-MM-DD",
        "is_filter_only": false
    },
    {
        "field": "transaction_date_cst",
        "type": "date",
        "display": "Transaction Date Cst",
        "units": null,
        "hasTotal": false,
        "date_format": "YYYY-MM-DD",
        "is_filter_only": false
    },
    {
        "field": "transaction_token",
        "type": "bigint",
        "display": "Transaction Token",
        "units": null,
        "hasTotal": false,
        "is_filter_only": false
    },
    {
        "field": "order_token",
        "type": "character varying(80)",
        "display": "Order Token",
        "units": null,
        "hasTotal": false,
        "is_filter_only": false
    },
    {
        "field": "acting_user_id",
        "type": "bigint",
        "display": "Acting User Id",
        "units": null,
        "hasTotal": false,
        "is_filter_only": false
    },
    {
        "field": "acting_user_token",
        "type": "character varying(50)",
        "display": "Acting User Token",
        "units": null,
        "hasTotal": false,
        "is_filter_only": false
    },
    {
        "field": "acting_uai",
        "type": "character varying(50)",
        "display": "Acting Uai",
        "units": null,
        "hasTotal": false,
        "is_filter_only": false
    },
    {
        "field": "transaction_type",
        "type": "character varying(256)",
        "display": "Transaction Type",
        "units": null,
        "hasTotal": false,
        "is_filter_only": false
    },
    {
        "field": "transaction_message",
        "type": "character varying(150)",
        "display": "Transaction Message",
        "units": null,
        "hasTotal": false,
        "is_filter_only": false
    },
    {
        "field": "transaction_amount",
        "type": "numeric(25,2)",
        "display": "Transaction Amount",
        "units": null,
        "hasTotal": 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.