Skip to main content

Get Transaction by External Reference

Deskripsi​

API ini digunakan untuk mengambil data transaksi berdasarkan properti eksternal yang digunakan sebagai reference.

MethodURL
GET{{ base_url }}/api/v2/bumn/transactions/reference-number/:reference_number

Request​

TypeParamsValuesDescriptionM/O
QUERY:reference_numberREF-PERTAMINA-XDD546Search transaction data using a reference parameterMandatory

Contoh Request​

GET {{base_url}}/api/v2/bumn/transactions/reference-number/:reference_number

Response​

Success​

StatusPayload
200
{
"status": "success",
"data": {
  "meta": {
    "first": "http://openapi-
    stage.padiumkm.id/api/v2/bumn/transactions?page=1&limit=1",
    "last": "http://openapi-
    stage.padiumkm.id/api/v2/bumn/transactions?page=152399&limit=1",
    "limit": 1,
    "next": "http://openapi-
    stage.padiumkm.id/api/v2/bumn/transactions?page=5&limit=1",
    "page": 4,
    "prev": "http://openapi-
    stage.padiumkm.id/api/v2/bumn/transactions?page=3&limit=1",
    "total_data": 152399,
    "total_page": 152399
  },
  "transaction": [
    {
      "buyer_group": {
        "bumn_id": "62a7079031bfe7a364644273",
        "id": "668765b084ebcf498495e41e",
        "name": "Corcomm Telkom",
        "user_id": "668765b084ebcf498495e41a",
        "user_name": "Best Staf"
      },
      "general": {
        "buyer_name": "Best Staf",
        "entry_date": "2024-07-05T10:32:26+07:00",
        "invoice_number": "INV-2024-07-05-636380915",
        "purchase_order_number": "PO-2024-07-05-
        310027145",
        "purchase_request_number": "PR-2024-07-05-
        41173205",
        "status_change_date": "2024-07-
        05T10:32:26+07:00",
        "status_name": "Menunggu Pembayaran"
      },
      "payment": {
        "bank_holder": "PaDiUMKM Best Staf",
        "bank_name": "Mandiri Virtual Account",
        "bill_amount": 38710000,
        "due_at": null,
        "payment_method": "MANDIRI",
        "payment_term": "",
        "payment_type": "prepaid",
        "pph21": 0,
        "pph22": 0,
        "pph23": 790000,
        "ppn_by": "Pembeli",
        "price_sub_total": 39500000,
        "product_ppn": 4345000,
        "shipping_cost": 0,
        "shipping_cost_pph": 0,
        "shipping_cost_ppn": 0,
        "total_pph": 790000,
        "total_ppn": 4345000,
        "va_number": "889089999924847"
      },
        "vendor": {
        "id": "62a7079031bfe7a364644444",
        "address": "JL.KH.WAHID HASYIM NO.2",
        "city": "Jakarta Pusat",
        "district": "Gambir",
        "name": "KOPEGTEL MEDIATRON",
        "province": "Jakarta",
        "zipcode": "10140",
        "email":"xxxx@gmail.com",
        "nomor_telepon":"081xxxxxx",
        "npwp":"9291389128"
      }
    }
  ]
},
"message": "ok"
}
ParamsDescription
status
  Data Type: STRING
  Status of the request delivered to server.
  Available value:
  * “success”
  * “error”
data
  Data Type: OBJECT
  Data transmitted by response.
data.meta
  Data Type: OBJECT
  Holds information about the result data.
  Currently holds information about pagination of the result
data.meta.first
  Data Type: STRING
  URL link to the first page of the data, i.e: page=1
data.meta.last
  Data Type: STRING
  URL link to the last page of the data
data.meta.limit
  Data Type: INTEGER
  Limit of data per page
data.meta.next
  Data Type: STRING
  URL link to the “NEXT” page of the data
  Empty if this is the last page
data.meta.page
  Data Type: INTEGER
  Current page
data.meta.prev
  Data Type: STRING
  URL link to the “PREVIOUS” page of the data
  Empty if this is the first page
data.meta.total_data
  Data Type: INTEGER
  Total data for the request
data.meta.total_page
  Data Type: INTEGER
  Total page for the request
data.transaction
  Data Type: ARRAY OF OBJECT
data.transaction.buyer_group
  Data Type: OBJECT
  BUMN buyer group
data.transaction.buyer_group.bumn_id
  Data Type: STRING
  Self-explained
data.transaction.buyer_group.id
  Data Type: STRING
  Self-explained
data.transaction.buyer_group.name
  Data Type: STRING
  Self-explained
data.transaction.buyer_group.user_id
  Data Type: STRING
  Self-explained
data.transaction.buyer_group.user_name
  Data Type: STRING
  Self-explained
data.transaction.general
  Data Type: OBJECT
  General transaction data
data.transaction.general.buyer_name
  Data Type: STRING
  Self-explained
data.transaction.general.entry_date
  Data Type: STRING
  Entry date of transaction
data.transaction.general.invoice_number
  Data Type: STRING
  Self-explained
data.transaction.general.purchase_order_number
  Data Type: STRING
  Self-explained
data.transaction.general.purchase_request_number
  Data Type: STRING
  Self-explained
data.transaction.general.status_change_date
  Data Type: STRING
  Date of last status change
data.transaction.general.status_name
  Data Type: STRING
  Current Transaction’s status
data.transaction.payment
  Data Type: OBJECT
  Payment Data for the current transaction
data.transaction.payment.bank_holder
  Data Type: STRING
data.transaction.payment.bank_name
  Data Type: STRING
data.transaction.payment.bill_amount
  Data Type: NUMERIC (Float)
data.transaction.payment.due_at
  Data Type: STRING (RFC3339)
data.transaction.payment.payment_method
  Data Type: STRING
data.transaction.payment.payment_term
  Data Type: STRING
data.transaction.payment.payment_type
  Data Type: STRING
  Available Value: “postpaid”, “prepaid”
data.transaction.payment.pph21
  Data Type: NUMERIC (Float)
data.transaction.payment.pph22
  Data Type: NUMERIC (Float)
data.transaction.payment.pph23
  Data Type: NUMERIC (Float)
data.transaction.payment.ppn_by
  Data Type: STRING
data.transaction.payment.price_sub_total
  Data Type: NUMERIC (Float)
data.transaction.payment.product_ppn
  Data Type: NUMERIC (Float)
data.transaction.payment.shipping_cost
  Data Type: NUMERIC (Float)
data.transaction.payment.shipping_cost_pph
  Data Type: NUMERIC (Float)
data.transaction.payment.shipping_cost_ppn
  Data Type: NUMERIC (Float)
data.transaction.payment.total_pph
  Data Type: NUMERIC (Float)
data.transaction.payment.total_ppn
  Data Type: NUMERIC (Float)
data.transaction.payment.va_number
  Data Type: STRING
data.transaction.vendor
  Data Type: OBJECT
data.transaction.vendor.id
  Data Type: STRING
  Seller ID
data.transaction.vendor.address
  Data Type: STRING
  Address of the Seller store
data.transaction.vendor.city
  Data Type: STRING
  City of the Seller store
data.transaction.vendor.district
  Data Type: STRING
  District of the Seller store
data.transaction.vendor.email
  Data Type: STRING
  Email of Seller
data.transaction.vendor.name
  Data Type: STRING
  Name of the Seller
data.transaction.vendor.npwp
  Data Type: STRING
  NPWP of Seller
data.transaction.vendor.nomor_telepon
  Data Type: STRING
  Telephone of Seller store
data.transaction.vendor.province
  Data Type: STRING
  Province of the Seller store
data.transaction.vendor.zipcode
  Data Type: STRING
  Zipcode of the Seller store
message
  Data Type: STRING
  Description and/or details message of the status.
  Available Value:
  "ok" or some error message by trapped condition

Error​

StatusPayload
404
{
    "status": "error",
    "message": "transactions not found"
}
ParamsDescription
status
  Data Type: STRING

  Status of the request delivered to server.
  Available value:
  * "success"
  * "error"
message
  Data Type: STRING

  Description message for the occurring error