Find By Merchant Ref

This API is used to search for invoices based on merchant reference.

Spesification

API Name	Find Invoice By Merchant Ref
Http Method	GET
Path	.../api/findByRef/{merchantRef}

Header

The mandatory header that must be sent during a request is header:

Header	Description
X-Winpay-Timestamp	Transaction date and format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in order GMT+7 (Time Jakarta)
X-Winpay-Signature	Signature generated from the result ofmerchant
X-Winpay-Key	Client key merchant
Content-Type	harus application/json

Response

The following is the body response that will be received:

Parameter	Tipe	Description
responseCode	string	Code respon
responseMessage	string	Message respon
responseDate	date	Date respon
responeData	json element	-
responeData.id	string	Transaction ID related
responeData.ref	string	Transaction reference number
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	Email Customer
responeData.customer.phone	string	Customer Phone Mumber
responeData.products	json element	-
responeData.products[].uuid	string	ID is for transactions related to products
responeData.products[].name	string	Name product
responeData.products[].qty	integer	total product
responeData.products[].price	integer	price product
responeData.payment	json element	-
responeData.payment.uuid	string	ID is for related payments
responeData.payment.channel	string	The channel used for making payments
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"
    }
  }
}