Get All Cards

Get all cards

curl --request GET \
  --url https://api-sandbox.orum.io/deliver/cards \
  --header 'Authorization: Bearer <token>' \
  --header 'Orum-Version: <orum-version>'

{
  "cards": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "account_reference_id": "<string>",
      "customer_reference_id": "<string>",
      "customer_resource_type": "business",
      "account_holder_name": {
        "first_name": "<string>",
        "last_name": "<string>",
        "middle_name": "<string>",
        "suffix": "<string>"
      },
      "status": "created",
      "address": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "billing",
        "zip5": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "address1": "<string>",
        "address2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "US"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "last4": "<string>",
      "expiration_month": 6,
      "expiration_year": 2025,
      "pull_eligible": true,
      "push_eligible": true,
      "closed_at": "2023-11-07T05:31:56Z",
      "metadata": {},
      "status_reasons": [
        {
          "reason_code": "invalid_address",
          "reason_code_message": "Address submitted is a non-supported address type"
        }
      ]
    }
  ]
}

GET

deliver

cards

Get all cards

curl --request GET \
  --url https://api-sandbox.orum.io/deliver/cards \
  --header 'Authorization: Bearer <token>' \
  --header 'Orum-Version: <orum-version>'

{
  "cards": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "account_reference_id": "<string>",
      "customer_reference_id": "<string>",
      "customer_resource_type": "business",
      "account_holder_name": {
        "first_name": "<string>",
        "last_name": "<string>",
        "middle_name": "<string>",
        "suffix": "<string>"
      },
      "status": "created",
      "address": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "billing",
        "zip5": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "address1": "<string>",
        "address2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "US"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "last4": "<string>",
      "expiration_month": 6,
      "expiration_year": 2025,
      "pull_eligible": true,
      "push_eligible": true,
      "closed_at": "2023-11-07T05:31:56Z",
      "metadata": {},
      "status_reasons": [
        {
          "reason_code": "invalid_address",
          "reason_code_message": "Address submitted is a non-supported address type"
        }
      ]
    }
  ]
}

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

Query Parameters

index

integer

default:0

Index for paginated results

Required range: x >= 0

size

integer

default:100

Max number of results to return

Required range: 0 <= x <= 500

customer_reference_id

string

Filter by customer reference id Unique reference id for the customer (business or person) resource. Generated by you.

Required string length: 1 - 255

status

enum<string>[]

Filter by card statuses (multiple allowed) Filter by status of card in Orum system.

Status of card in Orum system.

Available options:

created,

verified,

rejected,

closed

Response

200 response.

cards

object[]

required

List of card objects.

Show child attributes

cards.id

string<uuid>

required

Orum generated unique id for the resource.

cards.account_reference_id

string

required

Unique reference id for the card. Generated by you.

Required string length: 1 - 255

cards.customer_reference_id

string

required

Unique reference id for the customer (business or person) resource. Generated by you.

Required string length: 1 - 255

cards.customer_resource_type

enum<string>

required

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

Available options:

business,

person,

enterprise

cards.account_holder_name

Person Name · object

required

Name of account holder.

Person Name
Business Name

Show child attributes

cards.account_holder_name.first_name

string

required

Accepts latin characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.

Required string length: 1 - 255

cards.account_holder_name.last_name

string

required

Accepts latin characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.

Required string length: 1 - 255

cards.account_holder_name.middle_name

string

Accepts latin characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.

Maximum string length: 255

cards.account_holder_name.suffix

string | null

Accepts alphanumeric characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.

Maximum string length: 255

cards.status

enum<string>

required

Status of card in Orum system.

Available options:

created,

verified,

rejected,

closed

cards.address

CardAddressResponse · object

required

Address.

Show child attributes

cards.address.id

string<uuid>

required

Orum generated unique id for the resource.

cards.address.type

enum<string>

required

Type of address. Always 'billing' for card object.

Available options:

billing

cards.address.zip5

string

required

5-digit ZIP Code. Numeric values (0-9) only.

cards.address.created_at

string<date-time>

required

Timestamp when the resource was created.

cards.address.updated_at

string<date-time>

required

Timestamp when the resource was last updated.

cards.address.address1

string

Address line 1.

Maximum string length: 255

cards.address.address2

string

Address line 2.

Maximum string length: 255

cards.address.city

string

City.

Maximum string length: 255

cards.address.state

string

Uppercase two-character state code of the address.

cards.address.country

enum<string>

2-character ISO country code.

Available options:

US

cards.created_at

string<date-time>

required

Timestamp when the resource was created.

cards.updated_at

string<date-time>

required

Timestamp when the resource was last updated.

cards.last4

string

required

The last four digits of the card number supplied by the customer.

cards.expiration_month

integer

required

The month in which the card expires.

Required range: 1 <= x <= 12

cards.expiration_year

integer

required

The year in which the card expires.

Required range: x >= 2024

cards.pull_eligible

boolean

Indicates that the card can be used for pull transactions.

cards.push_eligible

boolean

Indicates that the card can be used for push transactions.

cards.closed_at

string<date-time>

Timestamp when the status of the resource was set to "closed".

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

cards.status_reasons

object[]

Array that explains why the person failed verification.

Show child attributes

cards.status_reasons.reason_code

string

required

A word-based code that describes the verification failure.

Example:

"invalid_address"

cards.status_reasons.reason_code_message

string

required

A human-readable description of the reason code.

Example:

"Address submitted is a non-supported address type"

Create A Card Get A Card By ID

⌘I

Auth API

Deliver API

Verify API

Webhooks API

Authorizations

Headers

Query Parameters

Response