Send Payment Request

ApiScope: payment.paymentrequest.write
API Scope Level: DepartmentScope

Path Parameters

departmentUuid string required

application/json

Request Body required

createPaymentRequest object
invoiceGuid string
sendWithoutKpay boolean
attachInvoice boolean
sendAsText boolean
sendAsEmail boolean
esignRequired boolean
paymentRequestSourceType string

Possible values: [A, P, R]

refundRequest object
transactionUuid string
refundAmount number
refundReason string
sendAsText boolean
sendAsEmail boolean

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
]
paymentLink string
invoiceLink 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"
    }
  ],
  "paymentLink": "string",
  "invoiceLink": "string",
  "textSent": "SUCCESS",
  "emailSent": "SUCCESS"
}

Loading...