Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The method for completing an invoice payment with HOLD type

Tip
iconfalse
title

URL

POST api/invoicer/payments/complete

Request:

...

Key

Description

Type

Mandatory

Example

params





sessionId

client session id 

string, uuid

yes

"00684a7f-3d5c-43f4-b4d1-ea994226be9c"

paymentId

payment id 

string, uuid

yes

"08eff720-9432-4951-a698-94e24db59e66"

invoiceId

invoice id 

string, uuid

yes

"48cae638-2f4b-434c-aafa-a4b9ced4b486"

amount

the amount of confirmation (in kopecks)

integer

no, only for situations where the amount of confirmation needs to be reduced 

1200

...

...

Example of a query
linenumbers
Code Block
true
languagecollapsetruejs
{
   "params": {
      "sessionId": "000ab70b-ef76-4385-a0f5-a98693c716f1",
      "paymentId": "08eff720-9432-4951-a698-94e24db59e66",
      "invoiceId": "48cae638-2f4b-434c-aafa-a4b9ced4b486",
	  "amount": 1200
   }
}


Reply:

Key

Description

Type

Example

status

Status. 0 - error, 1 - success

integer

1

data




paymentId

payment id

string, uuid

Code Block
"08eff720-9432-4951-a698-94e24db59e66"

...

...

Example of an answer
linenumbers
Code Block
true
languagecollapsetruejs
{
    "status": 1,
    "data": {
        "paymentId": "08eff720-9432-4951-a698-94e24db59e66"
    }
}

...