RocketKOR

Retrieve a Financial Account Statement

Retrieve a monthly statement for an Integrated Bank Financial Account.

Endpoint

GET /v1/financial-accounts/{faId}/statements/{yearMonth}

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

faId  REQUIRED

string (UUID)

ID of the Financial Account.

yearMonth  REQUIRED

string, format: yyyy-MM

Year and month of the statement.

Request Body

None

Returns

Returns the Financial Account Statement object. This object contains the statement details.

SAMPLE RESPONSE

				
					{
  "statementCreatedAt": "2023-04-15T22:58:29.782Z",
  "accountNumber": "*******0510",
  "accountType": "CHECKING",
  "statementStartDate": "2023-03-01T00:00:00.000Z",
  "statementEndDate": "2023-03-31T23:59:59.999Z",
  "openingBalance": 4210.00,
  "closingBalance": 5600.00,
  "accountHolderDetails": {
    "name": "Joe Smith",
    "addressLine1": "705 King St",
    "addressLine2": "Suite 300",
    "postalCode": "10001",
    "state": "NY",
    "country": "US"
  },
  "totalDebits": 1660.00,
  "totalCredits": 260.00,
  "accountActivities": [
    {
      "createdAt": "2023-03-04T22:58:29.782Z",
      "description": "deposit",
      "amount": +100.00,
      "balance": 4310.00
    },
    {...},
    {...}
  ],
  "signedJsonUrl": "https://abc.s3.amazonaws.com/reports/AccountStatements/business_account_id%ad531842-8ec3-4e5a-b41c-830257683174/financial_account_id%d21f28c9-dc29-4fae-b673-df9cca1b07d7/year%3D2023/month%3D5/AccountStatement_202305.json?X-Amz-Security-Token=IQoJ..."
}