BusinessChecksReceived Checks
Return a Received Check
POST
Record a deposited check that bounced by matching it to the bank's debit for the check's amount. The debit's journal entries, dated the debit's date, reverse the check's entries against the bank account, and the invoices the check paid are unpaid again. A bank fee arrives as its own Transaction and is categorized normally.
Scopes: check:update
OAuth2ClientCredentialsBearer check:updateheader
AuthorizationBearer <token>Scope: check:update
received_check_id*Received Check IdThe id of the received check
Format
rck_stringbusiness_id*Business IdThe id of the business
Format
biz_stringapplication/json- body
transaction_id*Transaction IdThe ID of the bank Transaction that took the check's amount back out of the account it was deposited to
Format
txn_stringSuccessful Response
application/json- response
data*curl -X POST 'https://api.sandbox.getasset.com/v0/business/biz_GA6EG2qFxA97NZHtxeLPUy/received-checks/rck_WQMDNUHpBThYSNh4AprDBo/return' \ -H 'Content-Type: application/json' \ -d '{ "transaction_id": "txn_oiL7THC5RDi2PVUbVyyoJ"}'Example Response
{ "data": { "business_id": "biz_Pk2fNFDd8wj7EFeLWJywc7", "payer": "Acme Corp", "customer_id": "cus_WQMDNUHpBThYSNh4AprDBo", "amount": 400, "currency": "USD", "check_number": "2207", "payer_routing_number": "021000021", "payer_account_number": "000123456789", "received_at": "2019-08-24T14:15:22Z", "memo": "Invoice INV-1001", "voided_at": "2019-08-24T14:15:22Z", "created_by": "string", "id": "rck_WQMDNUHpBThYSNh4AprDBo", "transaction_id": "txn_oiL7THC5RDi2PVUbVyyoJ", "void_transaction_id": "txn_WQMDNUHpBThYSNh4AprDBo", "deposit_transaction_id": "txn_WQMDNUHpBThYSNh4AprDBo", "deposited_at": "2019-08-24T14:15:22Z", "return_transaction_id": "txn_WQMDNUHpBThYSNh4AprDBo", "returned_at": "2019-08-24T14:15:22Z", "invoice_payments": [ { "invoice_id": "inv_Lq5AyApd4pdL1VvakpY5aJ", "payment_amount": 400 } ], "status": "received" }}