getPaymentUrl

getPaymentUrl

Path Parameters

serviceSubscriberDepartmentToken string required

serviceSubscriberDepartmentToken

application/json

Request Body required

getPaymentUrlRequest

address object
zipCode string
byPass3DS boolean
clientSideRedirectUrl string
cssRef string
customerIdentifiers object
bestTimeToContact object
endTime string
startTime string
campaignId string
customerId string
customerKey string
emails object[]
Array [
emailAddress string
isPreferred boolean
label string
okToEmail boolean
]
firstName string
lastName string
phoneNumbers object[]
Array [
isPreferred boolean
label string
okToCall boolean
okToText boolean
phoneNumber string
]
preferredCommunication string
dealerAssociateIdentifier object
dealerAssociateEmail string
dealerAssociateFirstName string
dealerAssociateId string
dealerAssociateLastName string
flags object
footerToAdd boolean
useMyKaarmaEmailPaymentRequest boolean
useMyKaarmaEmailReceipt boolean
useMyKaarmaTextPaymentReceipt boolean
useMyKaarmaTextPaymentRequest boolean
language string
orderRef string
paymentDetails object
additionalCharges object[]
Array [
additionalChargeAmount number
additionalChargeDescription string
]
amount number
currency string
invoiceUrl string
paymentDescription string
paymentReceiptFormat string
paymentType string
preAuth string
processedFor string
requireSignature string
retryCount int32
signatureCoordinates object
height double
pageNumber int32
width double
x double
y double
verifyAVS boolean
verifyZipCode boolean
saveCard boolean
ttl int64
webHookUrl string

Responses

• 200
• 201
• 401
• 403
• 404

---

OK

application/json

Schema

Example (from schema)

---

Schema

customerId string
error object
errorCode string
errorDescription string
invoiceId string
paymentUrl string
warnings object[]
Array [
warningCode string
warningDescription string
]

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

Created

Unauthorized

Forbidden

Not Found

Loading...