5 minute read

August 1, 2019

ACH Gateway

Use this view endpoint to retrieve ACH gateway 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 gateway data (JSON)
Copy section link
Copy section link

Action: GET
Endpoint: /views/achgateways

Retrieve ACH gateway data aggregated by transaction. This endpoint returns a JSON object that contains an array of records matching your filter query.

Sample response body
Copy section link
Copy section link

The following sample shows a representative response for a GET request to the views/achgateways?program=my_program&amount=>7000&fields=acting_user_token,transaction_amount endpoint.

{
    "total": 7,
    "is_more": false,
    "count": 7,
    "info": {},
    "start_date": "2018-02-01T00:00:00+0000",
    "end_date": "2018-02-10T00:00:00+0000",
    "last_run_time": "2018-02-09T18:03:18Z",
    "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(14,2)",
            "display": "Transaction Amount",
            "units": null,
            "hasTotal": false,
            "is_filter_only": false
        }
    ],
    "records": [
        {
            "acting_user_token": "a3294178-4ac4-4630-9ed1-f73947977444",
            "transaction_amount": 10000
        },
        {
            "acting_user_token": "bg0a4f92-982c-4c6f-a44b-2021bca9ccf4",
            "transaction_amount": 8568.53
        },
        {
            "acting_user_token": "cr294178-4ac4-4630-9ed1-f73947977442",
            "transaction_amount": 10000
        },
        {
            "acting_user_token": "e3294178-4ac4-4630-9ed1-f73947977443",
            "transaction_amount": 10000
        },
        {
            "acting_user_token": "7a203048-9dbe-40e4-95a3-f295f9cd020d",
            "transaction_amount": 8000
        },
        {
            "acting_user_token": "100a4f92-982c-4c6f-a44b-2021bca9ccf6",
            "transaction_amount": 10000
        },
        {
            "acting_user_token": "aa8dd2a4-561b-4f59-bcb0-8192624684e3",
            "transaction_amount": 10000
        }
    ]
}

Is this helpful?

Retrieve ACH gateway (file export)
Copy section link
Copy section link

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

Retrieve ACH gateway 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
Copy section link
Copy section link

Fields	Description
export_type string, required	File format in which to export the data. Allowable Values: csv

Fields

Description

export_type

string, required

File format in which to export the data.

Allowable Values: csv

Query parameters
Copy section link
Copy section link

Fields	Description
compress string, optional	Type of file compression for the exported file. Allowable Values: gz, zip Default value: gz

Fields

Description

compress

string, optional

Type of file compression for the exported file.

Allowable Values: gz, zip

Default value: gz

Sample response body
Copy section link
Copy section link

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

Is this helpful?

Retrieve ACH gateway schema
Copy section link
Copy section link

Action: GET
Endpoint: /views/achgateways/schema

Retrieve a JSON representation of the ACH gateway 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
Copy section link
Copy section link

The following sample shows a representative response for a GET request to the /views/achgateways/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": "created_on_date",
        "type": "timestamp without time zone",
        "display": "Created On Date",
        "units": null,
        "hasTotal": false,
        "date_format": "YYYY-MM-DD",
        "is_filter_only": false
    },
    {
        "field": "gateway_token",
        "type": "bigint",
        "display": "Gateway Token",
        "units": null,
        "hasTotal": false,
        "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": "ach_type",
        "type": "character varying(36)",
        "display": "Ach Type",
        "units": null,
        "hasTotal": false,
        "is_filter_only": false
    },
    {
        "field": "response_message",
        "type": "character varying(300)",
        "display": "Response Message",
        "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_amount",
        "type": "numeric(14,2)",
        "display": "Transaction Amount",
        "units": null,
        "hasTotal": false,
        "is_filter_only": false
    }
]

Is this helpful?

ACH Gateway

Retrieve ACH gateway data (JSON) Copy section linkCopy section link

Sample response body Copy section linkCopy section link

Retrieve ACH gateway (file export) Copy section linkCopy section link

Path parameters Copy section linkCopy section link

Query parameters Copy section linkCopy section link

Sample response body Copy section linkCopy section link

Retrieve ACH gateway schema Copy section linkCopy section link

Sample response body Copy section linkCopy section link

Related Materials

Have any feedback on this page?

Retrieve ACH gateway data (JSON)
Copy section link
Copy section link

Sample response body
Copy section link
Copy section link

Retrieve ACH gateway (file export)
Copy section link
Copy section link

Path parameters
Copy section link
Copy section link

Query parameters
Copy section link
Copy section link

Sample response body
Copy section link
Copy section link

Retrieve ACH gateway schema
Copy section link
Copy section link

Sample response body
Copy section link
Copy section link