Skip to main content
POST
/
v2
/
bank-statements
/
{statement_id}
/
unapprove
Unapprove a Bank Statement
curl --request POST \
  --url https://api.example.com/v2/bank-statements/{statement_id}/unapprove \
  --header 'Authorization: Bearer <token>'
{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "status": "submitted",
  "period_start": "2023-12-25",
  "period_end": "2023-12-25",
  "account_id": "<string>",
  "account_number": "<string>",
  "attachment": {
    "id": "<string>",
    "name": "<string>",
    "src": "<string>",
    "mime_type": "application/json",
    "file_type": "<string>"
  },
  "processing_error": {
    "error_code": "duplicate",
    "error_message": "<string>"
  },
  "split_info": {
    "is_split_parent": true,
    "split_count": 123,
    "child_statements": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "original_statement_id": "<string>",
    "split_index": 123
  },
  "transactions": [
    {
      "id": "<string>",
      "account_id": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "amount": 123,
      "currency": "<string>",
      "type": "deposit",
      "description": "<string>",
      "reference_number": "<string>",
      "payment_status": "non_payment"
    }
  ],
  "object": "<string>"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

statement_id
string
required

Response

Successful Response

Full response schema for a bank statement (includes transactions).

created_at
string<date-time>
required
modified_at
string<date-time> | null
required
id
string
required
status
enum<string>
required

The status of this upload.

Available options:
submitted,
processing,
invalid,
pending_approval,
approved,
split
period_start
string<date> | null
required

The statement period's start date.

period_end
string<date> | null
required

The statement period's end date.

account_id
string | null
required
account_number
string | null
required

The account number that the statement relates to.

attachment
object
required

Attachment information for a bank statement.

processing_error
ProcessingError · object
required

Processing error details.

split_info
object
required

Information about statement splitting.

transactions
BankStatementTransaction · object[]
required

Transactions extracted from the statement

object
string
required

String representing the object's type. Objects of the same type share the same value.