Send Payment Request

This endpoint aggregates 3 endpoints:

1. Creates DealerOrder (if orderUuid is not passed)
2. Creates Invoice (if no open Invoice is present)
3. Creates Payment Request
   ApiScope: payment.send.payment.request
   API Scope Level: DepartmentScope

Path Parameters

departmentUuid string required

application/json

Request Body required

amount number
description string
refundedAmount number
paidDate date-time
signatureFileName string
reminderDate date-time
reminderMileage int64
fileName string
paymentDeclines string
invoiceAttributes object
property name* string
dealerUuid string
orderUuid string
customerUuid string
dealerAssociateDepartmentUuid string
dealerAssociateUuid string
dealerAssociateUserUuid string
attachInvoice boolean
esignInvoice boolean
sendAsText boolean
sendAsEmail boolean
orderNumber string
orderType string

Responses

• 200

---

OK

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]
paymentUrl string
textSent string

Possible values: [SUCCESS, FAILURE]

emailSent string

Possible values: [SUCCESS, FAILURE]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ],
  "paymentUrl": "string",
  "textSent": "SUCCESS",
  "emailSent": "SUCCESS"
}

Loading...