### Example Realtime Return Request Object Source: https://column.com/docs/api An example of a Realtime Return Request object, showing its structure and typical values when the status is 'pending'. ```json { "accepted_at": null, "id": "rtrr_334MvwETg0RW4uS6SifgrpSw7QA", "is_incoming": false, "original_transfer_id": "rttr_334LjBzSfBIie2ddjXf6k6ssEg3", "pending_at": "2025-09-22T20:15:25Z", "reason_code": "CUST", "reason_code_description": "CUST: Cancellation requested by the Debtor", "rejected_at": null, "return_transfer_id": null, "status": "pending" } ``` -------------------------------- ### List All Loan Sales with Filtering using cURL Source: https://column.com/docs/api This example demonstrates how to list all loan sales associated with a specific loan ID using a GET request. It also shows how to authenticate using an API key. The API supports filtering by loan_id and other parameters for pagination and date ranges. ```cURL curl 'https://api.column.com/loans/sales?loan_id=loan_2zF0GD2UnwmzTgkE2M64NLfPD12' \ -u : ``` -------------------------------- ### Example Document Response Source: https://column.com/docs/api This is an example of a successful JSON response when retrieving documents. It includes details such as creation timestamp, description, file extension, ID, size, tag, and type for each document. ```json { "documents": [ { "created_at": "2025-04-03T18:09:57Z", "description": "Identity license for Bob Smith", "ext": "jpeg", "id": "docu_2vEIREWZMACw88iXeToRJ34t8MV", "size": 30535, "tag": "drivers_license", "type": "identity_license" }, { "created_at": "2025-04-03T17:54:01Z", "description": null, "ext": "jpeg", "id": "docu_2vEGVEsT9OTMpraLZyDG0TDMs7s", "size": 30535, "tag": null, "type": "identity_license" } ], "has_more": false }% ``` -------------------------------- ### Counterparty Response Example (JSON) Source: https://column.com/docs/api This is an example of a successful JSON response when retrieving a list of counterparties. It includes detailed information for each counterparty, such as account details, address, and wire transfer information. The response also indicates if there are more results available for pagination. ```json { "counterparties": [ { "account_number": "GB29NWBK60161331926819", "account_type": "checking", "address": { "city": "New Winton", "country_code": "GB", "line_1": "96 Lairg Road", "line_2": "", "postal_code": "EH33 5ZN", "state": "" }, "created_at": "2023-07-07T22:31:30.859307801Z", "description": "international_cpty", "email": "john.doe@gmail.com", "id": "cpty_2SGNjEY3ax4DaX4LgU72navTADL", "is_column_account": false, "legal_id": "GB1245643234", "legal_type": "sole_proprietor", "local_account_number": "876545678", "local_bank_code": "GB123456", "local_bank_country_code": "", "local_bank_name": "", "name": "John Doe", "phone": "650-123-4567", "routing_number": "NWBKGB2L", "routing_number_type": "bic", "updated_at": "2023-07-07T22:31:30.859307801Z", "wire": { "beneficiary_address": { "city": "New Winton", "country_code": "GB", "line_1": "96 Lairg Road", "line_2": "", "postal_code": "EH33 5ZN", "state": "" }, "beneficiary_email": "john.doe@gmail.com", "beneficiary_legal_id": "GB1245643234", "beneficiary_name": "John Doe", "beneficiary_phone": "650-123-4567", "beneficiary_type": "sole_proprietor", "local_account_number": "876545678", "local_bank_code": "GB123456" }, "wire_drawdown_allowed": false } ], "has_more": true } ``` -------------------------------- ### Get Available Loan Sale Summaries using cURL Source: https://column.com/docs/api This cURL command demonstrates how to fetch available loan sale summaries from the Column API. It includes an example of expanding the 'loans' field to retrieve detailed loan sale information. Authentication is handled via an API key. ```bash # Get available loan sale summaries curl 'https://api.column.com/loans/sales/summaries/available?expand=loans' \ -u : ``` -------------------------------- ### Loan Program Object Source: https://column.com/docs/api Details about the Loan Program object, including its parameters and an example. ```APIDOC ## Loan Program object Loan Program objects represent the configuration for loan programs in your platform. They define settings for loan purchases, auto-selling, and account configurations. You cannot create new loan programs on your own. Please work with your Column team / Solution Engineer to create loan programs for your platform based on your Column use cases. Read more. ### object parameters ### auto_sell boolean Indicates if seasoned principals/interests should be automatically sold to your platform. ### close_after_sale boolean Indicates if loans that are not involving should be closed after automatic sale. Read more. ### collection_account_number_id string Default account number ID of your platform to deposit loan payments belonging to your platform in this loan program. ### created_at string The timestamp when the loan program was created. ### default_interest_config_id string ID of the default interest configuration for this loan program. ### description string The description of the loan program. ### id string The ID of the loan program. ### is_business_seasoning_days boolean Indicates if the default seasoning_days are business days or calendar days. ### is_revolving boolean Indicates if loans in this loan program are revolving. ### max_days_to_purchase integer Maximum number of calendar days for seasoned principals/interests to be purchased by your platform. ### purchase_funding_account_number_id string Default account number ID for your platform to fund loan purchases in this loan program. ### retained_by_column boolean Indicates if loans in this loan program are retained by Column. ### seasoning_days integer Defaulf number of seasoning days for loans in this loan program. ### updated_at string The timestamp when the loan program was last updated. ### Loan Program object ```json { "auto_sell": false, "close_after_sale": false, "collection_account_number_id": "acno_32G4weCol8zF0yZLICh4sNCWgOO", "created_at": "2025-09-05T00:56:55Z", "default_interest_config_id": "icfg_32G4wg5lI9ktMi1eim1GstUacfV", "description": "TestService_LoanProgram", "id": "lpgm_32G4wZuA9oCw78988u0jHAMd3D6", "is_business_seasoning_days": false, "is_revolving": true, "max_days_to_purchase": 3, "purchase_funding_account_number_id": "acno_32G4weCol8zF0yZLICh4sNCWgOO", "retained_by_column": true, "seasoning_days": 10, "updated_at": "2025-09-04T17:56:55.005-07:00" } ``` ``` -------------------------------- ### Create Loan with Existing Interest Configuration (Bash) Source: https://column.com/docs/lending This example demonstrates how to create a term loan using the Column API. It requires a loan program ID and an existing interest configuration ID. The request is a POST request to the /loans endpoint with a JSON payload specifying loan details. ```bash curl 'https://api.column.com/loans' \ -X POST \ -u : \ -H 'Content-Type: application/json' \ -d '{ "currency": "USD", "description": "New term loan", "entity_id": "ent_2zElEkmKNaKXjDDCwo9LASIyRzt", "is_revolving": false, "maturity_date": "2028-10-10", "max_principal_balance": "100000", "loan_program_id": "lpgm_2zElEkmKNaKXjDDCwo9LASIyRzt", "interest_config_id": "icfg_2zElEouBhi6bHB5IdAjq1Ot8SeP" }' ``` -------------------------------- ### Get ACH Positive Pay Rule (curl) Source: https://column.com/docs/api Example of how to retrieve a specific ACH Positive Pay rule using its ID via a curl command. ```bash curl 'https://api.column.com/ach-positive-pay-rules/' \ -u : \ ``` -------------------------------- ### Create Realtime Transfer Request Source: https://column.com/docs/api This example demonstrates how to make a POST request to create a realtime transfer. It includes required parameters like `amount` and `currency_code`, and optional parameters such as `description` and `account_number_id`. The `account_number_id` or `bank_account_id` is necessary to specify the sending account. ```http POST /transfers/realtime Content-Type: application/json { "description": "Example realtime transfer", "amount": 10000, "currency_code": "USD", "account_number_id": "acno_2XrFelm5efqwGkPsu3B1DtSEDDg" } ``` -------------------------------- ### Get Settlement Report by ID Response Source: https://column.com/docs/api Example response for retrieving a settlement report by its ID. Includes details such as report status, date range, and associated document IDs. ```json { "id": "srpt_27kkUzwpYqt78g3L1DWU7cBRjyL", "created_at": "2022-04-13T17:38:11Z", "updated_at": "2022-04-13T17:38:11Z", "type": "bank_account_transaction", "status": "completed", "time_zone": "America/Los_Angeles", "from_date": "2022-03-02", "to_date": "2022-03-02", "initiated_at": "2022-04-13T17:10:15Z", "completed_at": "2022-04-13T17:11:15Z", "row_count": 666, "columns": [ "effective_at", "effective_at_utc", "bank_account_id", "bank_account_type", "account_number_id", "entity_id", "entity_name", "entity_type", "transaction_id", "transaction_type", "currency", "available_amount", "available_balance", "pending_amount", "pending_balance", "locked_amount", "locked_balance", "holding_amount", "holding_balance" ], "csv_document_id": "docu_27kh6IxwJjShHV314ig7ioPEwSf", "json_document_id": "docu_27kh6KhcfYDkPthUdoMSCHD3tv9", "parquet_document_id": "docu_27kh6LSgYvc1gdcLlpQnAOGzPl6" } ``` -------------------------------- ### Get Webhook Endpoint by ID using cURL Source: https://column.com/docs/api This example shows how to retrieve details of a specific webhook endpoint using its unique ID. Authentication is handled via your API key. ```bash curl 'https://api.column.com/webhook-endpoints/' \ -u : ``` -------------------------------- ### Setup Webhook Endpoint with cURL Source: https://column.com/docs/workingwithapi/events-and-webhooks This snippet demonstrates how to set up a new webhook endpoint using cURL. It specifies the endpoint URL, a description, and the types of events the endpoint should listen for, including wildcard support for event categories. ```shell curl https://api.column.com/api/webhook_endpoints \ -X POST \ -u : \ -d url="https://example.com/webhook" \ -d description="endpoint for ACH events" \ -d "enabled_events[]"="ach.*" \ -d "enabled_events[]"="book.outgoing_transfer.completed" ``` -------------------------------- ### List Webhook Deliveries by Endpoint using cURL Source: https://column.com/docs/api This example demonstrates how to list all webhook deliveries and retry attempts for a specific endpoint. It uses the GET method and requires the endpoint ID and API key. ```bash curl 'https://api.column.com/webhook-deliveries/endpoint/' \ -u : ``` -------------------------------- ### Create Bank Account Response (200 OK) Source: https://column.com/docs/api Example of a successful response (200 OK) when creating a new bank account. It returns the newly created bank account object with its details. ```json { "balances": { "available_amount": 0, "holding_amount": 0, "locked_amount": 0, "pending_amount": 0 }, "bic": "CLNOUS66", "created_at": "2021-10-14T17:50:21Z", "currency_code": "USD", "default_account_number": "123456789012345", "default_account_number_id": "acno_2YHAWG9FTCxtL5emK1oVKCOx7fk", "description": "Travel Checking", "id": "bacc_2YHAXVyuS2xcJW12Buh9zsxV7vC", "is_overdraftable": false, "overdraft_reserve_account_id": "", "owners": [ "enti_2YHAYW65t2fEna7uxll10OHzoty" ], "routing_number": "121145307", "type": "CHECKING", "status": "open" } ``` -------------------------------- ### Get International Wire Transfer by ID (cURL) Source: https://column.com/docs/api This cURL command demonstrates how to retrieve a specific international wire transfer using its unique ID. It includes an example of how to specify query parameters, such as `expand` to include additional details like the raw message. ```curl curl 'https://api.column.com/transfers/international-wire/swft_2F3BYA9aMdHag8iUtsDE8ji0KOK?expand=raw_message' \ -u : ``` -------------------------------- ### Get Bank Account History - cURL Example Source: https://column.com/docs/api This snippet demonstrates how to retrieve the historical summary of a bank account using cURL. It requires the bank account ID and a date range (from_date, to_date). The response includes a list of daily summaries for the specified period. ```bash curl 'https://api.column.com/bank-accounts//history?from_date=2022-03-01&to_date=2022-03-02' \ -u : ``` -------------------------------- ### Create a Realtime RFP Source: https://column.com/docs/api Example cURL request to initiate a new Realtime RFP. This request requires authentication and specifies the amount, currency, and source/destination account identifiers. ```bash curl 'https://api.column.com/transfers/realtime/request-for-payment' \ -XPOST \ -u : \ -d description="Example RFP" \ -d amount=10000 \ -d currency_code="USD" \ -d bank_account_id="" \ -d counterparty_id="" ``` -------------------------------- ### Create Line of Credit with New Interest Configuration (Bash) Source: https://column.com/docs/lending This example shows how to create a line of credit (revolving loan) using the Column API. It allows for defining a new interest configuration directly within the request payload. The request is a POST to the /loans endpoint. ```bash curl 'https://api.column.com/loans' \ -X POST \ -u : \ -H 'Content-Type: application/json' \ -d '{ "currency": "USD", "description": "Charge card for John Doe", "entity_id": "ent_2zElEkmKNaKXjDDCwo9LASIyRzt", "is_revolving": true, "loan_program_id": "lpgm_2zElEkmKNaKXjDDCwo9LASIyRzt", "interest_config": { "accrual_method": "actual_365", "description": "Standard charge card rate", "history": [ { "effective_after_days": 0, "fixed_rate": 0.0499 }, { "effective_after_days": 30, "pivot_relative": 0.0399 } ] } }' ``` -------------------------------- ### Create Bank Account using cURL Source: https://column.com/docs/api Demonstrates how to create a new bank account using a cURL request. This involves specifying the account description and the entity ID as required parameters. ```bash curl 'https://api.column.com/bank-accounts' \ -XPOST \ -u : \ -d description="Travel Checking" \ -d entity_id="" ``` -------------------------------- ### Create File Evidence (POST) Source: https://column.com/docs/api Creates evidence for an entity by linking an existing document. Documents must be uploaded separately via the Documents API first. Accepted file types include PDF, JPG, PNG, TIFF, with a maximum file size of 5GB. ```bash curl -X POST https://api.column.com/entities/{entity_id}/evidence ``` -------------------------------- ### Create Counterparty API Request Source: https://column.com/docs/api This example demonstrates how to make a POST request to the /counterparties endpoint to create a new counterparty. It includes required fields like `routing_number` and `account_number`, along with optional parameters such as `description` and `wire_drawdown_allowed`. The `routing_number_type` defaults to 'aba' if not specified. ```http POST /counterparties { "routing_number": "123456789", "routing_number_type": "aba", "account_number": "123456789012", "account_type": "checking", "description": "My First Counterparty", "wire_drawdown_allowed": true } ``` -------------------------------- ### GET /webhook-endpoints Source: https://column.com/docs/api Retrieve a list of all configured webhook endpoints. ```APIDOC ## GET /webhook-endpoints ### Description List all webhook endpoints associated with the account. ### Method GET ### Endpoint /webhook-endpoints ### Parameters #### Query Parameters - **starting_after** (string) - Optional - A cursor for use in pagination. - **ending_before** (string) - Optional - A cursor for use in pagination. ### Request Example curl 'https://api.column.com/webhook-endpoints' -u : ### Response #### Success Response (200) - **webhook_endpoints** (array) - List of webhook endpoint objects. #### Response Example { "webhook_endpoints": [ { "id": "string", "created_at": "2021-11-29T21:35:26.409Z", "updated_at": "2021-11-29T21:35:26.409Z", "description": "string", "enabled_events": ["string"], "secret": "string", "is_disabled": true, "url": "string" } ] } ``` -------------------------------- ### Create Loan Payment Request Example (JSON) Source: https://column.com/docs/api This JSON structure demonstrates the required and optional parameters for creating a new loan payment via the API. It includes fields for amount, currency, and source account details. ```json { "amount": "175", "principal_amount": "175", "is_offline": false, "ignore_retained_balances": false, "bank_account_id": "bacc_2zF1i4b7tzsFNa2RwiDYemf5guz", "account_number_id": "acno_2zF1i1U3OJ2P72HVzcv2kAzPHFy", "currency": "USD" } ``` -------------------------------- ### GET /webhook-endpoints Source: https://column.com/docs/api Lists all webhook endpoints configured for the developer account. ```APIDOC ## GET /webhook-endpoints ### Description List all webhooks under your developer account. ### Method GET ### Endpoint /webhook-endpoints ### Parameters #### Query Parameters - **limit** (int32) - Optional - Number of objects to return (1-100, default 10). ### Response #### Success Response (200) - **webhook_endpoints** (array) - List of configured webhook objects. ``` -------------------------------- ### GET /transfers/realtime Source: https://column.com/docs/api Retrieves a list of all realtime transfers associated with your platform. ```APIDOC ## GET /transfers/realtime ### Description Retrieves a paginated list of realtime transfers. Supports filtering by creation date, bank account, and direction. ### Method GET ### Endpoint /transfers/realtime ### Parameters #### Query Parameters - **limit** (int32) - Optional - Number of objects to return (1-100). - **starting_after** (string) - Optional - Cursor for pagination. - **ending_before** (string) - Optional - Cursor for pagination. - **created.gte** (date-time) - Optional - Filter by start date. - **bank_account_id** (string) - Optional - Filter by bank account. ### Request Example curl 'https://api.column.com/transfers/realtime?limit=10' -u : ### Response #### Success Response (200) - **data** (array) - List of transfer objects. ``` -------------------------------- ### Purchase Loan Receivables via API Source: https://column.com/docs/lending/sale Demonstrates how to perform a partial loan purchase using a percentage or a specific amount. The request requires an idempotency key and specifies the currency and funding account. ```shell curl 'https://api.column.com/loans/loan_2zEi4Q067eiQqyQkGXPqEzWXn5Q/sales' \ -XPOST \ -u : \ -H "Idempotency-Key: 8e913d8c-1071-41ab-b352-936d6fdc5197" \ -d percentage="0.4" \ -d currency_code="USD" ``` ```shell curl 'https://api.column.com/loans/loan_2zEi4Q067eiQqyQkGXPqEzWXn5Q/sales' \ -XPOST \ -u : \ -H "Idempotency-Key: 2c48ca9b-ba46-40af-a679-f0e326b6302a" \ -d amount="60540" \ -d currency_code="USD" \ -d purchase_funding_account_number_id="acno_32CYxVSbDOAnVn2qJ1Qnc4OkuqK" ``` -------------------------------- ### GET /loans/sales/{loan_sale_id} Source: https://column.com/docs/api Retrieve details of a specific loan sale. ```APIDOC ## GET /loans/sales/{loan_sale_id} ### Description Retrieve a single loan sale by its unique ID. ### Method GET ### Endpoint /loans/sales/{loan_sale_id} ### Parameters #### Path Parameters - **loan_sale_id** (string) - Required - The ID of the loan sale. ### Response #### Success Response (200) - **id** (string) - The loan sale ID. - **loan_id** (string) - The associated loan ID. #### Response Example { "id": "lsal_2zEjnD6zlXgnc7t8NGQvn66Y1wA", "loan_id": "loan_2zEjnA29UEHapWFEqgtDsM3jw2y" } ``` -------------------------------- ### Create a Person Entity Source: https://column.com/docs/api Demonstrates how to create a new person entity by sending a POST request to the /entities/person endpoint with personal details and address information. ```bash curl 'https://api.column.com/entities/person' \ -XPOST \ -u : \ -H 'Content-Type: application/json' \ -d '{ "first_name": "Oliver", "last_name": "Hockey", "middle_name": "Smith", "ssn": "565438976", "date_of_birth": "1985-08-04", "email": "oliver@column.com", "phone_number": "+15555555555", "pep_status": "not_checked", "address": { "line_1": "101 Market St", "line_2": "Suite 1913", "city": "San Francisco", "state": "CA", "postal_code": "94105", "country_code": "USA" } }' ``` -------------------------------- ### Create an Entity Source: https://column.com/docs/guides/getting-started Registers a new individual entity in the Column system. This is the first step required to own a bank account. ```shell curl https://api.column.com/entities/person \ -XPOST \ -u : \ -d first_name=Andrew \ -d last_name=Jackson \ -d ssn="123456789" \ -d date_of_birth="1987-03-15" \ -d email="andrew@column.com" \ -d "address[line_1]"="123 Federal Reserve Way" \ -d "address[city]"="San Francisco" \ -d "address[state]"="CA" \ -d "address[postal_code]"="94123" \ -d "address[country_code]"="USA" ``` -------------------------------- ### GET /webhook-deliveries/endpoint/ Source: https://column.com/docs/api List delivery attempts for a specific webhook endpoint. ```APIDOC ## GET /webhook-deliveries/endpoint/ ### Description List all the webhook delivery and retry attempts for this endpoint. ### Method GET ### Endpoint /webhook-deliveries/endpoint/ ### Parameters #### Path Parameters - **id** (string) - Required - Webhook ID. #### Query Parameters - **limit** (int32) - Optional - Number of objects to return (default 20). ### Request Example curl 'https://api.column.com/webhook-deliveries/endpoint/' -u : ``` -------------------------------- ### Get a Tax Form Source: https://column.com/docs/api Retrieve a specific tax form by its unique ID. ```APIDOC ## Get a tax form ### Description Retrieve a specific tax form by ID. ### Method GET ### Endpoint /tax-forms/ ### Parameters #### Path Parameters - **tax_form_id** (string) - Required - The ID of the tax form to retrieve. ### Request Example ```bash curl 'https://api.column.com/tax-forms/' \ -u : ``` ### Response #### Success Response (200) - **id** (string) - Unique identifier for the tax form. - **entity_id** (string) - Identifier for the associated entity. - **type** (string) - The type of tax form (e.g., '1099_int'). - **tax_year** (integer) - The tax year the form pertains to. - **currency_code** (string) - The currency code (e.g., 'USD'). - **gross_amount** (number) - The gross amount reported on the form. - **description** (string) - A description of the income or transaction. - **document_id** (string) - Identifier for the associated document. - **created_at** (string) - ISO 8601 timestamp when the tax form was created. - **updated_at** (string) - ISO 8601 timestamp when the tax form was last updated. - **fed_status** (string) - Status of federal filing. Possible values: `not_required`, `scheduled`, `sent`, `accepted`, `rejected`, `accepted_with_error`, `canceled`. - **fed_sent_at** (string) - ISO 8601 timestamp when the form was sent to the IRS. - **fed_accepted_at** (string) - ISO 8601 timestamp when the IRS accepted the form. - **fed_rejected_at** (string) - ISO 8601 timestamp when the IRS rejected the form. - **state** (string) - State code (e.g., `CA`) if state filing is required. - **state_status** (string) - Status of state filing. Possible values: `not_required`, `scheduled`, `sent`, `accepted`, `rejected`, `canceled`. - **state_sent_at** (string) - ISO 8601 timestamp when the form was sent to the state. - **state_accepted_at** (string) - ISO 8601 timestamp when the state accepted the form. - **state_rejected_at** (string) - ISO 8601 timestamp when the state rejected the form. - **mail_status** (string) - Status of physical mailing to the taxpayer. Possible values: `not_required`, `scheduled`, `sent`, `received`, `canceled`. - **mail_sent_at** (string) - ISO 8601 timestamp when the form was sent via mail. - **mail_received_at** (string) - ISO 8601 timestamp when the mail was received. - **mail_address** (object) - Mailing address for the tax form. Contains `line_1`, `line_2`, `city`, `state`, `postal_code`, `country_code`. - **comment** (string) - Optional comment about the tax form (e.g., cancellation reason). #### Response Example (200) ```json { "id": "taxf_351UODoYfkhdPO3b1oxQ9WOlD5a", "entity_id": "enti_351UO7kO4axJQy7JRA4Rk0OLjpP", "type": "1099_int", "tax_year": 2024, "currency_code": "USD", "gross_amount": 12345, "description": "Annual Interest Income", "document_id": "docu_34qVk0EkeOPtMx4RiiuPbY9pHMq", "created_at": "2025-11-04T17:23:56Z", "updated_at": "2025-11-04T17:23:56Z", "fed_status": "accepted", "fed_sent_at": "2025-11-05T17:23:56Z", "fed_accepted_at": "2025-11-05T19:23:56Z", "fed_rejected_at": null, "state": "CA", "state_status": "accepted", "state_sent_at": "2025-11-05T17:24:56Z", "state_accepted_at": "2025-11-05T19:24:56Z", "state_rejected_at": null, "mail_status": "not_required", "mail_sent_at": null, "mail_received_at": null, "mail_address": null, "comment": null } ``` #### Error Response (400) (Details for error responses would typically be provided here, e.g., invalid ID format, authentication errors.) ``` -------------------------------- ### List Book Transfers with Pagination (Shell) Source: https://column.com/docs/workingwithapi/pagination Demonstrates how to list book transfers using cursor-based pagination. It shows sequential API calls, adjusting the `starting_after` parameter based on the previous response's last object ID to fetch subsequent pages. The `limit` parameter controls the number of records per page, and the `has_more` field indicates if further pages exist. ```shell curl https://api.column.com/transfers/book?limit=2 { "transfers": [ { "id": "book_1zMiU9lhaxANNH5HxbBp519ZCVL", "created_at": "2021-10-11T14:59:57Z", // ... }, { "id": "book_1zMiUDiWjf2OnSR99FjNLJmr1aD", "created_at": "2021-10-11T13:12:23Z", // ... } ], "has_more": true, } curl https://api.column.com/transfers/book?limit=2&starting_after=book_1zMiUDiWjf2OnSR99FjNLJmr1aD { "transfers": [ { "id": "book_1zMiU8YTDUcVaGZseV1AdzKYtJD", "created_at": "2021-10-11T12:30:30Z", // ... }, { "id": "book_1zMiUBwMwk8l9FSJOu6v8eoLFPe", "created_at": "2021-10-11T11:00:02Z", // ... } ], "has_more": true, } curl https://api.column.com/transfers/book?limit=2&starting_after=book_1zMiUBwMwk8l9FSJOu6v8eoLFPe { "transfers": [ { "id": "book_1zMiU44UKEylj6KayD89eqfklTg", "created_at": "2021-10-11T10:29:33Z", // ... } ], "has_more": false, } ``` -------------------------------- ### Create Business Entity - cURL Example Source: https://column.com/docs/api This cURL command illustrates how to create a new business entity. It requires a POST request to the /entities/business endpoint with essential business details like name, EIN, and registration information. Optional fields like website and industry can also be included. ```bash curl -X POST 'https://api.column.com/entities/business' \ -u : \ -H 'Content-Type: application/json' \ -d '{ \ "business_name": "Example Corp", \ "ein": "123456789", \ "address": { \ "line_1": "123 Business Rd", \ "city": "Metropolis", \ "state": "NY", \ "postal_code": "10001", \ "country_code": "US" \ }, \ "website": "https://example.com", \ "industry": "Technology", \ "legal_type": "corporation" \ }' ``` -------------------------------- ### Get an event by ID Source: https://column.com/docs/api Retrieves a specific event using its unique identifier. ```APIDOC ## Get an event by ID ### Description Retrieve an `event` by its `id` ### Method GET ### Endpoint /events/ ### Path Parameters - **id** (string) - Required - The unique identifier of the event. ### Request Example ```bash curl 'https://api.column.com/events/' \ -u : ``` ### Response #### Success Response (200) - **id** (string) - Unique identifier for the event. - **created_at** (string) - Timestamp of when the event was created. - **type** (string) - The type of the event. - **data** (object) - Contains details specific to the event type. - **type_url** (string) - URL related to the data type. - **value** (string) - The value associated with the data. #### Response Example ```json { "id": "string", "created_at": "2021-11-29T21:29:34.023Z", "type": "string", "data": { "type_url": "string", "value": "string" } } ``` ``` -------------------------------- ### Create a Counterparty Source: https://column.com/docs/guides/getting-started Registers an external bank account as a counterparty, enabling the ability to send or pull funds from that account. ```shell curl https://api.column.com/counterparties \ -u : \ -d account_number=87654321 \ -d routing_number=121044055 ``` -------------------------------- ### GET /transfers Source: https://column.com/docs/api Retrieves a list of transfers with optional filtering by direction and status. ```APIDOC ## GET /transfers ### Description Retrieves a list of bank transfers. Results can be filtered by direction (incoming/outgoing) and status. ### Method GET ### Endpoint /transfers ### Parameters #### Query Parameters - **is_incoming** (boolean) - Optional - Return transfers that is either incoming or outgoing. - **status** (string) - Optional - Return results with this status (comma separated). ### Request Example curl 'https://api.column.com/transfers' -u : ### Response #### Success Response (200) - **transfers** (array) - List of transfer objects - **has_more** (boolean) - Pagination indicator - **total_results_count** (int) - Total count of results #### Response Example { "transfers": [{"id": "string", "status": "completed", "amount": 1000}], "has_more": true, "total_results_count": 1 } ``` -------------------------------- ### GET /transfers/realtime/return-requests Source: https://column.com/docs/api Lists all Realtime return requests associated with the developer account. ```APIDOC ## GET /transfers/realtime/return-requests ### Description Retrieve all Realtime returns under your developer account. ### Method GET ### Endpoint /transfers/realtime/return-requests ### Parameters #### Query Parameters - **limit** (int32) - Optional - A limit of the number of objects to be returned, between 1 and 100. The default is 10. ### Request Example curl 'https://api.column.com/transfers/realtime/return-requests' -u : ### Response #### Success Response (200) - **realtime_return_requests** (array) - List of return request objects #### Response Example { "has_more": false, "realtime_return_requests": [] } ``` -------------------------------- ### Get Realtime Transfer Source: https://column.com/docs/api Retrieves a single realtime transfer by its unique ID. ```APIDOC ## GET /transfers/realtime/ ### Description Retrieve a single realtime transfer by its ID. ### Method GET ### Endpoint /transfers/realtime/ ### Parameters #### Path Parameters - **realtime_transfer_id** (string) - Required - ID of the realtime transfer you're looking up. ### Request Example ```bash curl 'https://api.column.com/transfers/realtime/' \ -u : ``` ### Response #### Success Response (200) - **accepted_at** (string) - Timestamp when the transfer was accepted. - **account_number_id** (string) - ID of the associated account number. - **allow_overdraft** (boolean) - Indicates if overdraft is allowed. - **amount** (integer) - The amount of the transfer. - **bank_account_id** (string) - ID of the associated bank account. - **blocked_at** (string) - Timestamp when the transfer was blocked, if applicable. - **completed_at** (string) - Timestamp when the transfer was completed. - **counterparty_id** (string) - ID of the counterparty. - **currency_code** (string) - The currency code (e.g., USD). - **description** (string) - Description of the transfer. - **id** (string) - The unique ID of the realtime transfer. - **idempotency_key** (string) - The idempotency key used for the request, if any. - **initiated_at** (string) - Timestamp when the transfer was initiated. - **is_incoming** (boolean) - True if the transfer is incoming, false otherwise. - **is_on_us** (boolean) - True if the transfer is an on-us transfer. - **manual_review_approved_at** (string) - Timestamp when manual review was approved, if applicable. - **manual_review_at** (string) - Timestamp when manual review was initiated, if applicable. - **manual_review_rejected_at** (string) - Timestamp when manual review was rejected, if applicable. - **pending_at** (string) - Timestamp when the transfer was set to pending, if applicable. - **rejected_at** (string) - Timestamp when the transfer was rejected, if applicable. - **rejection_code** (string) - Code for rejection, if applicable. - **rejection_code_description** (string) - Description for rejection code, if applicable. - **rejection_additional_info** (string) - Additional information for rejection, if applicable. - **status** (string) - Current status of the transfer (e.g., completed). - **return_pair_transfer_id** (string) - ID of the paired return transfer, if applicable. - **end_to_end_id** (string) - The end-to-end ID of the transfer. #### Response Example ```json { "accepted_at": "2023-12-29T19:45:11Z", "account_number_id": "acno_2XrFelm5efqwGkPsu3B1DtSEDDg", "allow_overdraft": false, "amount": 10000, "bank_account_id": "bacc_2XrFelZxSUOXXTswfr0h9KByzNp", "blocked_at": null, "completed_at": "2023-12-29T19:45:13Z", "counterparty_id": "cpty_2aELmewqaBj5Bp6oraJ7Pl6LH1p", "currency_code": "USD", "description": "Example realtime transfer", "id": "rttr_2aEM6RbzozxcvVY11ArHJw1Ka4E", "idempotency_key": null, "initiated_at": "2023-12-29T19:45:10Z", "is_incoming": false, "is_on_us": false, "manual_review_approved_at": null, "manual_review_at": null, "manual_review_rejected_at": null, "pending_at": null, "rejected_at": null, "rejection_code": null, "rejection_code_description": null, "rejection_additional_info": null, "status": "completed", "return_pair_transfer_id": "rttr_2ipl7TLOLY0Kyv5flfi2NHAIqJm", "end_to_end_id": "bill-19421a4b7e2d" } ``` ```