Skip to main content

Get Invoice with Payment

MethodURL
GETapi/v1/bumn/transactions/invoices/[:invoiceNumber]/payment

Request​

TypeParamsValuesDescription
URI PARAM:invoiceNumberstring mandatoryCan be copied from general.invoice_number field

Response​

Success​

StatusPayload
200
{
  "status": "success",
  "data": {
      "meta": {
          "first": "",
          "last": "",
          "limit": 10,
          "next": "",
          "page": 1,
          "prev": "",
          "total_data": 1,
          "total_page": 1
      },
      "payment": [
          {
              "bill_amount": 39500000,
              "due_at": "",
              "invoice_id": "INV-2024-07-05-636380915",
              "paid": false,
              "paid_at": "",
              "payment": {
                  "bank_account": "889089999924847",
                  "bank_holder": "PaDiUMKM Group Corporate Transformation",
                  "bank_name": "Mandiri Virtual Account",
                  "method": "MANDIRI",
                  "method_name": "MANDIRI",
                  "type": "prepaid",
                  "va_number": "889089999924847"
              },
              "purchase_order_number": "PO-2024-07-05-310027145",
              "purchase_request_number": "PR-2024-07-05-41173205",
              "status": {
                  "id": 23,
                  "name": "Menunggu Pembayaran",
                  "sysname": "prepaid-pending-payment"
              },
              "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.payment
  Data Type: ARRAY OF OBJECT
  Payment Data for the current transaction
data.payment.bill_amount
  Data Type: NUMERIC (Float)
data.payment.due_at
  Data Type: STRING (RFC3339)
data.payment.invoice_id
  Data Type: STRING
  Self-explained
data.payment.paid
  Data Type: BOOLEAN
  Paid status
data.payment.paid_at
  Data Type: BOOLEAN
  Paid timestamp
data.payment.payment
  Data Type: OBJECT
  Payment Data for the current transaction
data.payment.payment.bank_account
  Data Type: STRING
data.payment.payment.bank_holder
  Data Type: STRING
data.payment.payment.bank_name
  Data Type: STRING
data.payment.payment.method
  Data Type: STRING
data.payment.payment.menthod_name
  Data Type: STRING
data.payment.payment.type
  Data Type: STRING
data.payment.payment.va_number
  Data Type: STRING
data.payment.purchase_order_number
  Data Type: STRING
  Self-explained
data.payment.purchase_request_number
  Data Type: STRING
  Self-explained
data.payment.status
  Data Type: OBJECT
  Payment status for the current transaction
data.payment.status.id
  Data Type: STRING
  Each ID has a status with the following description:
  | id | slug                     | name                                      |
  | -- | ------------------------ | ----------------------------------------- |
  | 1  | created                  | Pesanan Dibuat                            |
  | 2  | waiting-approval         | Menunggu Persetujuan                      |
  | 3  | approved                 | Disetujui                                 |
  | 4  | rejected                 | Ditolak                                   |
  | 5  | processed                | Diproses Penjual                          |
  | 6  | sent                     | Dikirim                                   |
  | 7  | received                 | Diterima                                  |
  | 8  | paid                     | Dibayar                                   |
  | 9  | canceled                 | Dibatalkan                                |
  | 10 | rejected-by-vendor       | Ditolak Penjual                           |
  | 11 | done                     | Selesai                                   |
  | 12 | revised                  | Revisi                                    |
  | 13 | cc-pending-settlement    | Menunggu Pembayaran Kartu Kredit          |
  | 14 | payment-code-pending     | Menunggu Pembayaran Payment Code          |
  | 15 | expired                  | Expired                                   |
  | 16 | complaint                | Komplain                                  |
  | 17 | complain-resolved        | Komplain Selesai                          |
  | 18 | charged                  | Penagihan                                 |
  | 19 | charge-accepted          | Tagihan Diterima                          |
  | 20 | payment-processed        | Selesai                                   |
  | 21 | payment-verified         | Selesai                                   |
  | 22 | request-receive          | Permintaan Penerimaan                     |
  | 23 | prepaid-pending-payment  | Menunggu Pembayaran (pembayaran langsung) |
  | 24 | postpaid-pending-payment | Menunggu Pembayaran (pembayaran tempo)    |
  | 25 | postpaid-paid            | Dibayar                                   |
  | 26 | payment-expired          | Waktu Pembayaran Habis                    |
  | 27 | refund                   | Refund                                    |
  | 28 | refunded                 | Refund Selesai                            |
  | 29 | charge-rejected          | Tagihan Ditolak                           |
  | 30 | change-requested         | Permintaan Perubahan                      |
  | 31 | change-approved          | Perubahan Diterima                        |
  | 32 | change-rejected          | Perubahan Ditolak                         |
  | 33 | payment-successful       | Pembayaran Berhasil                       |
  | 34 | canceled-automatic       | Dibatalkan Otomatis                       |
  | 35 | document-request         | Permintaan Upload Dokumen                 |
  | 36 | waiting-pickup           | Menunggu Diambil                          |
  | 37 | ready-sent               | Siap Dikirim                              |
  | 38 | on-sent                  | Dalam Pengiriman                          |
  | 39 | waiting-deposited        | Menunggu Disetor                          |
  | 40 | deposited                | Disetor                                   |
  | 41 | service-processed        | Jasa Diproses                             |
  | 42 | service-done             | Jasa Selesai                              |
  | 43 | service-checked          | Jasa Diperiksa                            |
  | 44 | service-received         | Jasa Diterima                             |
  | 45 | sended                   | Terkirim                                  |
  | 46 | refund-failed            | Refund Gagal                              |
  | 47 | overdue                  | Jatuh Tempo                               |
data.payment.status.name
  Data Type: STRING
  Self-explained
data.payment.status.sysname
  Data Type: STRING
  Self-explained
data.payment.vendor
  Data Type: OBJECT
data.payment.vendor.id
  Data Type: STRING
  Seller ID
data.payment.vendor.address
  Data Type: STRING
  Address of the Seller store
data.payment.vendor.city
  Data Type: STRING
  City of the Seller store
data.payment.vendor.district
  Data Type: STRING
  District of the Seller store
data.payment.vendor.name
  Data Type: STRING
  Name of the Seller
data.payment.vendor.province
  Data Type: STRING
  Province of the Seller store
data.payment.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": "invoices 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