getPaymentUrl

getPaymentUrl

Path Parameters

departmentUuid string required

application/json

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
zipCode 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
]
paymentUrl string
invoiceId string
customerId string

{
  "error": {
    "errorCode": "string",
    "errorDescription": "string"
  },
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ],
  "paymentUrl": "string",
  "invoiceId": "string",
  "customerId": "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...