POST | Payment | Tokopedia Seller API

Payment

The purpose of this payload is for Tokopedia to confirm the user transactions to be processed by a partner. Tokopedia only requests this payload after the Tokopedia user is done making payment on Tokopedia and the Re-Inquiry result is still the same.

Tokopedia users can see their transaction status on the Tokopedia order details page and invoice.

If the payment response from a partner stating the transaction is in pending state (based on Response Code), Tokopedia will continue to hit Check Status payload until Tokopedia receives the expected results. If the payment response from a partner stating the transaction is in failed and retry state (based on Response Code), Tokopedia will attempt to hit to another partner (if any) or retry to the same partner until maximum attempt/time received (5 times or maximum 90 minutes). After maximum attempt/time is conducted, Tokopedia will automatically fail and refund the transaction.

Request

Key	Value	Required	Description
ref_id	string	yes	Unique reference identifier from Tokopedia
partner_inquiry_id	string	yes	Unique inquiry ID from previous inquiry request
client_number	string	yes	Client bill identifier / MSISDN number
category	string	yes	Product category identifier provided by Tokopedia
rsid	string	no	Tokopedia channel identifier (default will be filled with TOKOPEDIA)
product_code	string	yes	Code of product given by Partner
total_amount	number	yes	Total bill amount or product price (From inquiry response. If there is no inquiry action, using predefined amount from Tokopedia side)
timestamp	string	yes	In Jakarta Time GMT+7, Format: YYYY-MM-DD hh:mm:ss
additional_parameter	array	no	List of additional parameters needed

Partner must save Tokopedia ref_id and link it to their reference identifier, this ref_id pairing will be used for reconciliation and check status API

Unencrypted & Unsigned (Plain Payload) Example

{
  "ref_id": "11242905512",
  "partner_inquiry_id": "11242905512",
  "client_number": "1234567890",
  "category": "listrik",
  "RSID": "listrikMainApp01",
  "product_code": "product5627",
  "total_amount": 1500000,
  "timestamp": "2021-12-12 12:12:12",
  "additional_parameter": [
    {
      "name": "room",
      "value": "studio"
    },
    {
      "name": "month",
      "value": "5"
    }
  ]
}

Response

Key	Value	Required	Description
ref_id	string	yes	Unique reference identifier from Tokopedia
partner_ref_id	string	yes	Unique reference identifier from Partner
client_number	string	yes	Client bill identifier / MSISDN number
product_code	string	yes	Code of product given by Partner
response_code	string	yes	Response code as specified (see 10. Response Codes)
message	string	yes	Additional informational or error message
admin_fee	number	no	Partner admin fee that already included on total_amount
total_amount	number	yes	Total bill amount or product price
timestamp	string	yes	In Jakarta Time GMT+7, Format: YYYY-MM-DD hh:mm:ss
bill_details	array	no	Details of a given bill
additional_details	array	no	Additional details of a given bill that will be shown to the user with a collapsed initial state. This usually is not important yet needs to be displayed to the user. For specific product categories, please refer to Mandatory Responses

Information details will be used on the invoice page and email notification to show the user their bill information

Decrypted & Verified (Plain Payload) Success Example

{
  "ref_id": "11242905512",
  "partner_ref_id": "11242905512",
  "client_number": "1234567890",
  "product_code": "product5627",
  "response_code": "00",
  "message": "Success",
  "total_amount": 1500000,
  "timestamp": "2021-12-12 12:12:12",
  "bill_details": [
    {
      "name": "Nama Perusahaan",
      "value": "Company Lorem",
      "is_pii": false,
      "is_show": true
    },
    {
      "name": "Nama Customer",
      "value": "John Doe",
      "is_pii": true,
      "is_show": true
    }
  ],
  "additional_details": [
    {
      "label": "Pemakaian",
      "details": [
        {
          "name": "Meter awal",
          "value": "120 m2",
          "is_pii": false,
          "is_show": true
        },
        {
          "name": "Meter akhir",
          "value": "150 m2",
          "is_pii": false,
          "is_show": true
        }
      ]
    }
  ]
}

Decrypted & Verified (Plain Payload) Failed Example

{
  "ref_id": "11242905512",
  "client_number": "1234567890",
  "product_code": "product5627",
  "response_code": "43",
  "message": "Insufficient balance",
  "timestamp": "2021-12-12 12:12:12"
}

Order Details Page

Invoice Page

Payment​

Payment