List Issued Checks

List Issued Checks

curl --request GET \
  --url https://api.treasuryprime.com/check \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": [
    {
      "account_id": "<string>",
      "amount": "<string>",
      "bank_id": "<string>",
      "check_date": "<string>",
      "check_number": "<string>",
      "delivery_method": "<string>",
      "error": "<string>",
      "id": "<string>",
      "memo": "<string>",
      "message": "<string>",
      "org_id": "<string>",
      "recipient": {
        "address": {
          "city": "<string>",
          "postal_code": "<string>",
          "state": "<string>",
          "street_line_1": "<string>",
          "street_line_2": "<string>"
        },
        "name": "<string>"
      },
      "signatory_name": "<string>",
      "status": "<string>",
      "userdata": {}
    }
  ]
}

GET

check

List Issued Checks

curl --request GET \
  --url https://api.treasuryprime.com/check \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": [
    {
      "account_id": "<string>",
      "amount": "<string>",
      "bank_id": "<string>",
      "check_date": "<string>",
      "check_number": "<string>",
      "delivery_method": "<string>",
      "error": "<string>",
      "id": "<string>",
      "memo": "<string>",
      "message": "<string>",
      "org_id": "<string>",
      "recipient": {
        "address": {
          "city": "<string>",
          "postal_code": "<string>",
          "state": "<string>",
          "street_line_1": "<string>",
          "street_line_2": "<string>"
        },
        "name": "<string>"
      },
      "signatory_name": "<string>",
      "status": "<string>",
      "userdata": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

account_id

string

ID of the Account issuing the check. Filterable.

org_id

string

ID of the organization with which the object is associated. Filterable.

status

string

Status of check. Filterable.

page_cursor

string

Pagination cursor, value is the object ID.

page_size

integer

default:100

Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.

Required range: x >= 1

from_date

string

Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).

to_date

string

Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).

Response

200 - application/json

A dictionary with a data property that contains a list of up to page_size check elements, starting after the check described by page_cursor. If no more checks are available, the resulting list will be empty.

data

object[]

Show child attributes

data.account_id

string

ID of the Account issuing the check. Filterable.

data.amount

string

Amount of money to transfer, with two decimal precision

data.bank_id

string

ID of the bank with which the object is associated

data.check_date

string

Date on which the check was issued

data.check_number

string

The number printed on the issued check. Check numbers are automatically generated after check object creation

data.delivery_method

string

Delivery options for sending the check with the default being standard USPS shipping. For USPS First Class, Overnight, Two Day, and USPS Certified delivery options please contact support to ensure your account is properly configured for sending through those methods.

data.error

string

An error message of why the check is in error status.

data.id

string

Unique identifier for object

data.memo

string

Optional text to include on the memo line of the check (max of 40 characters)

data.message

string

Optional text to include on the bottom of the check page (maximum of 400 characters)

data.org_id

string

ID of the organization with which the object is associated. Filterable.

data.recipient

object

Recipient of the check

Show child attributes

data.recipient.address

object

Address of the recipient

Show child attributes

data.recipient.address.city

string

City (max 21 characters)

data.recipient.address.postal_code

string

Postal code (5-digit or 5+4 Zip Code for U.S. addresses)

data.recipient.address.state

string

State (max 2 characters)

data.recipient.address.street_line_1

string

First line of the address (max 35 characters)

data.recipient.address.street_line_2

string

Optional second line of the address (max 35 characters)

data.recipient.name

string

Name of the recipient

data.signatory_name

string

The name of the person or entity being used as the signatory on this check

data.status

string

Status of check. Filterable.

data.userdata

object

Arbitrary data the user can attach to the object

Overview Issue a Check

⌘I

Introduction

Account

Account Opening

Cards

Payments

Testing

Utilities

Authorizations

Query Parameters

Response