GET
/
check
curl --request GET \
  --url https://api.treasuryprime.com/check \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": [
    {
      "account_id": "acct_11gag8g8aw8tzv",
      "amount": "10.05",
      "check_date": "2021-11-09T22:39:48Z",
      "check_number": "12012",
      "created_at": "2021-11-09T22:39:48Z",
      "id": "ch_11grny5mfhvjnp",
      "memo": "presidential pension",
      "message": "Presidential pension for November 2021. Please deposit within 60 days.",
      "recipient": {
        "address": {
          "city": "Washington",
          "postal_code": "20003",
          "state": "DC",
          "street_line_1": "1600 Pennsylvania Ave.",
          "street_line_2": ""
        },
        "name": "George Washington"
      },
      "status": "pending",
      "userdata": null
    }
  ]
}

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.

The response is of type object.