The object is everything inside data. The field names below are relative to it: attributes.amount is data.attributes.amount in the response.
Fields
string
required
Resource type. Always check.
string
required
Check ID (chk_*).
object
required
The check’s details.
Hide attributes
integer
required
Amount in cents.
string
required
Currency code. Always USD.
object | null
required
Fee added to your cost as the sender. Null when no fee applies, the check ended before it was issued, the fee was voided, your party is not the fee payer, or the response is to a cancel request. Get the check to read its fee after a cancel.
Hide fee
integer
required
Fee amount in cents.
string
required
Currency of the fee. Always USD.
string
required
Party role charged the fee. Always sender.
string
required
The fee is added to the sender’s cost without reducing the principal amount. Always on_top.
string
required
Check status. approvalDenied, returned, canceled, expired, rejected and failed are final; completed can still become returned, and canceling is waiting for the bank to confirm a stop payment. One of: created, awaitingApproval, approvalDenied, processing, completed, returned, canceling, canceled, expired, rejected, failed. See Statuses.
string
required
Memo printed on the check.
string | null
required
Letter text printed on the mailing insert, or null.
string | null
required
Description for your internal reference, or null. Never printed on the check or shared with the counterparty.
string
required
How the check is mailed. One of: uspsFirstClass, fedexTwoDay, fedexOvernight.
string | null
required
Printed check number, or null.
string | null
required
Date after which the check is void, or null.
object
required
Payee and the address the check was mailed to, captured when the check was created.
Hide payee
string
required
Payee name printed on the check.
string
required
Payee street address line 1.
string | null
required
Payee street address line 2.
string
required
Payee city.
string
required
Payee state.
string
required
Payee postal code.
integer
required
Version of the recipient address captured when the check was created.
object | null
required
Delivery tracking for the mailed check, or null before it is rendered.
Hide delivery
string
required
Mail delivery status. One of: created, renderedPdf, mailed, inTransit, inLocalArea, processedForDelivery, delivered, rerouted, returnedToSender, failed.
string | null
required
Tracking URL for the mailed check, or null.
string | null
required
RFC 3339 timestamp when the check was mailed, or null.
string | null
required
RFC 3339 timestamp when the check was delivered, or null.
string | null
required
RFC 3339 timestamp when the check was returned to sender, or null.
string | null
required
RFC 3339 timestamp when delivery was last updated, or null.
object[]
required
Presentment returns observed without moving the payment status.
Hide presentmentReturns
string
required
Presentment return code.
string
required
Presentment return reason.
string
required
RFC 3339 timestamp when the presentment return was observed.
object | null
required
Post-settlement return details, or null.
Hide return
string
required
Return code.
string | null
required
Return reason, or null.
string | null
required
RFC 3339 timestamp when the return was observed, or null.
object | null
required
Cancellation details when the check is canceling or canceled, or null.
Hide cancellation
string | null
required
Cancellation reason, or null.
string | null
required
Return code that drove the cancellation, or null.
string | null
required
RFC 3339 timestamp when cancellation was requested, or null.
string | null
required
RFC 3339 timestamp when cancellation was confirmed, or null.
object | null
required
Failure details when the check failed, or null.
Hide failure
string | null
required
Failure code, or null.
string | null
required
Failure reason, or null.
string | null
required
Why the check ended, or null: CHECK_CANCELED (you canceled it), CHECK_STOPPED (the bank confirmed a stop payment), CHECK_SECOND_RETURN_VOID (voided after a second refused presentment), CHECK_EXPIRED, CHECK_ISSUANCE_REJECTED, CHECK_ISSUANCE_FAILED, or CHECK_RETURNED.
string | null
required
RFC 3339 timestamp when the check was submitted, or null.
string | null
required
RFC 3339 timestamp when the check was issued, or null.
string | null
required
RFC 3339 timestamp when a stop was requested, or null.
string | null
required
RFC 3339 timestamp when the check completed, or null.
string | null
required
RFC 3339 timestamp when the check was returned, or null.
string | null
required
RFC 3339 timestamp when the check was canceled, or null.
string | null
required
RFC 3339 timestamp when the check expired, or null.
string | null
required
RFC 3339 timestamp when the check was rejected, or null.
string | null
required
RFC 3339 timestamp when the check reached its current end status, or null. It changes if a completed check is later returned.
string
required
RFC 3339 timestamp when the check was created.
string
required
RFC 3339 timestamp when the check was last updated.
object
required
Related resources, each by type and ID.
Hide relationships
object
required
Party the check was created for.
Hide customerParty
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always party.
string
required
Party ID (pty_*).
object
required
Wallet the check pays from.
Hide wallet
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always wallet.
string
required
Wallet ID (wal_*).
object
required
External party paid.
Hide externalParty
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always externalParty.
string
required
External party ID (epty_*).
Statuses
Status
Meaning
Can become
created
Natural saved the check and hasn’t sent it to the bank yet.
Your approval policy or an approver denied the check before it was sent.
Final
processing
Sent to the bank and not paid yet. A first refused presentment adds to presentmentReturns and leaves the check here. Undeliverable mail (check.returnedToSender) also leaves it here, with the amount still held, until you cancel it or it expires.