Skip to main content

chargeTokenisedCard​


ApiScope: payment.all
API Scope Level: DepartmentScope
Path Parameters
    departmentUuid string required
Request Body required
    customerIdentifierTokenised object
    customerId string
    okToEmail boolean
    okToText boolean
    bestTimeToContact object
    startTime string
    endTime string
    preferredCommunication string
    flagsTokenised object
    useMyKaarmaEmailReceipt boolean
    useMyKaarmaTextPaymentReceipt boolean
    dealerAssociateIdentifier object
    dealerAssociateId string
    dealerAssociateFirstName string
    dealerAssociateLastName string
    dealerAssociateEmail string
    paymentDetailsTokenised object
    amount number
    currency string
    paymentType string
    paymentDescription string
    cardHash string
    cvv string
    verifyCVV boolean
    language string
    webHookUrl string
    orderRef string
Responses

OK

Schema
    error object
    errorCode string
    errorDescription string
    warnings object[]
  • Array [
    • warningCode string
    warningDescription string
  • ]
    • transactionId string
    customerId string
    invoiceId string
    amountAuthorized string
    amountCaptured string
POST /v3/department/:departmentUuid/chargeSavedCard

Request

Base URL
/payment
departmentUuid — path required
Body required
{

  "customerIdentifierTokenised": {

    "customerId": "string",

    "okToEmail": true,

    "okToText": true,

    "bestTimeToContact": {

      "startTime": "string",

      "endTime": "string"

    },

    "preferredCommunication": "string"

  },

  "flagsTokenised": {

    "useMyKaarmaEmailReceipt": true,

    "useMyKaarmaTextPaymentReceipt": true

  },

  "dealerAssociateIdentifier": {

    "dealerAssociateId": "string",

    "dealerAssociateFirstName": "string",

    "dealerAssociateLastName": "string",

    "dealerAssociateEmail": "string"

  },

  "paymentDetailsTokenised": {

    "amount": 0,

    "currency": "string",

    "paymentType": "string",

    "paymentDescription": "string",

    "cardHash": "string",

    "cvv": "string",

    "verifyCVV": true

  },

  "language": "string",

  "webHookUrl": "string",

  "orderRef": "string"

}
curl / cURL
curl -L -X POST '/payment/v3/department/:departmentUuid/chargeSavedCard' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customerIdentifierTokenised": {
    "customerId": "string",
    "okToEmail": true,
    "okToText": true,
    "bestTimeToContact": {
      "startTime": "string",
      "endTime": "string"
    },
    "preferredCommunication": "string"
  },
  "flagsTokenised": {
    "useMyKaarmaEmailReceipt": true,
    "useMyKaarmaTextPaymentReceipt": true
  },
  "dealerAssociateIdentifier": {
    "dealerAssociateId": "string",
    "dealerAssociateFirstName": "string",
    "dealerAssociateLastName": "string",
    "dealerAssociateEmail": "string"
  },
  "paymentDetailsTokenised": {
    "amount": 0,
    "currency": "string",
    "paymentType": "string",
    "paymentDescription": "string",
    "cardHash": "string",
    "cvv": "string",
    "verifyCVV": true
  },
  "language": "string",
  "webHookUrl": "string",
  "orderRef": "string"
}'