documentv2

savePaymentRequest

Internal documentv2/savePaymentRequest operation. Authentication requirements are derived from the active route allowlist.

post/documentv2/savePaymentRequest

Request body

adjustment_typestring
adjustment_valuestring
client_idinteger
collection_modestring
currency_idinteger
document_idinteger
due_datestring date
idinteger
include_detailsstring
invoice_typestring
net_amountstring
payment_channelstring
payment_datestring date
statusstring

Example request

{
  "adjustment_type": "example_adjustment_type",
  "adjustment_value": "example_adjustment_value",
  "client_id": 1,
  "collection_mode": "example_collection_mode",
  "currency_id": 1,
  "document_id": 1,
  "due_date": "2026-07-23",
  "id": 1,
  "include_details": "example_include_details",
  "invoice_type": "example_invoice_type",
  "net_amount": "example_net_amount",
  "payment_channel": "example_payment_channel",
  "payment_date": "2026-07-23",
  "status": "example_status"
}

Response

Standard successful response envelope.

status'success' required
statusCodeinteger required
messagestring required
dataobject required
{"stackTrail":"components:schemas:SuccessEnvelope:properties:error","oasType":"schema","type":"unknown","example":null,"nullable":true}

Example response

{
  "statusCode": 200,
  "message": "OK"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.