Skip to main content
POST
Create a card
  • To create a card, use POST vault.api-sandbox.orum.io/deliver/cards
  • All other card endpoints will continue to use api-sandbox.orum.io
  • This allows us to securely handle your card information

Authorizations

Authorization
string
header
required

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

Body

application/json
account_reference_id
string
required

Unique reference id for the card. 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_holder_name
Person Name · object
required

Name of account holder.

address
Zip Code · object
required

Zip code of card holder

number
string
required

The card's number

Required string length: 8 - 19
expiration_month
integer
required

The month in which the card expires.

Required range: 1 <= x <= 12
expiration_year
integer
required

The year in which the card expires.

Required range: x >= 2024
metadata
object | null

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.

card
object
required