External Accounts
Create External Account
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
- Schedules
- Eligibility
- Transfer Groups
- Balance
- Reports
Verify API
Webhooks API
- Overview And Set Up
- Event Types and Payloads
- Configure webhooks
- Trigger webhooks
- Secure webhooks
External Accounts
Create External Account
Create an external account object.
POST
/
deliver
/
external
/
accounts
curl --request POST \
--url https://api-sandbox.orum.io/deliver/external/accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Orum-Version: <orum-version>' \
--data '{
"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>",
"metadata": {}
}'
{
"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 access token received from the authorization server in the OAuth 2.0 flow.
Headers
Version of Deliver API. Use v2022-09-21.
Available options:
v2022-09-21
Body
application/json
Response
200
application/json
200 response.
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api-sandbox.orum.io/deliver/external/accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Orum-Version: <orum-version>' \
--data '{
"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>",
"metadata": {}
}'
{
"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": {}
}
}