How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Orum Transfer Groups API

The Transfer Groups API from Orum — 2 operation(s) for transfer groups.

Orum Transfer Groups API is one of 17 APIs that Orum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Transfer Groups. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 2 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version v2022-09-21.

Requests are made against 2 base URLs: https://api-sandbox.orum.io, https://vault.api-sandbox.orum.io.

3 operations 2 paths 12 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2022-09-21
Base URL
https://api.orum.io
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

Orum Transfer Groups API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 29 scopes.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Transfer Groups 3
POST
/deliver/transfer-groups
Create a Transfer Group
post-transfer-group 1 param body → 200400default
GET
/deliver/transfer-groups
Get all Transfer Groups
get-transfer-groups 4 params → 200400default
GET
/deliver/transfer-groups/{id}
Get a Transfer Group
get-transfer-group 2 params → 200400404default

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are TransferGroup (6 properties), TransferGroupRequest (3 properties), ErrorResponse (3 properties), TransferGroupSourceObject (2 properties). Each schema is shown below with its type and property counts.

OrumId
string
Orum generated unique id for the resource.
TransferGroupsResponse
object
1 property 1 required
OrumVersion
string
Version of Deliver and Verify APIs. Use v2022-09-21.
TransferGroupSourceObject
object
Information about the ultimate source of the transfer group.
2 properties 2 required
TransferGroupResponse
object
1 property 1 required
TransferGroup
object
6 properties 4 required
CreatedAt
string
Timestamp when the resource was created.
TransferGroupRequest
object
3 properties 1 required
TransferGroupReferenceID
string
Unique reference id for the transfer group
ErrorResponse
object
3 properties 2 required
TransferGroupDestinationObject
object
Information about the ultimate destination of the transfer group.
2 properties 2 required
UpdatedAt
string
Timestamp when the resource was last updated.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

orum-transfer-groups-api-openapi.yml Raw ↑

Other APIs Orum publishes across the network.

Orum Authentication API
Orum Balance API
Orum Book Transfers API
Orum Businesses API
Orum Cards API
Orum Configure webhooks API
Orum Eligibility API
Orum External Accounts API
Orum Persons API
Orum Reports API
Orum Schedules API
Orum Secure webhooks API
Where this information came from

This is an independent, third-party profile of Orum Transfer Groups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.