Create payment slip

Requires write_orders access scope.

For more info , refer to:

[]

access permission

POST https://{handle}.myshopline.com/admin/openapi/v20250601/orders/transactions.json

[]

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

order_payment_listobject[] required
[]
orderPaymentList
amount double required
[]
Payment amount
[]
Example: 2
create_at long
[]
Creation time (timestamp example: 1632638624)
[]
Example: 1632638624
currency string required
[]
Currency
[]
Example: USD
gateway string required
[]
Payment method, only support offline payment customPay
[]
Example: customPay
order_id string required
[]
Order number
[]
Example: 21059591764404071557334003
payment_detailsobject
[]
Transaction extra fields
pay_channel_deal_id string
[]
External channel payment serial number
[]
Example: 1C40278814835131L
store_payment_id string required
[]
Merchant payment method ID
[]
Example: 146462515
store_payment_name string required
[]
Merchant payment method name
[]
Example: Payment name
processed_at string
[]
Payment actual time , format : 2023-04-12T22 : 59 : 52+08 : 00
[]
Example: 2023-04-12T22:59:52+08:00
status string required
[]
Payment status unpaid (unpaid), paid (payment successful), paid_failed (payment failed)
[]
Example: paid

Response

[]

For more information about status codes, see Http status code.

Response Headers

traceId
[]
traceId

Response Body

transaction_listobject[]
[]
java.util.Random@7cfadf47
amount double
[]
Payment amount
[]
Example: 2
create_at string
[]
Creation time
[]
Example: 1632638624
id string
[]
Payment slip number
[]
Example: 23059287225140757637516981
order_id string
[]
Order number
[]
Example: 21059591764404071557334003
pay_channel_deal_id string
[]
External channel payment serial number
[]
Example: 1C40278814835131L
status string
[]
Payment slip status
[]
Example: paid

API Explorer

Debugger

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

Authorization — header required

Body

Body required

{
  "order_payment_list": [
    {
      "amount": 2,
      "create_at": 1632638624,
      "currency": "USD",
      "gateway": "customPay",
      "order_id": "21059591764404071557334003",
      "payment_details": {
        "pay_channel_deal_id": "1C40278814835131L",
        "store_payment_id": "146462515",
        "store_payment_name": "Payment name"
      },
      "processed_at": "2023-04-12T22:59:52+08:00",
      "status": "paid"
    }
  ]
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/orders/transactions.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal