Skip to main content
POST
/
v3
/
orders
/
{id}
/
check-payment
Check order payment status
curl --request POST \
  --url https://api.myscalev.com/v3/orders/{id}/check-payment \
  --header 'Authorization: Bearer <token>'
{
  "gross_revenue_for_dropshipper": "<string>",
  "advertiser": {
    "aff_code": "<string>",
    "avatar": "<string>",
    "email": "jsmith@example.com",
    "fullname": "<string>",
    "id": 123,
    "phone": "<string>"
  },
  "cogs": "<string>",
  "dropshipper_name": "<string>",
  "transferproof_url": "<string>",
  "scalev_fee": "<string>",
  "shipment_status_history": [
    {
      "description": "<string>",
      "status": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "timestamp_source": "<string>"
    }
  ],
  "discount_code_code": "<string>",
  "ready_time": "2023-11-07T05:31:56Z",
  "warehouse": {
    "business": {
      "account_holder": "<string>",
      "email": "jsmith@example.com",
      "id": 123,
      "is_banned": true,
      "logo": "<string>",
      "unique_id": "<string>",
      "username": "<string>"
    },
    "contact_name": "<string>",
    "contact_phone": "<string>",
    "id": 123,
    "name": "<string>"
  },
  "payment_fee_rate": "<string>",
  "pg_paid_info": {},
  "transfer_time": "2023-11-07T05:31:56Z",
  "dropshipper_phone": "<string>",
  "shipping_cost": "<string>",
  "product_price": "<string>",
  "total_quantity": 123,
  "net_revenue": "<string>",
  "bundle_price_options": {},
  "customer": {
    "confirmed_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "email": "jsmith@example.com",
    "id": 123,
    "last_updated_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "phone": "<string>",
    "status": "<string>"
  },
  "variants": {},
  "chat_message": "<string>",
  "handler_phone": "<string>",
  "business": {
    "account_holder": "<string>",
    "email": "jsmith@example.com",
    "id": 123,
    "is_banned": true,
    "logo": "<string>",
    "unique_id": "<string>",
    "username": "<string>"
  },
  "order_emails": [
    {
      "from": "<string>",
      "id": 123,
      "inserted_at": "2023-11-07T05:31:56Z",
      "message_id": "<string>",
      "order_id": 123,
      "status": "<string>",
      "status_history": [
        {
          "status": "<string>",
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ],
      "subject": "<string>",
      "to": "<string>",
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "order_id": "<string>",
  "product_discount": "<string>",
  "last_updated_by": {
    "aff_code": "<string>",
    "avatar": "<string>",
    "email": "jsmith@example.com",
    "fullname": "<string>",
    "id": 123,
    "phone": "<string>"
  },
  "handler": {
    "aff_code": "<string>",
    "avatar": "<string>",
    "email": "jsmith@example.com",
    "fullname": "<string>",
    "id": 123,
    "phone": "<string>"
  },
  "payment_account_number": "<string>",
  "payment_method": "va",
  "courier": 123,
  "origin_address": {
    "address": "<string>",
    "city": "<string>",
    "id": 123,
    "location": 123,
    "location_id": 123,
    "postal_code": "<string>",
    "province": "<string>",
    "subdistrict": "<string>",
    "warehouse": 123
  },
  "epayment_provider": "<string>",
  "in_process_time": "2023-11-07T05:31:56Z",
  "pg_reference_id": "<string>",
  "weight_bump": "<string>",
  "follow_up_chat_type": "<string>",
  "awb_status": "unavailable",
  "platform": "<string>",
  "follow_up_chats": [
    {
      "bundle_id": 123,
      "change_status": true,
      "hours_after": 123,
      "id": 123,
      "image": "<string>",
      "is_default": true,
      "name": "<string>",
      "product_id": 123,
      "provider": "<string>",
      "store_id": 123,
      "trigger": "<string>"
    }
  ],
  "is_purchase_kwai": true,
  "shipping_discount": "<string>",
  "conflict_time": "2023-11-07T05:31:56Z",
  "paid_time": "2023-11-07T05:31:56Z",
  "confirmed_time": "2023-11-07T05:31:56Z",
  "canceled_time": "2023-11-07T05:31:56Z",
  "status": "draft",
  "is_dropshipping": true,
  "payment_account_id": 123,
  "is_repeat": true,
  "tiktok_pixel_ids": [
    "<string>"
  ],
  "fb_pixel_ids": [
    "<string>"
  ],
  "id": 123,
  "unpaid_time": "2023-11-07T05:31:56Z",
  "is_purchase_tiktok": true,
  "orderlines": [
    {
      "cogs": 123,
      "variant_reseller_price_bt": 123,
      "inserted_at": "2023-10-01T12:00:00Z",
      "product_price": 123,
      "variant_price_bt": 123,
      "variant_cogs": 123,
      "is_inventory": true,
      "discount": 123,
      "product_business": 123,
      "product_name": "<string>",
      "variant_reseller_price": 123,
      "variant_sku": "<string>",
      "item_type": "physical",
      "discount_bt": 123,
      "pricing_type": "one_time",
      "variant_option1_value": "<string>",
      "id": 123,
      "cogs_bt": 123,
      "discount_rate": 123,
      "currency": "IDR",
      "quantity": 123,
      "variant_price": 123,
      "weight": 123,
      "discount_code_discount": 123,
      "variant": 123,
      "variant_cogs_bt": 123,
      "variant_option2_value": "<string>",
      "reseller_product_price_bt": 123,
      "interval_count": 123,
      "discount_code_discount_bt": 123,
      "tax_rate": 123,
      "product_price_bt": 123,
      "reseller_product_price": 123,
      "variant_option3_value": "<string>",
      "interval": "day"
    }
  ],
  "shipment_status": "<string>",
  "kwai_pixel_ids": [
    "<string>"
  ],
  "cogs_bt": "<string>",
  "sub_payment_method": "BCA",
  "payment_fee": "<string>",
  "channel_name": "<string>",
  "discount_rate": "<string>",
  "final_variants": {},
  "other_income_name": "<string>",
  "gross_revenue": "<string>",
  "tags": [
    "<string>"
  ],
  "discount_code_id": 123,
  "other_income": "<string>",
  "status_history": [
    {
      "by": "<string>",
      "status": "draft",
      "time": "2023-11-07T05:31:56Z"
    }
  ],
  "total_weight": "<string>",
  "is_probably_spam": true,
  "external_id": "<string>",
  "payment_status_history": [
    {
      "by": "<string>",
      "status": "draft",
      "time": "2023-11-07T05:31:56Z"
    }
  ],
  "discount_code_discount": "<string>",
  "product_discount_bt": "<string>",
  "store": {
    "is_unique_code": true,
    "is_postal_code": true,
    "is_discount_editable": true,
    "store_method_other_incomes": [
      {
        "payment_method": "<string>",
        "type": "fixed",
        "amount": 123,
        "percentage": 123,
        "sub_payment_method": "<string>"
      }
    ],
    "store_courier_other_incomes": [
      {
        "courier_id": 123,
        "type": "fixed",
        "amount": 123,
        "percentage": 123
      }
    ],
    "dynamic_other_income_cod_default_percentage": 123,
    "dynamic_other_income_epayment_type": "fixed",
    "chatbot_system_prompt": "<string>",
    "dynamic_other_income_cod_default_amount": 123,
    "business": {
      "account_holder": "<string>",
      "email": "jsmith@example.com",
      "id": 123,
      "is_banned": true,
      "logo": "<string>",
      "unique_id": "<string>",
      "username": "<string>"
    },
    "uuid": "<string>",
    "non_cod_purchase_triggers": [
      "public_upload"
    ],
    "is_dropshipping_allowed": true,
    "cod_purchase_triggers": [
      "public_upload"
    ],
    "is_use_waba": true,
    "postal_code_requirement": "autofill",
    "name": "<string>",
    "id": 123,
    "is_moota_enabled": true,
    "sub_payment_methods": [
      "BCA"
    ],
    "unique_id": "<string>",
    "other_income_name": "<string>",
    "auto_expire_days": 123,
    "max_unique_code_amount": 123,
    "is_auto_expire": true,
    "dynamic_other_income_epayment_default_amount": 123,
    "is_transferproof_required": true,
    "fixed_auto_other_income": true,
    "auto_other_income": true,
    "capi_purchase_value_type": "gross_revenue",
    "is_active": true,
    "dynamic_other_income_epayment_default_percentage": 123,
    "dynamic_other_income_cod_type": "fixed"
  },
  "pg_payment_info": {},
  "other_income_bt": "<string>",
  "courier_service": {
    "code": "<string>",
    "code_co": "<string>",
    "code_ka": "<string>",
    "code_lincah": "<string>",
    "code_mengantar": "<string>",
    "code_ro": "<string>",
    "courier": {
      "code": "<string>",
      "code_ka": "<string>",
      "code_lincah": "<string>",
      "code_mengantar": "<string>",
      "code_ro": "<string>",
      "courier_type": "delivery",
      "id": 123,
      "is_pickup": true,
      "name": "<string>"
    },
    "id": 123,
    "name": "<string>"
  },
  "mark_as_spam_by": "<string>",
  "net_payment_revenue": "<string>",
  "rts_time": "2023-11-07T05:31:56Z",
  "min_payment_fee": "<string>",
  "analytics_purchases": [
    {
      "id": 123,
      "inserted_at": "2023-11-07T05:31:56Z",
      "order_id": 123,
      "payload": {},
      "pixel_id": "<string>",
      "platform": "<string>",
      "response": {},
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "is_from_form": true,
  "secret_slug": "<string>",
  "agent_context": {},
  "shipping_fee": "<string>",
  "tax_rate": 123,
  "draft_time": "2023-11-07T05:31:56Z",
  "last_updated_at": "2023-11-07T05:31:56Z",
  "courier_additional_info": "<string>",
  "closed_time": "2023-11-07T05:31:56Z",
  "financial_entity": {
    "code": "<string>",
    "duitku_code": "<string>",
    "entity_type": "<string>",
    "id": 123,
    "name": "<string>",
    "platform": "<string>",
    "xendit_code": "<string>"
  },
  "page": {
    "id": 123,
    "is_published": true,
    "name": "<string>",
    "published_at": "2023-11-07T05:31:56Z",
    "slug": "<string>",
    "store_id": 123,
    "unique_id": "<string>"
  },
  "product_price_bt": "<string>",
  "is_purchase_fb": true,
  "product_weight": "<string>",
  "completed_time": "2023-11-07T05:31:56Z",
  "utm_source": "<string>",
  "payment_account_holder": "<string>",
  "ip": "<string>",
  "shipment_receipt": "<string>",
  "message_history": [
    {
      "id": 123,
      "is_from_bot": true,
      "message": "<string>",
      "name": "<string>",
      "provider": "<string>",
      "recipient_name": "<string>",
      "recipient_phone": "<string>",
      "sender_name": "<string>",
      "sender_phone": "<string>",
      "timestamp": "2023-11-07T05:31:56Z"
    }
  ],
  "payment_status": "unpaid",
  "shipment_provider_code": "mengantar",
  "metadata": {},
  "rtsproof_url": "<string>",
  "discount_code_applied_to": "<string>",
  "shipped_time": "2023-11-07T05:31:56Z",
  "awb_ca_status": "unavailable",
  "created_at": "2023-11-07T05:31:56Z",
  "pending_time": "2023-11-07T05:31:56Z",
  "notes": "<string>",
  "destination_address": {
    "address": "<string>",
    "city": "<string>",
    "id": 123,
    "location": 123,
    "name": "<string>",
    "phone": "<string>",
    "postal_code": "<string>",
    "province": "<string>",
    "subdistrict": "<string>"
  },
  "unique_code_discount": "<string>",
  "shipping_fee_discount": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Response

Payment status checked

​
gross_revenue_for_dropshipper
string<decimal>

Gross revenue for dropshipper after discounts

​
advertiser
UserSimple · object
​
cogs
string<decimal>

Cost of goods sold for the order

​
dropshipper_name
string | null

Name of the dropshipper

​
transferproof_url
string | null

Transfer proof URL

​
scalev_fee
string<decimal>

Scalev fee for the order

​
shipment_status_history
ShipmentStatusHistory · object[]
​
discount_code_code
string | null

Discount code used in the order

​
ready_time
string<date-time> | null
​
warehouse
ForOrderWarehouse · object
​
payment_fee_rate
string<decimal>

Payment fee rate applied to the order

​
pg_paid_info
object

Payment gateway paid info

​
transfer_time
string<date-time> | null
​
dropshipper_phone
string | null

Phone number of the dropshipper

​
shipping_cost
string<decimal>

Shipping cost for the order

​
product_price
string<decimal>

Total product price before discounts

​
total_quantity
integer

Total quantity of items in the order

​
net_revenue
string<decimal>

Net revenue after all discounts and fees

​
bundle_price_options
object

Bundle price options for the order

​
customer
CustomerOrder · object
​
variants
object

Variants of the order

​
chat_message
string

Chat message associated with the order

​
handler_phone
string | null

Handler phone number

​
business
BusinessSimple · object
​
order_emails
OrderEmail · object[]

Order emails associated with the order

​
order_id
string

Order ID in string format

​
product_discount
string<decimal>

Total product discount applied

​
last_updated_by
UserSimple · object
​
handler
UserSimple · object
​
payment_account_number
string | null

Payment account number

​
payment_method
enum<string>

Order payment method

Available options:
va,
qris,
card,
invoice,
alfamart,
indomaret,
ovo,
dana,
shopeepay,
linkaja,
gopay,
no_payment,
bank_transfer,
marketplace,
cod
​
courier
integer | null

Courier ID for the order

​
origin_address
WarehouseAddress · object
​
epayment_provider
string | null

E-payment provider

​
in_process_time
string<date-time> | null
​
pg_reference_id
string | null

Payment gateway reference ID

​
weight_bump
string<decimal>

Weight bump added to the order

​
follow_up_chat_type
string | null

Type of follow-up chat for the order

​
awb_status
enum<string>

Order AWB status

Available options:
unavailable,
pending,
waiting,
failed,
created,
canceled
​
platform
string

Platform of the order

​
follow_up_chats
FollowUpChat · object[]
​
is_purchase_kwai
boolean

Is this order a Kwai purchase

​
shipping_discount
string<decimal>

Shipping discount applied to the order

​
conflict_time
string<date-time> | null
​
paid_time
string<date-time> | null
​
confirmed_time
string<date-time> | null
​
canceled_time
string<date-time> | null
​
status
enum<string>

Order status

Available options:
draft,
pending,
confirmed,
in_process,
ready,
shipped,
completed,
canceled,
rts,
closed
​
is_dropshipping
boolean

Is the order a dropshipping order

​
payment_account_id
integer | null

Payment account ID

​
is_repeat
boolean

Is repeat order

​
tiktok_pixel_ids
string[]

TikTok pixel IDs associated with the order

​
fb_pixel_ids
string[]

Facebook pixel IDs associated with the order

​
id
integer

Order primary key

​
unpaid_time
string<date-time> | null
​
is_purchase_tiktok
boolean

Is this order a TikTok purchase

​
orderlines
OrderLine · object[]
​
shipment_status
string | null

Current shipment status of the order

​
kwai_pixel_ids
string[]

Kwai pixel IDs associated with the order

​
cogs_bt
string<decimal>

Cost of goods sold for the order minus tax

​
sub_payment_method
enum<string>

Xendit VA bank code

Available options:
BCA,
BNI,
BRI,
MANDIRI,
PERMATA,
BSI,
BJB,
CIMB,
SAHABAT_SAMPOERNA,
ARTAJASA
​
payment_fee
string<decimal>

Payment fee for the order

​
channel_name
string | null

Channel name of the order

​
discount_rate
string<decimal>

Discount rate applied to the order

​
final_variants
object

Final variants of the order after bundle options

​
other_income_name
string | null

Name of other income source

​
gross_revenue
string<decimal>

Gross revenue of the order

​
tags
string[]

Tags associated with the order

​
discount_code_id
integer | null

Discount code ID

​
other_income
string<decimal>

Other income amount

​
status_history
object[]
​
total_weight
string<decimal>

Total weight of the order including weight bump

​
is_probably_spam
boolean

Is probably spam

​
external_id
string

External ID of the order

​
payment_status_history
object[]
​
discount_code_discount
string<decimal>

Discount code discount amount

​
product_discount_bt
string<decimal>

Total product discount applied minus tax

​
store
ForOrderStore · object
​
pg_payment_info
object

Payment gateway payment info

​
other_income_bt
string<decimal>

Other income amount minus tax

​
courier_service
CourierService · object
​
mark_as_spam_by
string

Who marked as spam

​
net_payment_revenue
string<decimal>

Net payment revenue after fees

​
rts_time
string<date-time> | null
​
min_payment_fee
string<decimal>

Minimum payment fee applied to the order

​
analytics_purchases
AnalyticsPurchase · object[]

Analytics purchases associated with the order

​
is_from_form
boolean

Is from form submission

​
secret_slug
string

Secret slug of the order

​
agent_context
object

Untrusted agent or app attribution metadata

​
shipping_fee
string<decimal>

Shipping fee charged for the order

​
tax_rate
number<float> | null

Tax rate applied to the order

​
draft_time
string<date-time> | null
​
last_updated_at
string<date-time>

Last updated timestamp of the order

​
courier_additional_info
string | null

Additional information for the courier

​
closed_time
string<date-time> | null
​
financial_entity
FinancialEntity · object
​
page
PageSimple · object
​
product_price_bt
string<decimal>

Total product price before discounts minus tax

​
is_purchase_fb
boolean

Is this order a Facebook purchase

​
product_weight
string<decimal>

Total weight of products in the order

​
completed_time
string<date-time> | null
​
utm_source
string | null

UTM source of the order

​
payment_account_holder
string | null

Payment account holder name

​
ip
string | null

IP address of the customer who placed the order

​
shipment_receipt
string | null

Shipment receipt URL for the order

​
message_history
MessageHistoryItem · object[]

Message history associated with the order

​
payment_status
enum<string>

Order payment status

Available options:
unpaid,
paid,
conflict,
settled
​
shipment_provider_code
enum<string> | null

Shipment provider code

Available options:
mengantar,
lincah,
ninja
​
metadata
object

Metadata associated with the order

​
rtsproof_url
string | null

RTS proof URL for the order

​
discount_code_applied_to
string | null

What the discount code was applied to

​
shipped_time
string<date-time> | null
​
awb_ca_status
enum<string>

Order AWB courier aggregator status

Available options:
unavailable,
pending,
waiting,
failed,
created,
canceled
​
created_at
string<date-time>

Order creation timestamp

​
pending_time
string<date-time> | null
​
notes
string | null

Notes or comments for the order

​
destination_address
OrderAddress · object
​
unique_code_discount
string<decimal>

Unique code discount applied to the order

​
shipping_fee_discount
string<decimal>

Shipping fee discount applied to the order