Skip to main content

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
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

OK

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]

POST /aggregator/v1/departments/:departmentUuid/payment-requests

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL
/payment
Username
Password
departmentUuid — path required
Body required
{

  "amount": 0,

  "description": "string",

  "refundedAmount": 0,

  "paidDate": "2025-03-28T11:34:46.520Z",

  "signatureFileName": "string",

  "reminderDate": "2025-03-28T11:34:46.520Z",

  "reminderMileage": 0,

  "fileName": "string",

  "paymentDeclines": "string",

  "invoiceAttributes": {},

  "dealerUuid": "string",

  "orderUuid": "string",

  "customerUuid": "string",

  "dealerAssociateDepartmentUuid": "string",

  "dealerAssociateUuid": "string",

  "dealerAssociateUserUuid": "string",

  "attachInvoice": true,

  "esignInvoice": true,

  "sendAsText": true,

  "sendAsEmail": true,

  "orderNumber": "string",

  "orderType": "string"

}
curl / cURL
curl -L -X POST '/payment/aggregator/v1/departments/:departmentUuid/payment-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "amount": 0,
  "description": "string",
  "refundedAmount": 0,
  "paidDate": "2025-03-28T11:34:46.520Z",
  "signatureFileName": "string",
  "reminderDate": "2025-03-28T11:34:46.520Z",
  "reminderMileage": 0,
  "fileName": "string",
  "paymentDeclines": "string",
  "invoiceAttributes": {},
  "dealerUuid": "string",
  "orderUuid": "string",
  "customerUuid": "string",
  "dealerAssociateDepartmentUuid": "string",
  "dealerAssociateUuid": "string",
  "dealerAssociateUserUuid": "string",
  "attachInvoice": true,
  "esignInvoice": true,
  "sendAsText": true,
  "sendAsEmail": true,
  "orderNumber": "string",
  "orderType": "string"
}'