Send Payment Request

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

Path Parameters

departmentUuid string required

application/json

Request Body required

invoiceGuid string

sendWithoutKpay boolean

attachInvoice boolean

sendAsText boolean

sendAsEmail boolean

esignRequired boolean

Responses

*/*

Schema

Example (from schema)

Schema

errors object[]

warnings object[]

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

POST /v4/departments/:departmentUuid/payment-requests

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/payment

Username

Password

departmentUuid — path required

Body required

{
  "invoiceGuid": "string",
  "sendWithoutKpay": true,
  "attachInvoice": true,
  "sendAsText": true,
  "sendAsEmail": true,
  "esignRequired": true
}

curl / cURL
curl -L -X POST '/payment/v4/departments/:departmentUuid/payment-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "invoiceGuid": "string",
  "sendWithoutKpay": true,
  "attachInvoice": true,
  "sendAsText": true,
  "sendAsEmail": true,
  "esignRequired": true
}'

python / requests
curl -L -X POST '/payment/v4/departments/:departmentUuid/payment-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "invoiceGuid": "string",
  "sendWithoutKpay": true,
  "attachInvoice": true,
  "sendAsText": true,
  "sendAsEmail": true,
  "esignRequired": true
}'

go / native
curl -L -X POST '/payment/v4/departments/:departmentUuid/payment-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "invoiceGuid": "string",
  "sendWithoutKpay": true,
  "attachInvoice": true,
  "sendAsText": true,
  "sendAsEmail": true,
  "esignRequired": true
}'

nodejs / axios
curl -L -X POST '/payment/v4/departments/:departmentUuid/payment-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "invoiceGuid": "string",
  "sendWithoutKpay": true,
  "attachInvoice": true,
  "sendAsText": true,
  "sendAsEmail": true,
  "esignRequired": true
}'

ruby / Net::HTTP
curl -L -X POST '/payment/v4/departments/:departmentUuid/payment-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "invoiceGuid": "string",
  "sendWithoutKpay": true,
  "attachInvoice": true,
  "sendAsText": true,
  "sendAsEmail": true,
  "esignRequired": true
}'

csharp / RestSharp
curl -L -X POST '/payment/v4/departments/:departmentUuid/payment-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "invoiceGuid": "string",
  "sendWithoutKpay": true,
  "attachInvoice": true,
  "sendAsText": true,
  "sendAsEmail": true,
  "esignRequired": true
}'

php / cURL
curl -L -X POST '/payment/v4/departments/:departmentUuid/payment-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "invoiceGuid": "string",
  "sendWithoutKpay": true,
  "attachInvoice": true,
  "sendAsText": true,
  "sendAsEmail": true,
  "esignRequired": true
}'

java / OkHttp
curl -L -X POST '/payment/v4/departments/:departmentUuid/payment-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "invoiceGuid": "string",
  "sendWithoutKpay": true,
  "attachInvoice": true,
  "sendAsText": true,
  "sendAsEmail": true,
  "esignRequired": true
}'

powershell / RestMethod
curl -L -X POST '/payment/v4/departments/:departmentUuid/payment-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "invoiceGuid": "string",
  "sendWithoutKpay": true,
  "attachInvoice": true,
  "sendAsText": true,
  "sendAsEmail": true,
  "esignRequired": true
}'