Check Deposits

Get Check Deposit

Get a check deposit by check deposit id.

Verb	GET
URL	https://api.s.unit.sh/ready-to-launch/check-deposits/:checkDepositId
Required Scope	check-deposits
Timeout (Seconds)	5

Example Request:

curl -X GET 'https://api.s.unit.sh/ready-to-launch/check-deposits/12345' \
-H "Authorization: Bearer ${TOKEN}"

Response

Returns check deposit details including direction, type, created at, tags, summary, counterparty, amount and balance (in cents).

Response is a JSON:API document.

200 OK

Name	Type	Description
id Required	string	Identifier of the check deposit resource.
type Required	string	Type of the check deposit resource. The value is always checkDeposit.
attributes Required	JSON Object	JSON object representing the check deposit data.
relationships Required	JSON:API Relationships	Describes relationships between the check deposit resource and other resources.

Attributes

Name	Type	Description
amount Required	integer	The amount (cents) of the check deposit.
direction Required	string	The direction in which the funds flow.
type Required	string	The type of the check deposit.
createdAt Required	string	The date the check deposit was created.
balance Required	integer	The account balance (cents) after the check deposit.
tags Optional	object	See Tags.
summary Required	string	A brief summary of the check deposit.
counterparty Optional	object	The counterparty of the check deposit. See Counterparty

Example Response:

{
  "data": {
    "type": "checkDeposit",
    "id": "12345",
    "attributes": {
      "amount": 50000,
      "direction": "Credit",
      "type": "CheckDeposit",
      "createdAt": "2021-06-02T10:15:22.123Z",
      "balance": 150000,
      "tags": {
        "purpose": "invoice-payment"
      },
      "summary": "Check deposit from John Doe",
      "counterparty": {
        "name": "John Doe",
        "routingNumber": "812345678",
        "accountNumber": "1000000002",
        "accountType": "Checking"
      }
    },
    "relationships": {
      "account": {
        "data": {
          "type": "account",
          "id": "10004"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      }
    }
  }
}