v2

latestOpenAPI 3.1.02026-07-267085761.0 MB

Check

Create Check

post/api/check/create

Request body

payment_method'BANK' required

received_to'CHECK_PRINT' | 'CHECK_EMAIL' required

payee_idstring required

payment_idstring nullable

amountnumber required

bank_idstring required

check_nostring required

validate_check_noboolean

issue_datestring date required

descriptionstring nullable

invoice_numberstring nullable

invoice_attachmentstring nullable

emailstring nullable

save_onlyboolean

logo_urlstring nullable

signature_urlstring nullable

main_stub_position'top' | 'middle' | 'bottom'

Response

Successful Response

successboolean

Indicates whether the request was processed successfully.

messagestring

A short, human-readable message describing the result of the request.

{"stackTrail":"components:schemas:CommonResponse:properties:data:anyOf","oasType":"schema","type":"unknown","title":"Data","description":"The main response payload, if applicable","nullable":true}

queryGeneratedTimenumber nullable

The Unix timestamp (in seconds) indicating when the response was generated.

Example response

{
  "success": true,
  "message": "Operation completed.",
  "queryGeneratedTime": 1718006400
}