消费-收银台 - PayAllGlobal

消费-收银台

curl --request POST \
  --url https://mpgwpre.payallglobal.com/mp-gateway/api/mapi/v1/payments/open/api/cashier \
  --header 'Content-Type: application/json' \
  --header 'signature: <api-key>' \
  --data '
{
  "charset": "UTF-8",
  "version": "2.0.0",
  "transType": "PAY",
  "accessType": "s2s",
  "signType": "RSA",
  "memberId": "2023010558663764",
  "merchantId": "2023010558663764",
  "deviceChannel": "Brower",
  "transTimeout": 10,
  "carrierId": "跨境",
  "currency": "USD",
  "transAmt": "20.01",
  "goodsName": "Iphone15",
  "dcc": "dcc",
  "notifyUrl": "https://mpgwdev.payallglobal.com/mp-gateway/api/mapi/v1/payments/open/api/unionPayTest1111",
  "redirectUrl": "https://mpgwdev.payallglobal.com/mp-gateway/api/mapi/v1/payments/open/api/unionPayTest",
  "merchantOrderId": "20230424141154",
  "payMethodInfo": {
    "cardNo": "444433******1111",
    "expirationMonth": "01",
    "expirationYear": "2026",
    "cvv": "123",
    "firstName": "Bren",
    "lastName": "Qiu",
    "phone": "18817536699"
  },
  "merchantOrderTime": "2025-10-24T15:00:00.500+08:00",
  "merchantRegion": "US",
  "reqReserved": "reqReserved",
  "reserved": "reserved",
  "subMerchantId": "2258484869050",
  "goods": [
    {
      "referenceGoodsId": "M1006",
      "goodsName": "单品惠-6",
      "goodsCategory": "1001",
      "goodsQuantity": "100",
      "goodsUnitAmount": {
        "currency": "php",
        "value": "100.01"
      }
    }
  ],
  "shippingInfo": {
    "firstName": "James",
    "lastName": "Smith",
    "phoneNo": "903124360628",
    "email": "James@example.com",
    "address1": "GOLGELI SOKAK NO.34, 06700",
    "city": "GAZIOSMANPASA/ANKAR",
    "country": "TR",
    "state": "CA",
    "zipCode": "06700"
  },
  "billingInfo": {
    "firstName": "James",
    "lastName": "Smith",
    "phoneNo": "903124360628",
    "email": "James@example.com",
    "address1": "GOLGELI SOKAK NO.34, 06700",
    "city": "GAZIOSMANPASA/ANKAR",
    "country": "TR",
    "state": "CA",
    "zipCode": "06700"
  }
}
'

{
  "isSuccess": true,
  "errCode": "00000003",
  "errMessage": "处理中",
  "status": "PENDING",
  "traceId": "33fae7b7aed1233f",
  "data": {
    "orderId": "TR1658354573473091584",
    "merchantNo": "2023010558663764",
    "merchantOrderId": "20230424141154",
    "currency": "USD",
    "transAmt": "100.01",
    "payMethodResponse": {
      "isRedirect": "yes",
      "redirectMethod": "get",
      "termUrl": "string",
      "redirectParam": {},
      "codeUrl": "weixin://wxpay/bizpayurl?pr=waUjCuPzz"
    }
  }
}

POST

api

mapi

payments

open

api

cashier

消费-收银台

curl --request POST \
  --url https://mpgwpre.payallglobal.com/mp-gateway/api/mapi/v1/payments/open/api/cashier \
  --header 'Content-Type: application/json' \
  --header 'signature: <api-key>' \
  --data '
{
  "charset": "UTF-8",
  "version": "2.0.0",
  "transType": "PAY",
  "accessType": "s2s",
  "signType": "RSA",
  "memberId": "2023010558663764",
  "merchantId": "2023010558663764",
  "deviceChannel": "Brower",
  "transTimeout": 10,
  "carrierId": "跨境",
  "currency": "USD",
  "transAmt": "20.01",
  "goodsName": "Iphone15",
  "dcc": "dcc",
  "notifyUrl": "https://mpgwdev.payallglobal.com/mp-gateway/api/mapi/v1/payments/open/api/unionPayTest1111",
  "redirectUrl": "https://mpgwdev.payallglobal.com/mp-gateway/api/mapi/v1/payments/open/api/unionPayTest",
  "merchantOrderId": "20230424141154",
  "payMethodInfo": {
    "cardNo": "444433******1111",
    "expirationMonth": "01",
    "expirationYear": "2026",
    "cvv": "123",
    "firstName": "Bren",
    "lastName": "Qiu",
    "phone": "18817536699"
  },
  "merchantOrderTime": "2025-10-24T15:00:00.500+08:00",
  "merchantRegion": "US",
  "reqReserved": "reqReserved",
  "reserved": "reserved",
  "subMerchantId": "2258484869050",
  "goods": [
    {
      "referenceGoodsId": "M1006",
      "goodsName": "单品惠-6",
      "goodsCategory": "1001",
      "goodsQuantity": "100",
      "goodsUnitAmount": {
        "currency": "php",
        "value": "100.01"
      }
    }
  ],
  "shippingInfo": {
    "firstName": "James",
    "lastName": "Smith",
    "phoneNo": "903124360628",
    "email": "James@example.com",
    "address1": "GOLGELI SOKAK NO.34, 06700",
    "city": "GAZIOSMANPASA/ANKAR",
    "country": "TR",
    "state": "CA",
    "zipCode": "06700"
  },
  "billingInfo": {
    "firstName": "James",
    "lastName": "Smith",
    "phoneNo": "903124360628",
    "email": "James@example.com",
    "address1": "GOLGELI SOKAK NO.34, 06700",
    "city": "GAZIOSMANPASA/ANKAR",
    "country": "TR",
    "state": "CA",
    "zipCode": "06700"
  }
}
'

{
  "isSuccess": true,
  "errCode": "00000003",
  "errMessage": "处理中",
  "status": "PENDING",
  "traceId": "33fae7b7aed1233f",
  "data": {
    "orderId": "TR1658354573473091584",
    "merchantNo": "2023010558663764",
    "merchantOrderId": "20230424141154",
    "currency": "USD",
    "transAmt": "100.01",
    "payMethodResponse": {
      "isRedirect": "yes",
      "redirectMethod": "get",
      "termUrl": "string",
      "redirectParam": {},
      "codeUrl": "weixin://wxpay/bizpayurl?pr=waUjCuPzz"
    }
  }
}

Authorizations

signature

string

header

required

Example: MIIEpQIBAAKCAQEA...（Base64编码的签名字符串）

加签

加签是开放平台和商户对于交互消息完整性的校验。加签行为主要发生两个部分：

商户服务器端针对向PayAllGlobal开放平台发送的请求报文进行加签；
PayAllGlobal开放平台针对通知商户的异步消息进行加签。 PayAllGlobal平台要求使用 RSA 私钥进行加签，使用 RSA 公钥进行验签。因此，在以上两部分描述的交互中，存在商户公私钥、PayAllGlobal 公私钥，开发者需要使用商户私钥，对第一部分报文进行加签，使用 PayAllGlobal 公钥对第二部分消息进行验签。

加签规则如下:

使用商户私钥对请求体进行 SHA256withRSA 签名后，再进行 Base64 编码的结果。

使用商户私钥对待 request.body 进行签名（SHA256WithRSA 计算原始数据的SHA-256哈希值。使用私钥对哈希值进行签名，即使用私钥对哈希值进行RSA加密。此时得到的加密结果就是数字签名。）；

Signature signature = Signature.getInstance("SHA256withRSA");
signature.initSign(privateKey);
// 计算 SHA256withRSA 签名时，需要以 utf-8 的编码转换 byte 流，否则可能导致含中文参数的签名计算不正确
signature.update(request.body);
byte[] signedHash = signature.sign();

将加签内容进行 Base64 编码；

String signature = Base64.getEncoder().encodeToString(signedHash);

将编码后的内容放在请求头部 signature 参数中。注意，加签是对 request.body 进行签名，当查询等 request.body 为空时，则无需加签。

Body

application/json

charset

string

default:UTF-8

required

交互数据的编码【utf-8】

Example:

"UTF-8"

version

string

required

接口版本，当前版本为【2.0.0】,目前只能传2.0.0，不能不传

Example:

"2.0.0"

transType

enum<string>

default:PAY

required

交易类型

Available options:

PAY: 消费支付,

CREDIT_CARD: 信用卡支付,

3D_PREAUTH_VOIDS: 3D 预授权撤销,

3D_PREAUTH_COMPLETION: 3D 预授权完成,

REFUND: 退款,

VOIDS: 撤销,

QUERY: 查询,

TRANSFER: 转账,

DOWNLOAD: 文件下载,

REGISTRATION: 商户注册,

FILEUPLOAD: 文件上传,

INQUIRYREGISTRATIONSTATUS: 查询注册状态,

AUTHORIZE: 授权,

CASHIER_PAY: 收银台支付

accessType

string

default:s2s

required

接口接入类型，固定为服务端到服务端(s2s)模式

Example:

"s2s"

signType

string

default:RSA

required

报文签名类型，当前支持RSA。

Example:

"RSA"

memberId

string

required

机构号，商户侧唯一标识

Example:

"2023010558663764"

merchantId

string

required

商户号，商户唯一标识

Example:

"2023010558663764"

transTimeout

number

required

订单有效时长(整数格式单位:分钟),示例值(10)

Example:

10

carrierId

string

required

发生交易的网站域名或者APP名称,示例值(跨境)

Example:

"跨境"

currency

string

required

订单币种ISO4217币种的字母码 eg. USD, CNY, EUR

Required string length: 3

Example:

"USD"

transAmt

string

required

订单金额请按照4217币种的最小单位传递 eg.(CNY) 110.86 (JPY) 1110

Example:

"20.01"

merchantOrderId

string

required

商户订单号，商户生成的唯一订单号。

Example:

"20230424141154"

merchantOrderTime

string<date-time>

required

请求时间（ISO 8601 格式，带时区）

Example:

"2025-10-24T15:00:00.500+08:00"

merchantRegion

string

required

商户所在地区国家代码

Example:

"US"

goods

object[]

required

Show child attributes

deviceChannel

string

设备渠道

Example:

"Brower"

transChannel

enum<string>

支付渠道，详见支付渠道列表

Available options:

WEIXIN: 微信支付,

UNIONPAY: 银联,

ALIPAY_CN: 支付宝（大陆）,

ALIPAY_HK: 支付宝（香港）,

GCASH: GCash,

BPI: BPI,

TNG: Touch 'n Go,

BOOST: Boost,

DANA: DANA,

KAKAOPAY: KakaoPay,

TRUEMONEY: TrueMoney,

BRAZIL_PIX: PIX,

Ewallet_PicPay: PicPay,

Khipu: Khipu,

RABBIT_LINE_PAY: Rabbit LINE Pay,

ALIPAY_INSTORE: 支付宝扫码支付,

NAVERPAY: Naver Pay,

TOSSPAY: Toss Pay,

MAYA: Maya,

BILLEASE: Billease,

GoPay: GoPay,

OVO: OVO,

DOKU: DOKU,

Dragonpay: Dragonpay,

Konbini: Konbini,

PayEasy: PayEasy,

GrabPay: GrabPay,

PAYCO: PAYCO,

MPAY: mPAY,

PROMPT_PAY: PromptPay,

HIPAY: HiPay,

TINABA: Tinaba,

KREDIVO_ID: Kredivo,

AKULAKU_PAYLATER: Akulaku PayLater,

KPLUS: K PLUS,

QRPH: QRPH,

BANK_TRANSFER: 银行转账,

KOREAN_CARDS: 韩国信用卡,

CARD: 国际卡支付

goodsName

string

商品或订单的名称,多个名称之间用";"隔开

Example:

"Iphone15;Macbook Pro"

dcc

string

交易是否走DCC 传送：dcc

Example:

"dcc"

notifyUrl

string<uri>

异步通知地址

Required string length: 10 - 200

Example:

"https://mpgwdev.payallglobal.com/mp-gateway/api/mapi/v1/payments/open/api/unionPayTest1111"

redirectUrl

string<uri>

前台回调地址

Example:

"https://mpgwdev.payallglobal.com/mp-gateway/api/mapi/v1/payments/open/api/unionPayTest"

customerIp

string

用户ip

Example:

"18.277.26.154"

payMethodInfo

object

Show child attributes

osType

string

手机操作系统类型(支付类型为APP时必传)

Example:

"IOS"

authCode

string

授权码(支付渠道为WEIXIN且支付类型为MICROPAY时需传值)

Example:

"133788758877188822"

appId

string

公众账号ID

Example:

"wxd678efh567hg6787"

openId

string

应用内用户ID

Example:

"oUpF8uMuAJO_M2pxb1Q9zNjWeS6o"

reqReserved

string

商户备注扩展字段

Example:

"备注扩展"

reserved

string

备注字段

Example:

"备注"

subMerchantId

string

商户子商户号

Example:

"20230424141154"

shippingInfo

object

邮寄信息。国际卡支付必传

Show child attributes

billingInfo

object

信用卡账单信息。国际卡支付必传

Show child attributes

Response

isSuccess

boolean

required

是否成功，true表示成功，false表示失败

Example:

true

errCode

string

required

响应状态码，errCode为00000000表示响应成功，其他状态码表示响应失败。具体系统错误码可以参考系统错误码。

Example:

"00000003"

errMessage

string

required

错误消息

Example:

"处理中"

status

string

required

订单状态(见补充说明)

Examples:

"PENDING：处理中"

"SUCCESS：成功"

"FAIL：失败"

traceId

string

required

请求消息唯一标识。traceId为本次调用产生的流水号，接口调用异常，可以提供此流水号用于排查问题。

Example:

"33fae7b7aed1233f"

data

object

Show child attributes

消费预授权