Midtrans Payment Gateway

DealPOS API (3.1.0)

Welcome Developer

This page lists the reference documentation for DealPOS APIs. For guides and tutorials.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL https://www.dealpos.com
Customer Support info@dealpos.com
License
Languages
Servers
Production Server
https://{subdomain}/api/v3/

Token

Operations related to authentication tokens

Operations

Category

Operations related to category, including create, get, etc

Operations

Product

Operations related to product, including create, get, etc

Operations

Variant

Operations related to variant, including create, get, etc

Operations

Serial

Operation related to Serial product type

Operations

Estimate

Operations related to estimate, including create, get, etc

Operations

Sales Order

Operations related to sales order, including create, get, etc

Operations

Invoice

Operations related to invoice, including create, get, etc

Operations

Shift

Operation related to shift, including create, get, etc

Operations

Report

Operations related to report page, including create, get, etc

Operations

Customer

Operations related to customer data, including create, get, etc

Operations

Comment

Operations related to comment (Contact Feedback), including create, get, etc

Operations

Supplier

Operations related to supplier data, including create, get, etc

Operations

Invoice Payment

Operations related to invoice payment, including create, get, etc

Operations

Bill Payment

Operations related to bill payment, including create, get, etc

Operations

Invoice Write Off

Operations related to invoice write off, including create, get, etc

Operations

Inventory

Operations related to inventory, including create, get, etc

Operations

Inventory Log

Operations related to inventory log, including create, get, etc

Operations

Inventory Adjustment

Operations related to inventory adjustment, including create, get, etc

Operations

Bill

Operations related to bill, including create, get, etc

Operations

OutboundLogistic

Operations related to outbound logistic, including create, get, etc

Operations

InboundLogistic

Operations related to inbound logistic, including create, get, etc

Operations

TransferOrder

Operations related to transfer order, including create, get, etc

Operations

Picklist

Operations related to picklist, including create, get, etc

Operations

Prepaid Package

Operations related to prepaid package, including create, get, etc

Operations

Promotion Coupon

Operations related to promotion coupon, including create, get, etc

Operations

Promotion Event

Operations related to promotion event, including create, get, etc

Operations

Outlet

Operations related to outlet, including create, get, etc

Operations

Outlet Price

Operations related to outlet price, including create, get, etc

Operations

Loyalty Point

Operations related to loyalty point, including create, get, etc

Operations

Notification

Operations related to notification, including create, get, etc

Operations

Payment Method

Operations related to payment method, including create, get, etc

Operations

Invoice Write Off Option

Operations related to invoice write off option, including create, get, etc

Operations

Tax

Operations related to tax, including create, get, etc

Operations

Logistics Service

Operations related to logistics service, including create, get, etc

Operations

Midtrans Payment Gateway

Operations related to Midtrans Payment Gateway, including create, get, etc

Operations

Generate QRIS

Request

Generate QRIS for specified Invoice When the QR has been paid, an Invoice Payment is automatically added to the Invoice

Note:
If you require custom amount for your QR you can also directly use Midtrans API https://docs.midtrans.com/reference/qris

Bodyapplication/json
Outletstring

Outlet Name

Numberstring

Invoice Number

NotificationURLstring

Notification sent from our server after the QR has been paid (Coming Soon)

curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Payment/Midtrans/Charge \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Pluit",
    "Number": "2023.09.00001",
    "NotificationURL": "https://domain.com/api/paymentnotification/gopay"
  }'

Responses

OK

Bodyapplication/json
Transaction_idstring
Urlstring
Response
application/json
{
  "Transaction_id": "260b81c6-8244-404e-97a7-91ed24cbf58d",
  "Url": "https://api.midtrans.com/v2/qris/260b81c6-8244-404e-97a7-91ed24cbf58d/qr-code"
}

Get Transaction Status

Request

Wrapper for https://docs.midtrans.com/reference/get-transaction-status https://docs.midtrans.com/reference/get-transaction-status

Bodyapplication/json
Transaction_idstring
Example: "260b81c6-8244-404e-97a7-91ed24cbf58d"
curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Payment/Midtrans/Status \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Transaction_id": "260b81c6-8244-404e-97a7-91ed24cbf58d"
  }'

Responses

OK

Bodyapplication/json
transaction_typestring
Example: "off-us"
transaction_timestring
Example: "2023-08-31 10:53:59"
transaction_statusstring
Example: "settlement"
transaction_idstring
Example: "4c4f9fc0-abdf-4242-a2d5-9c90437d0dbd"
status_messagestring
Example: "midtrans payment notification"
status_codestring
Example: 200
signature_keystring
Example: "a2515dad47fc2c00b01f14995d6d603843857b77de9786ca91eb0c7743728968d0ebca1b4bccd455b57c36594e0cebf3524a960cb000a6ec90153cc2c1ec27ec"
settlement_timestring
Example: "2023-08-31 10:54:10"
payment_typestring
Example: "qris"
order_idstring
Example: "23.08.00030"
merchant_idstring
Example: "G668581401"
issuerstring
Example: "DANA"
gross_amountstring
Example: 1000
fraud_statusstring
Example: "accept"
expiry_timestring
Example: "2023-08-31 11:08:59"
custom_field2string
Example: "nelsenlim.dealpos.net"
custom_field1string
Example: "410ba2b7-8eff-4759-b5f1-cf47b33ef1cc"
currencystring
Example: "IDR"
acquirerstring
Example: "gopay"
Response
application/json
{
  "transaction_type": "off-us",
  "transaction_time": "2023-08-31 10:53:59",
  "transaction_status": "settlement",
  "transaction_id": "4c4f9fc0-abdf-4242-a2d5-9c90437d0dbd",
  "status_message": "midtrans payment notification",
  "status_code": 200,
  "signature_key": "a2515dad47fc2c00b01f14995d6d603843857b77de9786ca91eb0c7743728968d0ebca1b4bccd455b57c36594e0cebf3524a960cb000a6ec90153cc2c1ec27ec",
  "settlement_time": "2023-08-31 10:54:10",
  "payment_type": "qris",
  "order_id": "23.08.00030",
  "merchant_id": "G668581401",
  "issuer": "DANA",
  "gross_amount": 1000,
  "fraud_status": "accept",
  "expiry_time": "2023-08-31 11:08:59",
  "custom_field2": "nelsenlim.dealpos.net",
  "custom_field1": "410ba2b7-8eff-4759-b5f1-cf47b33ef1cc",
  "currency": "IDR",
  "acquirer": "gopay"
}

Apps

Operations related to Apps, including create, get, etc

Operations

Barcode

Operations related to barcode, including create, get, etc

Operations

Client Secret

Operations related to client secret, including create, get, etc

Operations

Rate Limit

Operations related to rate limit, including create, get, etc

Operations

Deprecated API

Operations