Skip to main content
POST
/
card
cURL
curl --request POST \
  --url https://api.covenance.com/card \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "subAccountId": "<string>",
  "name": "<string>",
  "spendingConstraint": {
    "spendingRule": {
      "utilizationLimit": {
        "preset": "daily",
        "timezone": "<string>",
        "limitAmount": {
          "amountCents": 123
        },
        "startDate": "<string>"
      },
      "transactionSizeLimit": {
        "minimum": {
          "amountCents": 123
        },
        "maximum": {
          "amountCents": 123
        }
      }
    }
  }
}
'
{
  "id": "<string>",
  "last4": "<string>",
  "name": "<string>",
  "expiryMonth": "<string>",
  "expiryYear": "<string>",
  "status": "active",
  "createdAt": "2023-11-07T05:31:56Z",
  "spendingConstraint": {
    "spendingRule": {
      "utilizationLimit": {
        "preset": "daily",
        "timezone": "<string>",
        "limitAmount": {
          "amountCents": 123
        },
        "startDate": "<string>"
      },
      "transactionSizeLimit": {
        "minimum": {
          "amountCents": 123
        },
        "maximum": {
          "amountCents": 123
        }
      }
    }
  }
}

Authorizations

x-api-key
string
header
required

Body

application/json

Card to add to the store

subAccountId
string
required
name
string
required
spendingConstraint
object

Spending constraint of the card

Response

OK

id
string
required

Id of the card

last4
string
required

Last 4 digits of the card number

name
string
required

Name of the card holder

expiryMonth
string
required

Expiry month of the card

expiryYear
string
required

Expiry year of the card

status
enum<string>
required

Status of the card

Available options:
active,
paused,
inactive,
closed
createdAt
string<date-time>
required

Creation date of the card

spendingConstraint
object

Spending constraint of the card