Sign in
Cards

Add Card

Endpoint to add a new Card. The created Card has the same currency of the Wallet it belongs to.

post/business/v2/cards

Headers

X-Soldo-Fingerprintstring required

Advanced authentication: SHA512SUM of the fingerprint values listed in the fingerprint order for this endpoint.

Example:{{fingerprint}}
X-Soldo-Fingerprint-Signaturestring required

Advanced authentication: Signature of the X-Soldo-Fingerprint.

Example:{{fingerprint_signature}}

Request body

request_timestampinteger required

The epoch timestamp in millis. This is checked in Soldo. Requests with timestamp older than 5 seconds will be rejected.

owner_type'company' | 'employee' | 'expensecentre' required
owner_public_idstring required

The Card owner ID, only applicable for owner type employee cards.

wallet_idstring

The Wallet ID, if not specified a reserved Wallet will be created for the added Card.

reserved_wallet_currency'EUR' | 'GBP' | 'USD'

The ISO 4217 code of the currency of the Statement to search for.

type'PLASTIC' | 'VIRTUAL' | 'FUEL' | 'GOOGLE_CARD' | 'PLASTIC_CHARGE' | 'VIRTUAL_CHARGE' required
namestring required

The logical name of the Card for a company card, ignored in case of employee card (the cardholder full name is used instead).

card_labelstring

A label for the Card (max 60 characters).

emboss_line4string

The emboss line 4 of the Card.

address_idstring

The Address ID the Card has to be shipped to (if empty, the default shipping Address is used i.e. where default_shipping = true), only applicable for PLASTIC and FUEL cards.

vehicle_idstring

The Vehicle ID assigned to the Card, only valid for FUEL cards.

preset_idstring

The cardRulePreset ID assigned to the Card.

Example request

{
  "request_timestamp": 1576850500000,
  "owner_public_id": "XMPL1234-000001",
  "wallet_id": "c861cc24-6663-410f-8c78-73f886fff4ef",
  "reserved_wallet_currency": "EUR",
  "name": "CardName",
  "card_label": "CardLabel",
  "emboss_line4": "Example Inc.",
  "address_id": "c861cc24-6663-410f-8c78-73f886fff4ef",
  "vehicle_id": "c861cc24-6663-410f-8c78-73f886fff4ef",
  "preset_id": "c861cc24-6663-410f-8c78-73f886fff4ef"
}

Response

The returned resource is a single Order.

idstring

The Order ID.

status'PENDING' | 'ERROR' | 'PLACED' | 'CANCELLED' | 'COMPLETED' | 'COMPLETED_WITH_CREDIT'
creation_timestring

The date and time when the Order was created.

last_update_timestring

The last update date of the Order.

error_codestring

In case is_valid is false, the error code of the Order is shown.

total_paid_amountnumber

The total amount of the Order.

total_paid_currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VEF' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'
is_validboolean

It states whether the Order is valid.

Example response

{
  "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
  "creation_time": "2017-06-01T12:48:40Z",
  "last_update_time": "2017-06-01T12:48:40Z",
  "total_paid_amount": 10.25,
  "items": [
    {
      "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "item_type": "CARD"
    }
  ],
  "is_valid": true
}