POST
/
deliver
/
cards
curl --request POST \
  --url https://vault.api-sandbox.orum.io/deliver/cards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "account_reference_id": "<string>",
  "customer_reference_id": "<string>",
  "customer_resource_type": "business",
  "account_holder_name": {
    "first_name": "<string>",
    "middle_name": "<string>",
    "last_name": "<string>",
    "suffix": "<string>"
  },
  "address": {
    "zip5": "<string>"
  },
  "metadata": {},
  "number": "<string>",
  "expiration_month": 6,
  "expiration_year": 2025
}'
{
  "card": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "account_reference_id": "<string>",
    "customer_reference_id": "<string>",
    "customer_resource_type": "business",
    "account_holder_name": {
      "first_name": "<string>",
      "middle_name": "<string>",
      "last_name": "<string>",
      "suffix": "<string>"
    },
    "status": "created",
    "pull_eligible": true,
    "push_eligible": true,
    "address": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "billing",
      "address1": "<string>",
      "address2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "US",
      "zip5": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "closed_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "last4": "<string>",
    "expiration_month": 6,
    "expiration_year": 2025,
    "status_reasons": [
      {
        "reason_code": "invalid_address",
        "reason_code_message": "Address submitted is a non-supported address type"
      }
    ]
  }
}

  • 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 length: 255
​
customer_resource_type
enum<string>
required

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

Available options:
business,
person,
enterprise
​
account_holder_name
object
required

Name of account holder.

​
address
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

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
application/json
200 response.
​
card
object
required

Was this page helpful?