Retrieve an External Account

Changed on
get/external_accounts/{external_account_id}

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/external_accounts/{external_account_id}
  • Auth
    HTTP bearer

Path parameters

external_account_idstring required

The identifier of the External Account.

Response

External Account

account_holder'business' | 'individual' | 'unknown' required

The type of entity that owns the External Account.

account_numberstring required

The destination account number.

created_atstring date-time required

The ISO 8601 date and time at which the External Account was created.

descriptionstring required

The External Account's description for display purposes.

funding'checking' | 'savings' | 'general_ledger' | 'other' required

The type of the account to which the transfer will be sent.

idstring required

The External Account's identifier.

idempotency_keystring nullable required

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

routing_numberstring required

The American Bankers' Association (ABA) Routing Transit Number (RTN).

status'active' | 'archived' required

The External Account's status.

type'external_account' required

A constant representing the object's type. For this resource it will always be external_account.

Example response

{
  "account_holder": "business",
  "account_number": "987654321",
  "created_at": "2020-01-31T23:59:59Z",
  "description": "Landlord",
  "funding": "checking",
  "id": "external_account_ukk55lr923a3ac0pp7iv",
  "idempotency_key": null,
  "routing_number": "101050001",
  "status": "active",
  "type": "external_account"
}

Changes

  • 64a92a8cc343Revision changes
    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status