Sign in
invoices_service

Update invoice

patch/api/v1/services/invoices/{id}

Path parameters

idstring required
Example:60ffb075

Invoice ID

Query parameters

app_idinteger required

App ID

Request body

refund_amountnumber
refundedboolean

Response

Service invoices fee

idstring required
amountstring required
overpaymentstring
descriptionstring required
status'pending' | 'paid' | 'cancelled' | 'expired' required
pay_to_addressstring required
paid_by_addressstring
payment_linkstring required
{"stackTrail":"components:schemas:InvoicesInvoice:properties:info","oasType":"schema","type":"unknown","example":{"first_key":"1","second_key":2}}
date_changeinteger required
date_expireinteger required
date_createinteger required
currency'TON' | 'USDT' required

Example response

{
  "id": "60ffb075",
  "amount": "1000000000",
  "overpayment": "1000000000",
  "description": "Test description",
  "status": "pending",
  "pay_to_address": "0:97146a46acc2654y27947f14c4a4b14273e954f78bc017790b41208b0043200b",
  "paid_by_address": "0:97146a46acc2654y27947f14c4a4b14273e954f78bc017790b41208b0043200b",
  "payment_link": "https://app.tonkeeper.com/transfer/UQ....UQ",
  "info": {
    "first_key": "1",
    "second_key": 2
  },
  "date_change": 1690889913000,
  "date_expire": 1690889913000,
  "date_create": 1690889913000
}

Changes

Changed in 7 of the 50 revisions of this API.234

  • dc03bb6c514d1See the full diff
    • ○

      the response's property default value TON was removed for the status

      response-property-default-value-removed

  • f4284b4249431See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

  • dbd561304b3b1See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • f9f50dcb64171See the full diff
    • ○

      added the media type application/json for the response with the status

      response-media-type-added

  • 2596aa00157e1See the full diff
    • ▲

      removed the media type application/json for the response with the status

      response-media-type-removed

  • 20ef35372eae1See the full diff
    • ▲

      the / response's property type changed from number to string for status

      response-property-type-changed

  • aaef903178b63See the full diff
    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed