Update Invoice

Update Invoice

Path Parameters

• id string required

  Invoice ID

Header Parameters

• X-Winpay-Timestamp string required

  ISO 8601 timestamp

• X-Winpay-Key string required

  Client Key

• X-Winpay-Signature string required

  Signature

• Content-Type string required

  Content type

application/json

Request Body required

• customer object

  name string

  email string

  phone string
• invoice object

  ref string

  products object[]

  Array [

  name string

  qty integer

  price string

  ]
• back_url string
• interval integer

  validity in minutes

Responses

• 200
• 400
• 404
• 500

---

Sukses update invoice

application/json

• Schema
• Example (from schema)

---

Schema

• responseCode string
• responseMessage string
• responseDate string
• responseData object

  id string

  ref string

  created_at string

  redirect_url string

  back_url string

  status string

  Possible values: [UNPAID, PAID]

  customer object

  name string

  email string

  phone string

  products object[]

  Array [

  uuid string

  name string

  qty integer

  price integer

  ]

{
  "responseCode": "2000300",
  "responseMessage": "Invoice Found",
  "responseDate": "2023-09-05T10:00:16+07:00",
  "responseData": {
    "id": "4282f340-51a8-40a2-a0e6-f3c95543ab6f",
    "ref": "invoice-0000001",
    "created_at": "2023-09-05 09:52:53",
    "redirect_url": "https://checkout.bmstaging.id/g5jh1k55lv9",
    "back_url": "https://google.com",
    "status": "UNPAID",
    "customer": {
      "name": "Delina Prasetya",
      "email": "[email protected]",
      "phone": "082342861666"
    },
    "products": [
      {
        "uuid": "f55cd7c4-b4b0-45b3-b2ff-102e8dd8f122",
        "name": "Keripik Singkong",
        "qty": 20,
        "price": 20000
      },
      {
        "uuid": "3d3d40b8-1a05-408e-ae98-1c7257cec2ed",
        "name": "Jasa Kirim",
        "qty": 1,
        "price": 5000
      }
    ]
  }
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• oneOf
  • UpdateInvoiceAlreadyPaid
  • CreateInvoiceInvalidParameters
  • CreateInvoiceMerchantRefAlreadyExists

  ---
• responseCode string
• responseMessage string
• responseDate string
• responseData array

responseCode string

responseMessage string

responseDate string

responseData array

responseCode string

responseMessage string

responseDate string

responseData array

{
  "responseCode": "4000302",
  "responseMessage": "Invoice already paid",
  "responseDate": "2023-09-05T10:24:16+07:00",
  "responseData": []
}

Invoice not found

application/json

• Schema
• Example (from schema)

---

Schema

• responseCode string
• responseMessage string
• responseDate string
• responseData array

{
  "responseCode": "4040300",
  "responseMessage": "Invoice not found",
  "responseDate": "2023-09-05T10:00:16+07:00",
  "responseData": []
}

General Error

application/json

• Schema
• Example (from schema)

---

Schema

• responseCode string
• responseMessage string
• responseDate string
• responseData array

{
  "responseCode": "5000300",
  "responseMessage": "General Error",
  "responseDate": "2023-09-05T10:00:16+07:00",
  "responseData": []
}