Fetch an Issued Check - Treasury Prime Developer Documentation

Fetch an Issued Check

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

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.treasuryprime.com/check/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.treasuryprime.com/check/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.treasuryprime.com/check/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.treasuryprime.com/check/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "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
}

GET

/

check

/

{id}

Fetch an Issued Check

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

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.treasuryprime.com/check/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.treasuryprime.com/check/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.treasuryprime.com/check/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.treasuryprime.com/check/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "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.

Path Parameters

id

string

required

Unique identifier for object

Response

200 - application/json

The check

account_id

string

ID of the Account issuing the check. Filterable.

amount

string

Amount of money to transfer, with two decimal precision

Pattern: ^-?[0-9]+[.][0-9][0-9]$

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

Show child attributes

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