# List ACH Receivings

List ACH receivings, the ACH entries received into your customers' pockets, newest first. Filters combine: a receiving is listed only if it matches every filter given.

Endpoint: GET /api/v1/ach-receiving/
Version: Version: cc7932b2
Security: HTTPBearer

## Security:

  - `HTTPBearer` (unknown)
    http bearer

## Query parameters:

  - `customer_id` (any)

  - `pocket_id` (any)

  - `portal_id` (any)

  - `filter[status]` (any)

  - `direction` (any)

  - `cursor` (string)

  - `limit` (integer)

## Header parameters:

  - `x-jiko-idempotency` (string, required)
    A UUID you generate to identify this request. Reusing a value that was already sent is rejected as a duplicate request.

  - `x-jiko-signature` (string, required)
    Base64-encoded HMAC-SHA256 hash of `x-jiko-idempotency + request pathname + body`, keyed with your shared secret. See [Authentication](/products/partner-api/guides/building/auth) for the full algorithm and a code sample.

## Response 200:

  - `200` (unknown)
    Successful Response

## Response 200 fields (application/json):

  - `prev_page` (any)

  - `next_page` (any)

  - `items` (array, required)

  - `items.id` (string, required)
    The ID of the ACH receiving.

  - `items.pocket_id` (string, required)
    The pocket the entry was posted to.

  - `items.amount` (object, required)

  - `items.amount.value` (integer, required)
    USD values are always in cents.

  - `items.amount.currency` (string, required)

  - `items.amount.formatted` (string)

  - `items.direction` (string, required)
    `CREDIT` when funds move into the pocket, `DEBIT` when they move out of it.
    Enum: "DEBIT", "CREDIT"

  - `items.status` (string, required)
    The status of the ACH receiving: `PENDING`, `PROCESSED` or `REJECTED`. A `REJECTED` receiving can later become `PROCESSED` if it is reprocessed.
    Enum: "PENDING", "PROCESSED", "REJECTED"

  - `items.rejection_reason` (any)
    Why the receiving was rejected: `INSUFFICIENT_FUNDS`, `ACCOUNT_UNAVAILABLE` or `OTHER`. Set only when `status` is `REJECTED`, null otherwise.

  - `items.time_created` (string, required)
    When the ACH receiving was created.

  - `items.portal_id` (any)
    The portal the entry arrived through. Null if not available.

  - `items.company_name` (any)
    The originator's name. Null if not available.

  - `items.company_identification` (any)
    The originator's company identification. Null if not available.

  - `items.company_entry_description` (any)
    The originator's description of the purpose of the entry, for example `PAYROLL`. Null if not available.

  - `items.sec_code` (any)
    The Standard Entry Class code of the entry. Common values are `PPD`, `CCD`, `WEB` and `IAT`. Null if not available.

  - `items.trace_number` (any)
    The trace number of the entry. Null if not available.

  - `items.effective_entry_date` (any)
    The date the originator intended the entry to settle. Null if not available.

  - `items.settlement_date` (any)
    The date the entry settled. Null if not available.

  - `items.payment_related_information` (array)
    Payment related information from the entry's addenda records, in order. Empty if there is none, and for `IAT` entries.

  - `items.individual_identification_number` (any)
    The originator's reference for the receiver. Null if not available, and for `IAT` entries.

  - `items.object_type` (string, required)

  - `object_type` (string)

## Response 422:

  - `422` (unknown)
    Validation Error

## Response 422 fields (application/json):

  - `detail` (array)

  - `detail.loc` (array, required)

  - `detail.msg` (string, required)

  - `detail.type` (string, required)

  - `detail.input` (any)

  - `detail.ctx` (object)

