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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Orum

Orum Transfers API

The Transfers API from Orum — 4 operation(s) for transfers.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 6 operations across 4 paths, and defines 29 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.

6 operations 4 paths 29 schemas 3 GET1 PATCH2 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
Apache 2.0
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 6

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

Transfers 6
POST
/deliver/transfers
Create a transfer
post-transfer 1 param body → 200400default
GET
/deliver/transfers
Get all transfers
get-transfers 8 params → 200400default
GET
/deliver/transfers/{id}
Get a transfer by id
get-transfer 2 params → 200404default
PATCH
/deliver/transfers/{id}
Update transfer metadata by id
patch-transfer-metadata 2 params body → 200400404default
POST
/deliver/transfers/{id}/cancel
Cancel a transfer by id
post-transfer-cancel 2 params → 202400404default
GET
/deliver/transfers/{id}/history
Get transfer history by id
get-transfer-history 2 params → 200404default

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are TransferResponseBaseObject (17 properties), TransferRequest (10 properties), SourceTransferPartyResponse (5 properties), ReasonCodes (5 properties). Each schema is shown below with its type and property counts.

ReturnTraceNumber
string
Unique tracking number assigned to a return to associate it back with its original trace number for reconciliation.
TransfersResponse
object
1 property 1 required
CreatedAt
string
Timestamp when the resource was created.
UpdatedAt
string
Timestamp when the resource was last updated.
DestinationTransferPartyResponse
object
Information about the transfer funds destination, which will be credited.
5 properties 2 required
TraceNumber
string
Unique tracking number of the payment assigned by its origination FI. This number can be used to track the lifecycle of the payment at the FI.
Currency
string
Currency code in ISO 4217 format. Only USD is supported.
TransferHistoryResponse
object
1 property 1 required
TransferSpeed
string
Speed of transfer.
DestinationTransferParty
object
Information about the transfer funds destination, which will be credited.
3 properties 2 required
TransferAmount
integer
Transfer amount in integral cents (example: 100 = $1). Must be greater than zero.
TransferHistoryEntry
object
2 properties 2 required
SourceTransferParty
object
For use cases that require a Source, information about the transfer funding source, which will be debited.
3 properties 2 required
TransferResponseBaseObject
object
17 properties 8 required
TransferPatchMetadataRequest
object
1 property 1 required
SourceTransferPartyResponse
object
For use cases that require a Source, information about the transfer funding source, which will be debited.
5 properties 2 required
TransferStatus
string
Describes the current status of the transfer.
OrumVersion
string
Version of Deliver and Verify APIs. Use v2022-09-21.
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…
TransferResponse
object
1 property 1 required
TransferStatusReason
object
For failed transfers - details on why the transfer is in a failed state.
2 properties
PartyStatementDisplayName
string
The name that will appear on the bank account statement of the account being debited. The field supports 16 alphanumeric characters for ACH, and 140 for RTP.
SubledgerReferenceId
string
Unique reference id for the subledger resource. Generated by you.
OrumId
string
Orum generated unique id for the resource.
TransferRequest
object
10 properties 4 required
TransferCancelResponse
object
1 property 1 required
ReasonCodes
object
5 properties 2 required
TransferReferenceId
string
Unique reference id for the transfer. Generated by you.
ErrorResponse
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

orum-transfers-api-openapi.yml Raw ↑

Other APIs Orum publishes across the network.

Orum Authentication API
AE Profile APIs.io
Orum Balance API
AE Profile APIs.io
Orum Book Transfers API
AE Profile APIs.io
Orum Businesses API
AE Profile APIs.io
Orum Cards API
AE Profile APIs.io
Orum Configure webhooks API
AE Profile APIs.io
Orum Eligibility API
AE Profile APIs.io
Orum External Accounts API
AE Profile APIs.io
Orum Persons API
AE Profile APIs.io
Orum Reports API
AE Profile APIs.io
Orum Schedules API
AE Profile APIs.io
Orum Secure webhooks API
AE Profile APIs.io
#Transfers
← Back to O APIs
API Details
ID
orum:orum-transfers-api
Base URL
https://api.orum.io
Docs
https://docs.orum.io
Provider
Orum
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=orum-transfers-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/orum-transfers-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Orum Transfers 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.