Auth API
- How to authenticate
Deliver API
- Persons
- Businesses
- External Accounts
- POSTCreate External Account
- GETGet All External Accounts
- GETGet an external account by id
- PUTUpdate External Account By ID
- PUTUpdate External Account By Customer Reference ID
- PATCHPartial Update External Account By ID
- DELClose External Account By ID
- GETGet All External Accounts For Specific Person
- GETGet All External Accounts For Specific Business
- POST
- Cards
- Transfers
- Eligibility
- Transfer Groups
- Balance
- Reports
Verify API
Webhooks API
- Overview And Set Up
- Event Types and Payloads
- Configure webhooks
- Trigger webhooks
- Secure webhooks
Get an external account by id
Get an external account object.
curl --request GET \
--url https://api-sandbox.orum.io/deliver/external/accounts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Orum-Version: <orum-version>'
{
"external_account": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_reference_id": "<string>",
"customer_reference_id": "<string>",
"customer_resource_type": "business",
"account_type": "checking",
"account_number": "<string>",
"routing_number": "<string>",
"account_holder_name": "<string>",
"status": "created",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"closed_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
}
Authorizations
The auth token received from Authentication endpoints.
Headers
Version of Deliver API. Use v2022-09-21.
v2022-09-21
Path Parameters
Orum generated unique id for the resource for the external account you are fetching.
Response
A single object of External Account.
Orum generated unique id for the resource.
Unique reference id for the external account. Generated by you.
1 - 255
Unique customer_reference_id that you passed when creating the associated customer (business or person) resource.
255
Type of customer resource - business, person, or enterprise.
business
, person
, enterprise
Type of bank account - checking or savings.
checking
, savings
Account number for US bank account. 17 digits maximum.
9-digit American Bankers Association (ABA) routing number.
Name of account holder.
Status of the external account.
created
, verified
, rejected
, restricted
, closed
Timestamp when the resource was created.
Timestamp when the resource was last updated.
Timestamp when the status of the resource was set to "closed".
Additional data you would like to provide on the resource. The field supports valid JSON of up to 5 key-value pairs with a maximum of 20 characters for the key and 50 characters for the value. Do not include any sensitive information.
Was this page helpful?
curl --request GET \
--url https://api-sandbox.orum.io/deliver/external/accounts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Orum-Version: <orum-version>'
{
"external_account": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_reference_id": "<string>",
"customer_reference_id": "<string>",
"customer_resource_type": "business",
"account_type": "checking",
"account_number": "<string>",
"routing_number": "<string>",
"account_holder_name": "<string>",
"status": "created",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"closed_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
}