Find Invoice

This API is used to find invoices by id.

Spesification

API Name	Find Invoice
Http Method	GET
Path	.../api/find/{id}

Header

The mandatory headers that must be sent at the time of the request are:

Header	Description
X-Winpay-Timestamp	Time of transaction date, with format YYYY-MM-DDTHH:mm:ss+07:00. Time must be GMT+7 (time Jakarta)
X-Winpay-Signature	Signature generated by the merchant
X-Winpay-Key	Client key merchant
Content-Type	must application/json

Response

The following is the body response that will be received

Parameters	Data Type	Description
responseCode	string	response code
responseMessage	string	response message
responseDate	date	response date
responeData	json element	-
responeData.id	string	Transaction ID
responeData.ref	string	Reference number for the related transaction
responeData.created_at	date	transaction date created
responeData.back_url	string	The URL that is directed to or displayed after the customer has completed the payment
responeData.status	string	Payment status
responeData.customer	json element	-
responeData.customer.name	string	Customer name
responeData.customer.email	string	customer service email
responeData.customer.phone	string	customer phone number
responeData.products	json element	-
responeData.products[].uuid	string	ID is for transactions related to products
responeData.products[].name	string	product name
responeData.products[].qty	integer	number of products
responeData.products[].price	integer	product price
responeData.payment	json element	-
responeData.payment.uuid	string	ID is for related payments
responeData.payment.channel	string	payment channel
responeData.payment.code	string	code used for making payments
responeData.payment.payment_ref	string	Reference number for related payment
responeData.payment.paid_amount	integer	total bill
responeData.payment.fee	integer	administrative fee
responeData.payment.nett	integer	The nominal that must be paid

Response Sample

{
  "responseCode": "2000300",
  "responseMessage": "Invoice Found",
  "responseDate": "2022-04-11T15:27:43+07:00",
  "responseData": {
    "id": "a3ef3f93-7fcb-439a-889e-14976a46492e",
    "ref": "01002676201405,201406,201407,201408,201409,201410",
    "created_at": "2022-04-11 11:41:45",
    "redirect_url": "https://checkout.bmstaging.id/HJHKvf1chmn",
    "back_url": "https://your-invoice-url.com",
    "status": "PAID",
    "customer": {
      "name": "PERM. BUMI CITRA FAJ",
      "email": "[email protected]",
      "phone": "01002676"
    },
    "products": [
      {
        "uuid": "0b81e4b1-a1c7-4d96-985f-b24b7ed80b67",
        "name": "01002676",
        "qty": 1,
        "price": "305300"
      }
    ],
    "payment": {
      "uuid": "6b67178b-0378-4bee-b4ac-87945890ca0f",
      "channel": "BSI",
      "code": "164965211642",
      "payment_ref": "10460",
      "paid_amount": "306300",
      "fee": "1000",
      "nett": "305300",
      "created_at": "2022-04-11T04:43:03.000000Z",
      "updated_at": "2022-04-11T04:43:03.000000Z"
    }
  }
}