Reverse an invoice payment (Invoices payments reverse)

Method for canceling an invoice payment

URI

POST api/invoicer/payments/reverse

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"

data









amount

refund amount

integer

no

100

Example of the query
1 2 3 4 5 6 7 8 9 10 { "params": { "sessionId": "00684a7f-3d5c-43f4-b4d1-ea994226be9c", "paymentId": "310fe3f9-f3b0-44e4-80c6-95cc432d18de", "invoiceId": "01bdc112-623e-490c-9717-42168b7346d8" }, "data": { "amount": 100 } }


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" } }