RajaOngkir

https://rajaongkir.com/docs
Admin
RajaOngkir is a shipping and logistics API platform that provides domestic and international...
Tokens:75,515
Snippets:493
Trust Score:8.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### Get Payment Methods - Response Example

Source: https://rajaongkir.com/docs/payment-api/getting-started/available-endpoints

Example JSON response from GET /api/v1/user/methods. Lists available payment methods including Virtual Account banks and QRIS with details like bank code, logo URL, and amount limits.

```json
{
    "meta": {
        "message": "success get payment methods",
        "code": 200,
        "status": "success"
    },
    "data": [
        {
            "payment_type": "va",
            "display_name": "Bank Central Asia",
            "bank_code": "BCA",
            "logo_url": "https://storage.googleapis.com/komerce/assets/logo/bca.png",
            "min_amount": 10000,
            "max_amount": 999999999999,
            "currency": "IDR"
        },
        {
            "payment_type": "qris",
            "display_name": "QRIS",
            "bank_code": "",
            "logo_url": "https://storage.googleapis.com/komerce/assets/logo/qris.png",
            "min_amount": 10000,
            "max_amount": 10000000,
            "currency": "IDR"
        }
    ]
}
```

--------------------------------

### cURL request with API key

Source: https://rajaongkir.com/docs/delivery-order-api/getting_started/api-key

Example GET request to the sandbox endpoint with the x-api-key header. Returns the list of available couriers for your delivery orders.

```bash
curl --request GET \
  --url https://api-sandbox.collaborator.komerce.id
  --header 'x-api-key: YOUR_API_KEY'
```

--------------------------------

### Example Request with cURL

Source: https://rajaongkir.com/docs/payment-api/getting-started/authentication

Example cURL request to the sandbox endpoint for user methods, including the x-api-key header.

```bash
curl --location 'https://api-sandbox.collaborator.komerce.id/user/api/v1/user/methods' \
--header 'x-api-key: YOUR_API_KEY'
```

--------------------------------

### Get Payment Status - cURL Request Example

Source: https://rajaongkir.com/docs/payment-api/getting-started/available-endpoints

Example cURL command to GET /api/v1/user/payment/status/{payment_id} with x-api-key header. Use to check payment status; returns values like PENDING, PAID, EXPIRED, CANCELED.

```bash
curl --location 'https://api-sandbox.collaborator.komerce.id/user/api/v1/user/payment/status/{payment_id}' \
--header 'x-api-key: YOUR_API_KEY'
```

--------------------------------

### Example Request with Authentication (curl)

Source: https://rajaongkir.com/docs/qrisly/getting-started/authentication

Example curl request to the QRISLY generate-qris endpoint, including the x-api-key header and JSON payload. Replace 'your-api-key' with your actual key.

```bash
curl --location 'https://api-sandbox.collaborator.komerce.id/user/api/v1/qrisly/generate-qris' \
--header 'x-api-key: your-api-key' \
--header 'Content-Type: application/json' \
--data '{
    "qris_id": 18,
    "amount": 1000,
    "output_type": "string",
}'
```

--------------------------------

### Upload QRIS Request Example (curl)

Source: https://rajaongkir.com/docs/qrisly/getting-started/available-endpoints

Example curl command to upload a QRIS image. Uses X-API-Key header and form fields name and qris_image.

```bash
curl -X POST "https://api-sandbox.collaborator.komerce.id/user/api/v1/qrisly/upload-qris" \
  -H "X-API-Key: your_api_key_here" \
  -F "name=ABC Online Store" \
  -F "qris_image=@/path/to/qris.png"
```

--------------------------------

### Generate QRIS Request Example (curl)

Source: https://rajaongkir.com/docs/qrisly/getting-started/available-endpoints

Example curl command to generate a QRIS. Uses JSON body with qris_id, amount, output_type, and unique_amount.

```bash
curl -X POST "https://api-sandbox.collaborator.komerce.id/user/api/v1/qrisly/generate-qris" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key_here" \
  -d '{
    "qris_id": 123,
    "amount": 100000,
    "output_type": "string",
    "unique_amount": true
  }'
```

--------------------------------

### Success response for get order label

Source: https://rajaongkir.com/docs/delivery-order-api/label_order

Example of a successful response with HTTP 200. The data.path indicates the label storage location, and data.base_64 contains the binary code for the label file. To download the file, add the /order path before the storage path.

```json
{
    "meta": {
        "message": "Generate Print Label success",
        "code": 200,
        "status": "success"
    },
    "data": {
        "path": "/storage/label-DD-MM-YYY-00-00-00000000000.pdf",
        "base_64": "{{ long_base_64 }}
    }
}
```

--------------------------------

### Create Payment - QRIS - Request Body Example

Source: https://rajaongkir.com/docs/payment-api/getting-started/available-endpoints

Example JSON request body for POST /api/v1/user/payment/create to create a QRIS payment. Similar to VA but without channel_code, with fixed 5-minute expiration and returns qr_string.

```json
{
    "order_id": "KOM12345",
    "payment_type": "qris",
    "amount": 100000,
    "customer": {
        "name": "John Doe",
        "email": "john@example.com",
        "phone": "081234567890"
    },
    "items": [
        {
            "name": "Product A",
            "quantity": 2,
            "price": 50000
        }
    ],
    "callback_url": "https://yoursite.com/callback",
    "callback_API_KEY": "your-generated-key"
}
```

--------------------------------

### Create Payment - Virtual Account - Request Body Example

Source: https://rajaongkir.com/docs/payment-api/getting-started/available-endpoints

Example JSON request body for POST /api/v1/user/payment/create to create a Virtual Account payment. Includes order_id, payment_type 'bank_transfer', channel_code, amount, customer details, items, expiry_duration, and callback settings.

```json
{
    "order_id": "KOM12345",
    "payment_type": "bank_transfer",
    "channel_code": "BCA",
    "amount": 100000,
    "customer": {
        "name": "John Doe",
        "email": "john@example.com",
        "phone": "081234567890"
    },
    "items": [
        {
            "name": "Product A",
            "quantity": 2,
            "price": 50000
        }
    ],
    "expiry_duration": 3600,
    "callback_url": "https://yoursite.com/callback",
    "callback_API_KEY": "your-generated-key"
}
```

--------------------------------

### Error Response Example for Payment Status

Source: https://rajaongkir.com/docs/qrisly/getting-started/available-endpoints

Example error response when payment history is not found. Returns a 404 status with error message.

```json
{
  "meta": {
    "message": "Payment history not found",
    "code": 404,
    "status": "error"
  },
  "data": null
}
```

--------------------------------

### POST /api/v1/qrisly/upload-qris

Source: https://rajaongkir.com/docs/qrisly/getting-started/flow-overview-page

Uploads a QRIS image to the platform. This is a one-time setup step.

```APIDOC
## POST /api/v1/qrisly/upload-qris

### Description
Uploads a QRIS image to the platform. This is a one-time setup step.

### Method
POST

### Endpoint
/api/v1/qrisly/upload-qris

### Parameters
#### Request Body
- **File** (file) - Required - QRIS image (PNG/JPG)
- **Name** (string) - Required - Identity of your QRIS

### Request Example
```
POST /api/v1/qrisly/upload-qris
- File: QRIS image (PNG/JPG)
- Name: Identity of your QRIS
```

### Response
#### Success Response (200)
- **qris_id** (string) - Unique identifier for the uploaded QRIS
- **name** (string) - The name provided for the QRIS
- **merchant_name** (string) - Name of the merchant

#### Response Example
```json
{
  "qris_id": "9d6c9f9e-8c33-4f42-8b1f-0e6a3e2e7d10",
  "name": "abc",
  "merchant_name": "YZ Digital"
}
```
```

--------------------------------

### Unique Amount Example

Source: https://rajaongkir.com/docs/qrisly/getting-started/available-endpoints

Example showing how unique_amount increments the amount for each request. When requesting IDR 10,000 repeatedly, the response amounts become 10,001, 10,002, 10,003.

```text
Original Amount Requested: IDR 10,000
Response with unique_amount: true: IDR 10,001

If you request IDR 10,000 again:
First request:  IDR 10,000 → IDR 10,001
Second request: IDR 10,000 → IDR 10,002
Third request:  IDR 10,000 → IDR 10,003
```

--------------------------------

### GET /methods

Source: https://rajaongkir.com/docs/payment-api/getting-started/endpoint

Retrieve payment methods and bank codes.

```APIDOC
## GET /methods

### Description
Retrieve payment methods and Banks Code.

### Method
GET

### Endpoint
/methods

### Parameters
None

### Response
#### Success Response (200)
- **payment_methods** (array) - List of available payment methods and bank codes.

#### Response Example
{
  "payment_methods": []
}
```

--------------------------------

### Create Transaction cURL Example

Source: https://rajaongkir.com/docs/payment-api/getting-started/endpoint

Example cURL command to create a new payment transaction. Uses the sandbox base URL and requires a valid API key. The request body includes required fields like order_id, payment_type, channel_code, amount, customer, and items, with optional fields for expiry_duration, callback_url, and callback_api_key.

```bash
curl --location 'https://api-sandbox.collaborator.komerce.id/user/api/v1/user/payment/create' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"order_id": (required),
"payment_type": "bank_transfer",
"channel_code": string (required, valid bank code),
"amount": integer (required, min 10.000),
"customer": {
"name": string (required),
"email": string (required, valid email),
"phone": string (required)
},
"items": [
{
  "name": string (required),
  "quantity": integer (required),
  "price": integer (required)
}
],
"expiry_duration": integer (optional, minimal 3600 seconds),
"callback_url": string (optional, valid URL),
"callback_api_key": (required if callback_url is filled, generate by user)
}'
```

--------------------------------

### Error response for get order label

Source: https://rajaongkir.com/docs/delivery-order-api/label_order

Example of an error response when the order number is not found. The meta.code is 500 and the data field contains the error message 'order_no not found'.

```json
{
  "meta": {
    "message": "Generate Print Label failed",
    "code": 500,
    "status": "error"
  },
  "data": "order_no not found"
}
```

--------------------------------

### Authorization Header Example

Source: https://rajaongkir.com/docs/payment-api/getting-started/endpoint

Shows the required headers for authenticating with the Payment API. Include your API key from the Merchant Dashboard. Never expose your API key in client-side code or public repositories.

```bash
-H "x-api-key: YOUR_API_KEY"
-H "Content-Type: application/json"
```

--------------------------------

### 200 response for Search City endpoint

Source: https://rajaongkir.com/docs/shipping-cost/endpoint-rajaongkir-for-form-base-calculate-cost/search_city

Example successful response with a list of cities, each containing id, name, and zip_code. The meta message says 'Success Get District By City ID'.

```json
{
  "meta": {
    "message": "Success Get District By City ID",
    "code": 200,
    "status": "success"
  },
  "data": [
    {
      "id": 1360,
      "name": "JAKARTA SELATAN",
      "zip_code": "0"
    },
    {
      "id": 1361,
      "name": "JAGAKARSA",
      "zip_code": "12630"
    },
    {
      "id": 1362,
      "name": "KEBAYORAN BARU",
      "zip_code": "12150"
    },
    {
      "id": 1363,
      "name": "KEBAYORAN LAMA",
      "zip_code": "12230"
    },
    {
      "id": 1364,
      "name": "MAMPANG PRAPATAN",
      "zip_code": "12730"
    },
    {
      "id": 1365,
      "name": "PANCORAN",
      "zip_code": "12770"
    },
    {
      "id": 1366,
      "name": "PASAR MINGGU",
      "zip_code": "12560"
    },
    {
      "id": 1367,
      "name": "PESANGGRAHAN",
      "zip_code": "12330"
    },
    {
      "id": 1368,
      "name": "SETIA BUDI",
      "zip_code": "12980"
    },
    {
      "id": 1369,
      "name": "TEBET",
      "zip_code": "12840"
    },
    {
      "id": 1370,
      "name": "CILANDAK",
      "zip_code": "12430"
    }
  ]
}
```

--------------------------------

### cURL request to /history-airway-bill

Source: https://rajaongkir.com/docs/delivery-order-api/history_awb

Sends a GET request to the history-airway-bill endpoint with the courier and AWB number as query parameters. Requires the x-api-key header. The example uses the sandbox URL and placeholder values.

```cURL
curl --location 'https://api-sandbox.collaborator.komerce.id/order/api/v1/orders/history-airway-bill?shipping={{courier}}&airway_bill=KOMERKOMXXXXXXXXXXXXXXXXX' \
  --header 'x-api-key: inputapikey'
```

--------------------------------

### GET /order/api/v1/orders/detail

Source: https://rajaongkir.com/docs/delivery-order-api/getting_started/base-url

Get more information about a submitted order.

```APIDOC
## [GET] /order/api/v1/orders/detail

### Description
Get more information about a submitted order.

### Method
GET

### Endpoint
/order/api/v1/orders/detail

```

--------------------------------

### Error Response for Creating an Order (example.json)

Source: https://rajaongkir.com/docs/delivery-order-api/Store_order/store_order

Example of an error response when creating an order. The response includes a meta object with an error message placeholder, HTTP status code 400, and status 'failed', with data set to null.

```json
{
  "meta": {
    "message": "{{ error.message }}",
    "code": 400,
    "status": "failed"
  },
  "data": null
}
```

--------------------------------

### cURL Request for Store Order API

Source: https://rajaongkir.com/docs/delivery-order-api/Store_order/store_order

Example cURL command to create a store order. Uses the sandbox endpoint and requires an API key in the x-api-key header. The JSON body includes order details, shipping information, and product items.

```bash
curl --location 'https://api-sandbox.collaborator.komerce.id/order/api/v1/orders/store' \
--header 'x-api-key: inputapikey' \
--header 'Content-Type: application/json' \
--data-raw '{
    "order_date": "2025-05-21",
    "brand_name": "Xiaomi Official",
    "shipper_name": "XIAOMI",
    "shipper_phone": "0853123413241",
    "shipper_destination_id": 5969,
    "shipper_address": "Alamat pengirim",
    "origin_pin_point": "-7.274631, 109.207174",
    "receiver_name": "Buyer Bandung",
    "receiver_phone": "08123458282",
    "receiver_destination_id": 4956,
    "receiver_address": "Alamat penerima",
    "shipper_email": "admin@admin.com",
    "destination_pin_point": "-7.274631, 109.207174",
    "shipping": "JNE",
    "shipping_type": "REG23",
    "payment_method": "BANK TRANSFER",
    "shipping_cost": 16000,
    "shipping_cashback": 4000,
    "service_fee": 0,
    "additional_cost": 0,
    "grand_total": 516000,
    "cod_value": 0,
    "insurance_value": 5631.11,
    "notes": "Contoh note"
    "order_details": [
        {
            "product_name": "Xiaomi Redmi Note 99",
            "product_variant_name": "Blue 8/256",
            "product_price": 315555,
            "product_weight": 1000,
            "product_width": 10,
            "product_height": 8,
            "product_length": 50,
            "qty": 1,
            "subtotal": 315555
        }
    ]
}'
```

--------------------------------

### GET /api/v1/user/methods

Source: https://rajaongkir.com/docs/payment-api/getting-started/available-endpoints

Retrieve a list of available payment methods including Virtual Account banks and QRIS. Use this to display payment options to customers during checkout.

```APIDOC
## GET /api/v1/user/methods

### Description
Retrieve a list of available payment methods including Virtual Account banks and QRIS.

### Method
GET

### Endpoint
/api/v1/user/methods

### Authentication
Required (API Key in header)

### Response
#### Success Response (200)
- **meta.message** (string) - Success message
- **meta.code** (integer) - HTTP status code
- **meta.status** (string) - Status indicator
- **data** (array) - List of payment methods
  - **payment_type** (string) - Type of payment (e.g., "va", "qris")
  - **display_name** (string) - Display name of the payment method
  - **bank_code** (string) - Bank code (empty for QRIS)
  - **logo_url** (string) - URL to the payment method logo
  - **min_amount** (integer) - Minimum transaction amount
  - **max_amount** (integer) - Maximum transaction amount
  - **currency** (string) - Currency code (e.g., "IDR")

#### Response Example
{
  "meta": {
    "message": "success get payment methods",
    "code": 200,
    "status": "success"
  },
  "data": [
    {
      "payment_type": "va",
      "display_name": "Bank Central Asia",
      "bank_code": "BCA",
      "logo_url": "https://storage.googleapis.com/komerce/assets/logo/bca.png",
      "min_amount": 10000,
      "max_amount": 999999999999,
      "currency": "IDR"
    },
    {
      "payment_type": "qris",
      "display_name": "QRIS",
      "bank_code": "",
      "logo_url": "https://storage.googleapis.com/komerce/assets/logo/qris.png",
      "min_amount": 10000,
      "max_amount": 10000000,
      "currency": "IDR"
    }
  ]
}
```

--------------------------------

### Step-by-Step Method: Get List of Provinces

Source: https://rajaongkir.com/docs/shipping-cost/getting_started/about

Use this curl command to retrieve the list of provinces via the Step-by-Step method. Replace YOUR_API_KEY with your generated API key.

```bash
# Get list of provinces first
curl --location 'https://rajaongkir.komerce.id/api/v1/destination/province' \
--header 'key: YOUR_API_KEY'
```

--------------------------------

### POST /order/api/v1/orders/print-label

Source: https://rajaongkir.com/docs/delivery-order-api/getting_started/base-url

Get a label for an order.

```APIDOC
## [POST] /order/api/v1/orders/print-label

### Description
Get a label for an order.

### Method
POST

### Endpoint
/order/api/v1/orders/print-label

```

--------------------------------

### GET /order/api/v1/orders/history-airway-bill

Source: https://rajaongkir.com/docs/delivery-order-api/getting_started/base-url

Check tracking AWB.

```APIDOC
## [GET] /order/api/v1/orders/history-airway-bill

### Description
Check tracking AWB.

### Method
GET

### Endpoint
/order/api/v1/orders/history-airway-bill

```

--------------------------------

### Create Order - Success Response

Source: https://rajaongkir.com/docs/delivery-order-api/Store_order/store_order

Example of a successful response when creating an order, including meta information and order data.

```APIDOC
## Create Order - Success Response

### Description
Example of a successful response when creating an order.

### Response
#### Success Response (201)
- **meta.message** (string) - Success message.
- **meta.code** (integer) - HTTP status code.
- **meta.status** (string) - Status indicator (success).
- **data.order_id** (integer) - Unique order ID.
- **data.order_no** (string) - Unique order number.

#### Response Example
```json
{
  "meta": {
    "message": "Success Create New Order",
    "code": 201,
    "status": "success"
  },
  "data": {
    "order_id": 9999,
    "order_no": "KOMXXXXXXXXXXXXXXXXX"
  }
}
```
```

--------------------------------

### Best Practices

Source: https://rajaongkir.com/docs/payment-api/getting-started/available-endpoints

Best practices for using the payment API, including payment flow recommendations, callback implementation, environment usage, and rate limiting.

```APIDOC
## Best Practices

### Secure Your API Key
- Never share your key publicly or include it in client-side code
- Use environment variables to store your API key securely

### Payment Flow Recommendations
1. **Checkout Page** : Call `GET /api/v1/user/methods` to display payment options
2. **Create Payment** : Call `POST /api/v1/user/payment/create` when customer selects payment method
3. **Status Monitoring** : Use `GET /api/v1/user/payment/status/` to check payment completion
4. **Order Cancellation** : Call `POST /api/v1/user/payment/cancel` if order is canceled before payment

### Callback Implementation
- Always provide `callback_url` for real-time payment notifications
- Secure your callback endpoint with `callback_API_KEY`
- Verify the authenticity of callback requests

### Environment Usage
**Development/Testing** : Use sandbox environment
- Simulate payment status updates
- No real transactions

**Production** : Use production environment
- Real payment processing
- Actual money transfer

### Rate Limiting
- Status check: Maximum 1 request per 3 seconds per payment_id
- Implement proper retry mechanisms with exponential backoff

```

--------------------------------

### GET /tariff/api/v1/destination/

Source: https://rajaongkir.com/docs/delivery-order-api/getting_started/base-url

Search for origin or destination ID.

```APIDOC
## [GET] /tariff/api/v1/destination/

### Description
Search for origin or destination `id`.

### Method
GET

### Endpoint
/tariff/api/v1/destination/

```

--------------------------------

### Tips to Avoid Errors

Source: https://rajaongkir.com/docs/delivery-order-api/Store_order/store_order

Best practices to avoid errors when creating an order.

```APIDOC
## Tips to Avoid Errors

### Description
Best practices to avoid errors when creating an order.

### Tips
1. Always include the Authorization header with a valid token.
2. Do not leave any parameter empty - it's required.
3. Make sure all parameters use correct values.
4. Use the correct endpoint and query structure.
```

--------------------------------

### curl Request to Retrieve Couriers in Production

Source: https://rajaongkir.com/docs/delivery-order-api/getting_started/base-url

Sample curl request to retrieve the list of available couriers in the production environment. Replace YOUR_PRODUCTION_KEY with a valid production API key.

```bash
curl --request GET \
  --url https://api.collaborator.komerce.id/
  --header 'x-api-key: YOUR_PRODUCTION_KEY'
```
Tokens:
Raw