Skip to main content
PUT
/
deliver
/
external
/
accounts
Update an external account by reference id
curl --request PUT \
  --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

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
Orum-Version
enum<string>
required

Version of Deliver and Verify APIs. Use v2022-09-21.

Available options:
v2022-09-21

Body

application/json
​
account_reference_id
string
required

Unique reference id for the external account. Generated by you.

Required string length: 1 - 255
​
customer_reference_id
string
required

Unique customer_reference_id that you passed when creating the associated customer (business or person) resource.

Maximum string length: 255
​
customer_resource_type
enum<string>
required

Type of customer resource - business, person, or enterprise.

Available options:
business,
person,
enterprise
​
account_type
enum<string>
required

Type of bank account - checking or savings.

Available options:
checking,
savings
​
account_number
string
required

Account number for US bank account. 4 to 17 digits are acceptable.

​
routing_number
string
required

9-digit American Bankers Association (ABA) routing number.

​
account_holder_name
string
required

Name of account holder. Accepts alphanumeric characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.

Required string length: 1 - 255
​
metadata
object

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. 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.

Response

200 response.

​
external_account
ExternalAccountResponseBase · object
required

A single object of External Account.