Skip to Content
BusinessChecksReceived Checks

Void a Received Check

POST
/v0/business/{business_id}/received-checks/{received_check_id}/void

Void a check recorded in error. A Transaction dated the void date reverses the check's journal entries, and the invoices it paid are unpaid again. A deposited check cannot be voided.

Scopes: check:update

Authorization

OAuth2ClientCredentialsBearer check:update
headerAuthorizationBearer <token>

Scope: check:update

Path Parameters

received_check_id*Received Check Id

The id of the received check

Formatrck_string
business_id*Business Id

The id of the business

Formatbiz_string

Request Body

application/json
  1. body
voided_at?|

The date the check was voided in ISO-8601 format. Defaults to now.

Response Body

Successful Response

application/json
  1. response
data*
Example Request
curl -X POST 'https://api.sandbox.getasset.com/v0/business/biz_GA6EG2qFxA97NZHtxeLPUy/received-checks/rck_WQMDNUHpBThYSNh4AprDBo/void' \  -H 'Content-Type: application/json' \  -d '{}'
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"  }}