Skip to main content

getPaymentUrl​


ApiScope: payment.all
API Scope Level: DepartmentScope
Path Parameters
    departmentUuid string required
Request Body required
    customerIdentifiers object
    customerKey string
    campaignId string
    customerId string
    firstName string
    lastName string
    emails object[]
  • Array [
    • emailAddress string
    label string
    okToEmail boolean
    isPreferred boolean
  • ]
    • phoneNumbers object[]
  • Array [
    • phoneNumber string
    label string
    okToCall boolean
    okToText boolean
    isPreferred boolean
  • ]
    • bestTimeToContact object
    startTime string
    endTime string
    preferredCommunication string
    flags object
    footerToAdd boolean
    useMyKaarmaEmailPaymentRequest boolean
    useMyKaarmaTextPaymentRequest boolean
    useMyKaarmaEmailReceipt boolean
    useMyKaarmaTextPaymentReceipt boolean
    dealerAssociateIdentifier object
    dealerAssociateId string
    dealerAssociateFirstName string
    dealerAssociateLastName string
    dealerAssociateEmail string
    paymentDetails object
    amount number
    currency string
    paymentType string
    paymentDescription string
    additionalCharges object[]
  • Array [
    • additionalChargeAmount number
    additionalChargeDescription string
  • ]
    • preAuth string
    invoiceUrl string
    processedFor string
    paymentReceiptFormat string
    requireSignature string
    retryCount int32

    Possible values: <= 5

    signatureCoordinates object
    x double
    y double
    width double
    height double
    pageNumber int32
    verifyAVS boolean
    verifyZipCode boolean
    cssRef string
    language string
    clientSideRedirectUrl string
    webHookUrl string
    orderRef string
    ttl int64
    saveCard boolean
    byPass3DS boolean
    address object
    line1 string
    line2 string
    city string
    zip string
    addressType string
    type string

    Possible values: [COMMON, PRIMARY, BILLING, OTHER]

    country string
    updateTS date-time
    uuid string
    isValid boolean
    isPreferred boolean
    state string
Responses

OK

Schema
    error object
    errorCode string
    errorDescription string
    warnings object[]
  • Array [
    • warningCode string
    warningDescription string
  • ]
    • paymentUrl string
    invoiceId string
    customerId string
POST /v3/department/:departmentUuid/url

Request

Base URL
/payment
departmentUuid — path required
Body required
{

  "customerIdentifiers": {

    "customerKey": "string",

    "campaignId": "string",

    "customerId": "string",

    "firstName": "string",

    "lastName": "string",

    "emails": [

      {

        "emailAddress": "string",

        "label": "string",

        "okToEmail": true,

        "isPreferred": true

      }

    ],

    "phoneNumbers": [

      {

        "phoneNumber": "string",

        "label": "string",

        "okToCall": true,

        "okToText": true,

        "isPreferred": true

      }

    ],

    "bestTimeToContact": {

      "startTime": "string",

      "endTime": "string"

    },

    "preferredCommunication": "string"

  },

  "flags": {

    "footerToAdd": true,

    "useMyKaarmaEmailPaymentRequest": true,

    "useMyKaarmaTextPaymentRequest": true,

    "useMyKaarmaEmailReceipt": true,

    "useMyKaarmaTextPaymentReceipt": true

  },

  "dealerAssociateIdentifier": {

    "dealerAssociateId": "string",

    "dealerAssociateFirstName": "string",

    "dealerAssociateLastName": "string",

    "dealerAssociateEmail": "string"

  },

  "paymentDetails": {

    "amount": 0,

    "currency": "string",

    "paymentType": "string",

    "paymentDescription": "string",

    "additionalCharges": [

      {

        "additionalChargeAmount": 0,

        "additionalChargeDescription": "string"

      }

    ],

    "preAuth": "string",

    "invoiceUrl": "string",

    "processedFor": "string",

    "paymentReceiptFormat": "string",

    "requireSignature": "string",

    "retryCount": 0,

    "signatureCoordinates": {

      "x": 0,

      "y": 0,

      "width": 0,

      "height": 0,

      "pageNumber": 0

    },

    "verifyAVS": true,

    "verifyZipCode": true

  },

  "cssRef": "string",

  "language": "string",

  "clientSideRedirectUrl": "string",

  "webHookUrl": "string",

  "orderRef": "string",

  "ttl": 0,

  "saveCard": true,

  "byPass3DS": true,

  "address": {

    "line1": "string",

    "line2": "string",

    "city": "string",

    "zip": "string",

    "addressType": "string",

    "type": "COMMON",

    "country": "string",

    "updateTS": "2025-03-28T11:34:46.511Z",

    "uuid": "string",

    "isValid": true,

    "isPreferred": true,

    "state": "string"

  }

}
curl / cURL
curl -L -X POST '/payment/v3/department/:departmentUuid/url' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customerIdentifiers": {
    "customerKey": "string",
    "campaignId": "string",
    "customerId": "string",
    "firstName": "string",
    "lastName": "string",
    "emails": [
      {
        "emailAddress": "string",
        "label": "string",
        "okToEmail": true,
        "isPreferred": true
      }
    ],
    "phoneNumbers": [
      {
        "phoneNumber": "string",
        "label": "string",
        "okToCall": true,
        "okToText": true,
        "isPreferred": true
      }
    ],
    "bestTimeToContact": {
      "startTime": "string",
      "endTime": "string"
    },
    "preferredCommunication": "string"
  },
  "flags": {
    "footerToAdd": true,
    "useMyKaarmaEmailPaymentRequest": true,
    "useMyKaarmaTextPaymentRequest": true,
    "useMyKaarmaEmailReceipt": true,
    "useMyKaarmaTextPaymentReceipt": true
  },
  "dealerAssociateIdentifier": {
    "dealerAssociateId": "string",
    "dealerAssociateFirstName": "string",
    "dealerAssociateLastName": "string",
    "dealerAssociateEmail": "string"
  },
  "paymentDetails": {
    "amount": 0,
    "currency": "string",
    "paymentType": "string",
    "paymentDescription": "string",
    "additionalCharges": [
      {
        "additionalChargeAmount": 0,
        "additionalChargeDescription": "string"
      }
    ],
    "preAuth": "string",
    "invoiceUrl": "string",
    "processedFor": "string",
    "paymentReceiptFormat": "string",
    "requireSignature": "string",
    "retryCount": 0,
    "signatureCoordinates": {
      "x": 0,
      "y": 0,
      "width": 0,
      "height": 0,
      "pageNumber": 0
    },
    "verifyAVS": true,
    "verifyZipCode": true
  },
  "cssRef": "string",
  "language": "string",
  "clientSideRedirectUrl": "string",
  "webHookUrl": "string",
  "orderRef": "string",
  "ttl": 0,
  "saveCard": true,
  "byPass3DS": true,
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "zip": "string",
    "addressType": "string",
    "type": "COMMON",
    "country": "string",
    "updateTS": "2025-03-28T11:34:46.511Z",
    "uuid": "string",
    "isValid": true,
    "isPreferred": true,
    "state": "string"
  }
}'