DisbursementsCheck Transfers

Get a check transfer

Get a check transfer by its unique identifier.

Path parameters

idstringRequired

The unique identifier for the check transfer

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

The check transfer was retrieved

idstring

The unique identifier for the check transfer

amountlong

The amount of the check transfer in minor currency units (cents)

statusenum

The lifecycle status of the check. The set of statuses include:

  • pending: The check is pending review by Chariot.
  • canceled: The check has been canceled.
  • issued: The check has been mailed and is pending delivery.
  • rejected: The check was rejected by Chariot.
  • deposited: The check has been deposited by the receiving organization.
  • stopped: A stop payment was requested on the check.
  • returned: The check has been returned by the receiving organization.

To see a more detailed description of each status and the overall lifecycle of check disbursements, see the “Transfer Statuses” section of the Chariot documentation.

memostring

The memo on the check

mailing_addressobject

A postal address is a mailing address where physical mail can be received. Postal addresses can be used to receive paper checks.

created_atdatetime

The date and time the check transfer was created

check_numberstringOptional

The check number

tracking_updateslist of objectsOptional

The list of tracking updates for the check

submitted_atdatetimeOptional

The date and time the check was submitted to the carrier.

canceled_atdatetimeOptional

The date and time the check was canceled.

stopped_atdatetimeOptional

The date and time the check was stopped.

deposited_atdatetimeOptional

The date and time the check was deposited.

updated_atdatetimeOptional

The date and time the check transfer was last updated

Errors