Overviewβ
This document provides a detailed description of the common parameters, business parameters, their formats, rules, and requirements when calling any of the payment APIs. Please read carefully before initiating a request.
note
This applies only to Klarna and other alternative payment subscription scenarios. Please read carefully before initiating a request.
Request Flowβ
Request Headersβ
| Parameter | Type | Length | Required | Description | Example |
|---|---|---|---|---|---|
account | string | 6 | Required | Oceanpayment account number | |
terminal | string | 8-12 | Required | Oceanpayment terminal number | |
secureCode | string | 64 | Required | Oceanpayment secureCode |
Create QuickPay IDβ
Request Parametersβ
| Parameter | Type | Length | Required | Description | Example |
|---|---|---|---|---|---|
+order | object | - | Required | Order node information (JSON format) | |
+merchant | object | - | Required | Merchant node information (JSON format) | |
+billing | object | - | Required | Billing node information (JSON format) | |
+customer | object | - | Required | Customer ID node information (JSON format) | |
+device | object | - | Optional | Device/environment node information (JSON format) | |
+subscription | object | - | Optional | Subscription node information (JSON format) | |
+customer_info | object | - | Optional | Customer risk control node information (compressed JSON text format) | |
+voucher_info | object | - | Optional | Goods/service node information (compressed JSON text format) |
Query QuickPay IDβ
Request Parametersβ
| Parameter | Type | Length | Required | Description | Example |
|---|---|---|---|---|---|
+order | object | - | Optional | Order node information (JSON format) | |
+merchant | object | - | Optional | Merchant node information (JSON format) | |
+customer | object | - | Optional | Customer ID node information (JSON format) | |
+quickpay | object | - | Optional | Quickpay node information (JSON format) |
Disable QuickPay IDβ
Request Parametersβ
| Parameter | Type | Length | Required | Description | Example |
|---|---|---|---|---|---|
+quickpay | object | - | Required | Quickpay node information (JSON format) |
Responseβ
| Parameter | Type | Length | Required | Description | Example |
|---|---|---|---|---|---|
code | object | - | API result code. When not '000', the data node returns empty | ||
message | object | - | API result description, e.g., PARAM_ERROR | ||
+data | object | - | Data node information (JSON format) |