Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Check posting

Get check posting

Get information about a posted check using its check ID.

get/corporate/v1/checks/{checkId}

Path parameters

checkIdstring required

Check ID

Response

OK

account_idinteger required

Account ID

external_account_idstring required

Account external ID to which the check is posted.

check_idstring required

Check ID.

descriptionstring

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_amountnumber float required

Available check amount.

uncleared_amountnumber float required

Uncleared check amount.

held_amountnumber float required

Held check amount.

Example response

{
  "account_id": 6912345,
  "external_account_id": "6b6e32c3-6f67-453e-8221-bafa8993e113",
  "check_id": "c462b2f3-55cc-42b4-ae9a-7614df3e8e72",
  "check_amount": {
    "value": 1000.52,
    "currency": "USD"
  },
  "description": "Check posting",
  "settlement_type": "END",
  "status": "SETTLED",
  "available_amount": 2000,
  "settlements": [
    {
      "settlement_id": "c462b2f3-55cc-42b4-ae9a-7614df3e8e72",
      "type": "HOLD",
      "amount": 100,
      "settlement_date": "2025-01-06",
      "status": "SETTLED"
    }
  ]
}