---
title: "Get check posting"
method: GET
path: "/corporate/v1/checks/{checkId}"
tags: ["Check posting"]
---

# Get check posting

`GET /corporate/v1/checks/{checkId}`

## Request

- Base URL: `https://sandbox.pismolabs.io`
- URL: `https://sandbox.pismolabs.io/corporate/v1/checks/{checkId}`
- Auth: HTTP bearer

Get information about a posted check using its check ID.

## Path parameters

- `checkId` string, required

## Response `200`

OK

- CheckPosting: Check posting object.
  - `account_id` integer, required: Account ID
  - `external_account_id` string, required: Account external ID to which the check is posted.
  - `check_id` string, required: Check ID.
  - `check_amount` CheckAmount, required: Total check amount.
    - `value` number, float, required: Amount value
    - `currency` string: 3-letter code in ISO 4217-compliant format for the currency used in the transaction.
  - `description` string: A brief description about a check posting transaction.
  - `settlement_type` 'BEGINNING' | 'END', required: Indicates when funds become available to the bank: `BEGINNING` or `END`.
  - `status` 'PENDING' | 'CREATING' | 'UNCLEARED' | 'SETTLING' | 'PARTIALLY_SETTLED' | 'SETTLED' | 'CANCELING' | 'CANCELED' | 'PAYMENT_FAILED' | 'RELEASE_FAILED' | 'CANCEL_FAILED', required: Check posting status.
  - `available_amount` number, float, required: Available check amount.
  - `uncleared_amount` number, float, required: Uncleared check amount.
  - `held_amount` number, float, required: Held check amount.
  - `settlements` CheckSettlementItem[], required
    - `settlement_id` string, required: Check Settlement ID.
    - `type` 'DEPOSIT' | 'PENDING' | 'HOLD', required: Settlement type. Indicates the nature of the settlement.
    - `amount` number, required: Amount to be settled in the specified operation.
    - `settlement_date` string, date, required: Settlement date in ISO 8601 format (yyyy-mm-dd).
    - `status` 'CREATING' | 'UNSETTLED' | 'SETTLED' | 'PAYMENT_FAILED' | 'PAYMENT_ROLLING_BACK' | 'PAYMENT_ROLL_BACK_FAILED' | 'PAYMENT_ROLLED_BACK' | 'SETTLING' | 'RELEASE_FAILED' | 'RELEASE_ROLLING_BACK' | 'RELEASE_ROLLED_BACK' | 'RELEASE_ROLLBACK_FAILED' | 'CANCELING' | 'CANCELED' | 'CANCEL_FAILED', required: Check settlement status.

## Other responses

- `404`: Not Found

---

[API](https://skmtc.dev/pismo/apis/banking-transaction-banking.md) - [All operations](https://skmtc.dev/pismo/apis/banking-transaction-banking/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/banking-transaction-banking/revisions/1334306c9303?raw)
