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 Cards API

The Cards API from Orum — 2 operation(s) for cards.

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

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

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

4 operations 2 paths 38 schemas 1 DELETE2 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 Cards API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 29 scopes.

Paths & Operations 4

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

Cards 4
POST
/deliver/cards
Create a card
post-card body → 200400default
GET
/deliver/cards
Get all cards
get-cards 5 params → 200400default
GET
/deliver/cards/{id}
Get a card by id
get-card 1 param → 200404default
DELETE
/deliver/cards/{id}
Closes a card by id
delete-card 1 param → 200404default

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are CardResponseBase (17 properties), CardAddressResponse (10 properties), CardRequest (9 properties), CardAddressRequest (6 properties). Each schema is shown below with its type and property counts.

ClosedAt
string
Timestamp when the status of the resource was set to "closed".
AddressTypeCard
string
Type of address. Always 'billing' for card object.
CardAccountReferenceId
string
Unique reference id for the card. Generated by you.
CardResponseBase
object
17 properties 12 required
Zip5
string
5-digit ZIP Code. Numeric values (0-9) only.
CardCustomerReferenceId
string
Unique customerreferenceid that you passed when creating the associated customer (business or person) resource.
LastName
string
Accepts latin characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.
CardExpirationYear
integer
The year in which the card expires.
CreatedAt
string
Timestamp when the resource was created.
UpdatedAt
string
Timestamp when the resource was last updated.
CardAccountHolderNamePerson
object
Name of account holder.
4 properties 2 required
Address2
string
Address line 2.
ReasonCode
string
A word-based code that describes the verification failure.
CardsResponse
object
1 property 1 required
CardAddressResponse
object
Address.
10 properties 5 required
StatusReason
object
2 properties 2 required
CardAddressRequest
object
Full address of card holder
6 properties 5 required
Country
string
2-character ISO country code.
CardResponse
object
1 property 1 required
CardLastFourDigits
string
The last four digits of the card number supplied by the customer.
CardAddressRequestZipOnly
object
Zip code of card holder
1 property 1 required
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…
MiddleName
string
Accepts latin characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.
CardStatus
string
Status of card in Orum system.
CustomerReferenceId
string
Unique reference id for the customer (business or person) resource. Generated by you.
FirstName
string
Accepts latin characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.
CardAccountHolderNameBusiness
object
Business name of account holder. Accepts alphanumeric characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.
1 property 1 required
OrumId
string
Orum generated unique id for the resource.
Address1
string
Address line 1.
CardRequest
object
9 properties 8 required
State
string
Uppercase two-character state code of the address.
CardStatusFilter
array
Filter by status of card in Orum system.
ReasonCodeMessage
string
A human-readable description of the reason code.
ErrorResponse
object
3 properties 2 required
EndCustomerResourceType
string
Type of customer resource - business, person, or enterprise.
City
string
City.
CardExpirationMonth
integer
The month in which the card expires.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

orum-cards-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 Configure webhooks API
Orum Eligibility API
Orum External Accounts API
Orum Persons API
Orum Reports API
Orum Schedules API
Orum Secure webhooks API
Orum Subledgers API
Where this information came from

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