Giới thiệu

COTPAY là một nền tảng thanh toán mở theo phương thức “Thanh toán tạm giữ - Bảo lãnh thanh toán online” nhằm giúp Khách hàng và  các Shop/Merchant vừa và nhỏ tiếp cận được dịch vụ thanh toán ngân hàng, đặc biệt trong lĩnh vực TMĐT, Nông –Thủy Sản tại các khu vực mà ngân hàng chưa thể tiếp cận. COTPAY (hợp tác với trung gian thanh toán PayME) cung cấp phương thức thanh toán điện tử thay thế thu hộ COD.

COTPAY cung cấp API mở tới cộng đồng IT, giúp các nền tảng TMĐT, website bán hàng có thể tương tác với dịch vụ tài chính của trung gian thanh toán PayME  thông qua  nền tảng "thanh toán tạm giữ" Cotpay.

Mọi thắc mắc cần hỗ trợ hay tham gia nhóm Tele để được hỗ trợ

Support - Telegram group:  COTPAY - API support

  1. Môi trường

. URL Production: https://cotpay.net

. URL Sandbox: không có

  1. API
  1. API tạo đơn
  2. API check user id
  3. API xác nhận đơn (thanh toán tạm giữ)
  4. API Chi tiền (chi tiền về tài khoán bên bán)
  5. API Trả lại (Yêu cầu trả lại hàng và hoàn tiền)
  6. API đăng ký tài khoản Cotpay
  7. Tích hợp Plugin Cotpay lên website Wordpress
  1. API tạo đơn hàng

+ Api path: /api/web-ecommerce/create-order
+ Method: POST

* Request parameters:

   - Payload

Parameter

Type

Description

partnerId

String(10)

Id người bán hàng

buyerId

String (10)

Id người mua hàng

amount

Number

Giá trị giao dịch (Tối thiểu 30,000VND)

desc

String(255)

Nội dung đơn hàng

agentId

String (10)

Id đại lý đối tác (không bắt buộc,liên hệ hỗ trợ) 

ipnUrl

String(255)

Link IPN thông báo trạng thái

  - Response

Key

Type

Description

code

Number

Mã lỗi

message

String

Mô tả thông tin lỗi

order

Object

Dữ liệu trả về

Payload mẫu trước khi encrypt:

Ex response:

 - Mã code

  + 10100: tạo đơn hàng thành công

 + 10200: không tìm thấy thông tin người bán

 + 10300: không tìm thấy thông tin người mua

 + 10400: mã đơn hàng đã tồn tại

+ 11400:  không có token

 + 10500:  lỗi validate

  1. API check user id

+ Api path: /api/web-ecommerce/customerID
+ Method: POST

* Request parameters:

   - Payload

Parameter

Type

Description

partnerId

String(10)

Id người bán hàng

buyerId

String (10)

Id người mua hàng

  - Response

Key

Type

Description

code

Number

Mã lỗi

message

String

Mô tả thông tin lỗi

user

Object

Dữ liệu trả về

 Payload mẫu trước khi encrypt:

Ex response:

 - Mã code

  + 10100: thành công

 + 10200: không tìm thấy thông tin người bán

 + 10300: không tìm thấy thông tin người mua

 + 10500:  lỗi validate

+ 11400:  không có token

  1. API Xác nhận đơn hàng (thanh toán tạm giữ)

+ Api path: /api/web-ecommerce/verify-order
+ Method: POST

* Request parameters:

   - Payload

Parameter

Type

Description

idOrder

Integer(10)

Id đơn hàng

partnerId

String(10)

Id người bán hàng

buyerId

String(10)

Id người mua hàng

payMethod

String(null)

Phương thức thanh toán (PAYME, ATMCARD, QRPAY, BANKTRANSFER, VIETQR, CREDITCARD )

ipnUrl  

String(255)

Link IPN thông báo trạng thái

  - Response

Key

Type

Description

code

Number

Mã lỗi

message

String

Mô tả thông tin lỗi

data

String

Dữ liệu trả về

 Payload mẫu trước khi encrypt:

Ex response:

 - Mã code

  + 10100: thành công

 + 10200: không tìm thấy thông tin người bán

 + 10300: không tìm thấy thông tin người mua

 + 10500:  lỗi validate

+ 10700:  không tìm thấy đơn hàng

+ 11400:  không có token

  1. API Chi tiền (Chi tiền về tài khoản bên bán)

+ Api path: /api/web-ecommerce/payment
+ Method: POST

* Request parameters:

   - Payload

Parameter

Type

Description

idOrder

Integer(10)

Id đơn hàng

partnerId

String (10)

Id người bán hàng

buyerId

String (10)

Id người bán mua

ipnUrl

String(255)

Link IPN thông báo trạng thái

  - Response

Key

Type

Description

code

Number

Mã lỗi

message

String

Mô tả thông tin lỗi

data

String

Dữ liệu trả về

 Payload mẫu trước khi encrypt:

Ex response:

 - Mã code

  + 10100: thanh toán đơn hàng thành công

 + 10200: không tìm thấy thông tin người bán

 + 10300: không tìm thấy thông tin người mua

 + 10500:  lỗi validate

+ 10700:  không tìm thấy đơn hàng hoặc đơn hàng không tồn tại

+ 10800:  thanh toán thất bại

+ 10900:  Tài khoản chưa liên kết ví payme

+ 11000:  tài khoản người nhận chưa liên kết với ngân hàng

+ 11800:  đơn hàng đang trong quá trình thực hiện giao dịch

+ 11300:  thông tin không trùng khớp

+ 11100:  đề nghị thanh toán sau 16h T+1

+ 11400:  không có token

  1. API Trả lại (Yêu cầu trả lại hàng và hoàn tiền)

API Trả lại: chỉ là yêu cầu hoàn trả hàng (tiền chưa hoàn cho khách). Số tiền đơn hàng sẽ hoàn trả ngay lập tức sau khi Bên Bán truy cập https://cotpay.net/customer/orders/sell để xác nhận “đồng ý hoàn”.

+ Api path: /api/web-ecommerce/return-request
+ Method: POST

* Request parameters:

   - Payload

Parameter

Type

Description

idOrder

Integer(10)

Id đơn hàng

partnerId

String (10)

Id người bán hàng

buyerId

String (10)

Id người bán mua

ipnUrl

String(255)

Link IPN thông báo trạng thái

  - Response

Key

Type

Description

code

Number

Mã lỗi

message

String

Mô tả thông tin lỗi

data

String

Dữ liệu trả về

 Payload mẫu trước khi encrypt:

Ex response:

 - Mã code

  + 10100: thanh toán đơn hàng thành công

 + 10200: không tìm thấy thông tin người bán

 + 10300: không tìm thấy thông tin người mua

 + 10500:  lỗi validate

+ 10700:  không tìm thấy đơn hàng hoặc đơn hàng không tồn tại

+ 11300:  thông tin không trùng khớp

+ 11400:  không có token

VI.        API đăng ký tài khoản Cotpay

+ Api path: /api/web-ecommerce/sign-up

+ Method: POST

* Request parameters:

   - Payload

Parameter      

            Type   

            Description

name

String (10)

Họ tên khách hàng

email

String (10)

Email khách hàng

phone

String (10)

Id khách hàng (số điện thoại)

agentId

String (10)

Id đại lý (không bắt buộc)

  - Response

Key

Type

Description

code

Number

Mã lỗi

message

String

Mô tả thông tin lỗi

data

String

Dữ liệu trả về

 

 

Payload mẫu trước khi encrypt:

- Mã code

  + 10100: thanh toán đơn hàng thành công

 + 10200: không tìm thấy thông tin người bán

 + 10300: không tìm thấy thông tin người mua

 + 10500:  lỗi validate

+ 10700:  không tìm thấy đơn hàng hoặc đơn hàng không tồn tại

+ 11300:  thông tin không trùng khớp

+ 11400:  không có token

C. Plugin Coptay Wordpress

- WP có thể tải plugin thanh toán  Cotpay sẵn có tại đây ( mặc định là phương thức chuyển khoản)

- link và hướng dẫn tải tại : https://drive.google.com/file/d/1Jb1uWEPa1GWNka1M82X-cnzfQ9qrfUTn/view?usp=sharing

Đội ngũ phát triển Cotpay.