Payment cancelation (Invoices payments cancel)

Method for canceling an invoice payment with HOLD type

URL

POST api/invoicer/payments/cancel

 

Request:

Key

Description

Type

Mandatory

Example

Key

Description

Type

Mandatory

Example

params









sessionId

client session id 

string, uuid

yes

"000ab70b-ef76-4385-a0f5-a98693c716f1"

paymentId

payment id

string, uuid

yes

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

invoiceId

invoice id 

string, uuid

yes

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

Example of a query
1 2 3 4 5 6 7 { "params": { "sessionId": "000ab70b-ef76-4385-a0f5-a98693c716f1", "paymentId": "08eff720-9432-4951-a698-94e24db59e66", "invoiceId": "48cae638-2f4b-434c-aafa-a4b9ced4b486" } }


Reply:

Key

Description

Type

Example

Key

Description

Type

Example

status

Status. 0 - error, 1 - success

integer

1

data







paymentId

payment id 

string, uuid

1 "08eff720-9432-4951-a698-94e24db59e66"
Example of an answer
1 2 3 4 5 6 { "status": 1, "data": { "paymentId": "08eff720-9432-4951-a698-94e24db59e66" } }