Skip to main content
POST
/
api
/
v1
/
payment
/
invoice_payment
/
{invoice_payment_uuid}
/
cancel
Invoice Payment Cancel Api
curl --request POST \
  --url https://api.justpaid.io/api/v1/payment/invoice_payment/{invoice_payment_uuid}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "invoice": {
    "amount": 123,
    "invoice_number": "<string>",
    "line_items": [
      {
        "name": "<string>",
        "unit_price": 123,
        "quantity": 123,
        "amount": 123,
        "currency": "<string>",
        "description": "<string>",
        "flat_fee": 123
      }
    ],
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "currency": "USD",
    "invoice_date": "2023-12-25",
    "description": "<string>"
  },
  "total_amount": 123,
  "customer_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payment_status": "<string>",
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reference_number": "<string>",
  "payment_scheduled_date": "2023-11-07T05:31:56Z",
  "payment_completed_date": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
invoice_payment_uuid
string
required

Response

200 - application/json

OK

​
invoice
InvoiceOut · object
required
​
total_amount
number
required

Total amount of the payment

​
customer_uuid
string<uuid>

The JustPaid customer UUID

​
payment_status
string
​
uuid
string<uuid>
​
reference_number
string | null

Reference number for the payment

Maximum string length: 50
​
payment_scheduled_date
string<date-time> | null

Date and time on which the payment is scheduled to be made

​
payment_completed_date
string<date-time> | null

Date and time on which the payment is completed