chargeTokenisedCard

chargeTokenisedCard

Path Parameters

departmentUuid string required

application/json

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

• 200
• 400
• 401
• 422
• 500

---

OK

application/json

Schema

Example (from schema)

---

Schema

error object
errorCode string
errorDescription string
warnings object[]
Array [
warningCode string
warningDescription string
]
transactionId string
customerId string
invoiceId string
amountAuthorized string
amountCaptured string

{
  "error": {
    "errorCode": "string",
    "errorDescription": "string"
  },
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ],
  "transactionId": "string",
  "customerId": "string",
  "invoiceId": "string",
  "amountAuthorized": "string",
  "amountCaptured": "string"
}

Bad Request

*/*

Schema

Example (from schema)

---

Schema

error object
errorCode string
errorDescription string
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "error": {
    "errorCode": "string",
    "errorDescription": "string"
  },
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Unauthorized

*/*

Schema

Example (from schema)

---

Schema

error object
errorCode string
errorDescription string
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "error": {
    "errorCode": "string",
    "errorDescription": "string"
  },
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Unprocessable Entity

*/*

Schema

Example (from schema)

---

Schema

error object
errorCode string
errorDescription string
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "error": {
    "errorCode": "string",
    "errorDescription": "string"
  },
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Internal Server Error

*/*

Schema

Example (from schema)

---

Schema

error object
errorCode string
errorDescription string
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "error": {
    "errorCode": "string",
    "errorDescription": "string"
  },
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Loading...