POST
/
check
curl --request POST \
  --url https://api.treasuryprime.com/check \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "account_id": "acct_11gag8g8aw8tzv",
  "amount": "10.05",
  "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"
  }
}'
{
  "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.

Body

application/json
The check to create
​
account_id
string
required

ID of the Account issuing the check. Filterable.

​
amount
string
required

Amount of money to transfer, with two decimal precision

​
recipient
object
required

Recipient of the check

​
check_date
string

Date on which the check was issued

​
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.

​
memo
string

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

​
message
string

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

​
status
string

Status of check. Filterable.

​
userdata
object

Arbitrary data the user can attach to the object

Response

200 - application/json
The check created
​
account_id
string

ID of the Account issuing the check. Filterable.

​
amount
string

Amount of money to transfer, with two decimal precision

​
bank_id
string

ID of the bank with which the object is associated

​
check_date
string

Date on which the check was issued

​
check_number
string

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

​
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.

​
error
string

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

​
id
string

Unique identifier for object

​
memo
string

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

​
message
string

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

​
org_id
string

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

​
recipient
object

Recipient of the check

​
signatory_name
string

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

​
status
string

Status of check. Filterable.

​
userdata
object

Arbitrary data the user can attach to the object