> ## Documentation Index
> Fetch the complete documentation index at: https://doc2.payloco.com/llms.txt
> Use this file to discover all available pages before exploring further.
# 付款请求
## OpenAPI
````yaml 2024-03-31_zh-CN.yaml post /v2/payments/open/api/transfer
openapi: 3.1.0
info:
version: '2024-03-31'
title: Payloco开放平台接口文档
description: "# Introduction.\n\nWelcome to Payloco.\n\nThe Payloco API is designed to be flexible and give you control in how and when you convert currencies, make payments and manage your accounts.\n\nWe recommend you read through the API Documentation in full to familiarise yourself with the features and workflows associated with the product. Demo account access can also be provided to you, and the Client ID and API key can be generated within Account settings > API keys in the Web Application.\n\nFor any assistance through the integration, your PayLoco Business Development Manager and your allocated PayLoco Client Integration Manager will be able to help guide you.\n# Versioning\n\nPayLoco uses versioning to improve our API contracts without affecting existing users.\n\nWhen we need to introduce a backwards-incompatible change, such as renaming or splitting a field, we will create a new date version which clients can migrate to when ready.\n### What is the latest version?\nThe latest version is `2024-03-31`.\n\n\n\n## 支付方式\n | 支付方式 | 支持国家 | 支付类型 | Tokenization | MIT | 必填参数(端到端支付必填) | 交易币种 |\n| :----: | :----: | :----: | :----: | :----:| :----:| :----: |\n| VISA | 全球 | CREDIT_CARD | ☑️ | ☑️ | cardNo/firstName/lastName/cvv/expireYear/expireMonth | 全币种 |\n| MasterCard | 全球 | CREDIT_CARD | ☑️ | ☑️ | cardNo/firstName/lastName/cvv/expireYear/expireMonth | 全币种 |\n| JCB | 全球 | CREDIT_CARD | ☑️ | ☑️ | cardNo/firstName/lastName/cvv/expireYear/expireMonth | 全币种 |\n| DISCOVER | 全球 | CREDIT_CARD | ☑️ | ☑️ | cardNo/firstName/lastName/cvv/expireYear/expireMonth | 全币种 |\n| UNION_PAY | 全球 | CREDIT_CARD | ☑️ | ☑️ | cardNo/firstName/lastName/cvv/expireYear/expireMonth | 全币种 |\n| WEIXIN | 中国香港(HK) | QRCODE,MICROPAY,JSAPI,MINIPROGRAM,APP,H5\t | - | - | - | CNY,HKD |\n| UNIONPAY | 中国香港(HK) | WEB,PAN_PRESENT,QRCODE,H5,3DS | - | - | - | CNY,HKD |\n| ALIPAY_CN | 中国(CN) | H5,WEB,APP\t | - | - | - | CNY,USD,HKD|\n| ALIPAY_HK | 中国香港(HK) | H5,WEB,APP\t | - | - | - | HKD,USD|\n| ALIPAY_HK | 中国香港(HK) | H5,WEB,APP\t | - | - | - | HKD,USD|\n| GCASH | 菲律宾(PH)| H5,WEB,BILLS\t | - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | PHP,USD |\n| BPI | 菲律宾(PH)| H5,WEB\t | - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | PHP,USD |\n| MAYA | 菲律宾(PH)| H5,WEB\t | - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | PHP |\n| BILLEASE | 菲律宾(PH)| H5,WEB\t | - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | PHP,USD |\n| Dragonpay | 菲律宾(PH)| H5,WEB\t | - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | PHP |\n| GrabPay_PH | 菲律宾(PH)| H5,WEB\t | - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | PHP |\n| TNG | 马来西亚(MY)| H5,WEB\t | - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | MYR,USD |\n| BOOST | 马来西亚(MY)| H5,WEB\t | - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | MYR,USD |\n| GrabPay_MY | 马来西亚(MY)| H5,WEB\t | - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | MYR |\n| DANA | 印度尼西亚(ID)| H5,WEB\t | - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | IDR,USD |\n| KAKAOPAY | 韩国(KR)| H5,WEB\t | - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | KRW,USD |\n| NAVERPAY | 韩国(KR)| H5,WEB\t | - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | KRW,USD |\n| TOSSPAY | 韩国(KR)| H5,WEB\t | - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | KRW,USD |\n| TRUEMONEY | 泰国(TH)| H5,WEB\t | - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | THB,USD |\n| RABBIT_LINE_PAY | 泰国(TH)| H5,WEB\t | - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | THB,USD |\n| BRAZIL_PIX | 巴西(BR)| H5,QRCODE | - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | BRL |\n| Ewallet_PicPay | 巴西(BR)| H5,QRCODE | - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | BRL |\n| Khipu | 智利(CL)| H5 | - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | CLP |\n| GrabPay_SG | 新加坡(SG)| H5,WEB\t | - |- | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | SGD,USD |\n| GoPay | 印度尼西亚(ID)| H5,WEB\t| - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | IDR |\n| OVO | 印度尼西亚(ID)| H5,WEB\t| - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | IDR |\n| DOKU | 印度尼西亚(ID)| H5,WEB\t| - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | IDR |\n| Konbini | 日本(JP)| H5,WEB\t| - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | JPY |\n| PayEasy | 日本(JP)| H5,WEB\t| - | - | countryCode/terminalType/osType
[terminalType必填(WEB,WAP,APP);
terminalType为WAP/APP时osType必填(IOS,ANDROID)] | JPY |"
termsOfService: https://www.payloco.com
contact:
name: 技术支持
email: support@payloco.com
url: https://www.payloco.com
license:
url: https://www.apache.org/licenses/LICENSE-2.0.html
name: Apache 2.0
summary: ''
servers:
- url: https://gate.uat.payloco.com/gateway
description: Development server
- url: https://gate.payloco.com/gateway
description: Live server
security:
- signature: []
tags:
- name: 收单
- name: 其他交易类型
- name: 商户管理
- name: 文件下载
- name: 用卡人
- name: 卡管理
- name: 卡交易管理
- name: 收件人
paths:
/v2/payments/open/api/transfer:
parameters: []
post:
tags: []
summary: 付款申请
operationId: post-v1-payments-open-api-transfers
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TransferReqDto'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TransferResDto'
examples:
Example 1:
value:
code: '00000003'
message: 处理中
traceId: 33fae7b7aed1233f
data:
merchantOrderId: '20260430000111111'
orderId: INT2026061222222
status: SUCCESS
components:
schemas:
TransferReqDto:
title: PayOuts
x-stoplight:
id: oayta434edk3t
allOf:
- $ref: '#/components/schemas/BaseRequest'
- type: object
x-stoplight:
id: y42uuznatdqor
properties:
data:
type: object
x-stoplight:
id: d13m7as7g5t8f
description: 请求数据体
required:
- merchantOrderId
- country
- sourceCurrency
- destinationCurrency
- trade
- payeeInfo
- channelExtra
- remark
- purpose
properties:
merchantOrderId:
type: string
x-stoplight:
id: pfi0m84l3sgfn
description: 商户订单号，唯一标识商户的一笔交易，不能重复，只能包含字母、数字、下划线
example: '2026042914410001'
maxLength: 63
country:
x-stoplight:
id: 6fwywy4i6604c
description: 国家代码，大写字母
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- KH
- CM
- CA
- CV
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- KP
- KR
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MK
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- SS
- ES
- LK
- SD
- SR
- SJ
- SZ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
- US
chargeOption:
x-stoplight:
id: 0zmiyoeb4qzs7
description: 费用承担模式
enum:
- SHA
- OUR
- BEN
example: SHA
clearingRail:
x-stoplight:
id: 2s5r1lgz594t6
enum:
- SWIFT
- SEPA
- LOCAL
description: >-
枚举值为：SWIFT, SEPA, LOCAL，分别对应签约的SWIFT、SEPA、Local
Banks支付方式，请根据实际要用的支付方式来上送
example: SWIFT
userId:
type: string
x-stoplight:
id: 3ws2tarwzth9h
description: 商户内部的用户Id，需要保证每个ID唯一性
example: '2026042900010001'
maxLength: 64
sourceCurrency:
x-stoplight:
id: 0fo5njlnw0wju
description: 扣款账户的币种代码，大写字母
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYN
- BZD
- CAD
- CDF
- CHF
- CLF
- CLP
- CNY
- COP
- CRC
- CUC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRU
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLE
- SLL
- SOS
- SRD
- SSP
- STD
- STN
- SVC
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- UYU
- UZS
- VES
- VND
- VUV
- WST
- XAF
- XCD
- XOF
- XPF
- YER
- ZAR
- ZMW
- ZWL
destinationCurrency:
x-stoplight:
id: f0wvdg9xq93ly
description: 指定到账币种，如有标明到账币种的，需要指定到账币种；若未标明，则到账币种仅支持本币，不需要进行指定
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYN
- BZD
- CAD
- CDF
- CHF
- CLF
- CLP
- CNY
- COP
- CRC
- CUC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRU
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLE
- SLL
- SOS
- SRD
- SSP
- STD
- STN
- SVC
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- UYU
- UZS
- VES
- VND
- VUV
- WST
- XAF
- XCD
- XOF
- XPF
- YER
- ZAR
- ZMW
- ZWL
trade:
type: object
x-stoplight:
id: 4rtem2ovcmvgp
description: 交易信息
required:
- amount
- currency
properties:
amount:
type: string
x-stoplight:
id: dtcxmluyv1g9h
description: 交易金额 ，按照各国币种支持的小数点位上送。注意：印尼，越南，韩国，智利，本币不支持带小数金额
example: '1.01'
maxLength: 12
currency:
type: string
x-stoplight:
id: 9e33l7ess180a
example: USD
description: 交易币种，大写字母
maxLength: 3
payeeInfo:
type: object
x-stoplight:
id: h2336sz41ki2k
description: 收款方信息
required:
- paymentMethodType
- targetOrg
- payeeType
properties:
paymentMethodType:
x-stoplight:
id: b9h9vpg5kf53e
description: >-
支付方式，请参考【[支付方式列表](https://doc2.payloco.com/zh/developers/global-payment/payment-network/asia-pacific/indonesia)】
enum:
- BANK_TRANSFER
- REALTIME_PAYMENT
- CARD
- WALLET
example: BANK_TRANSFER
targetOrg:
x-stoplight:
id: dscnz7sp7bokt
description: >-
目标机构,请参考【[支付方式列表](https://doc2.payloco.com/zh/developers/global-payment/payment-network/asia-pacific/indonesia)】
enum:
- FPS
- BRI
- BCA
- GOPAY
- OVO
- DANA
- SHOPEEPAY
- LINKAJA
- PIX
payeeType:
x-stoplight:
id: 9a3ai8v8v0i21
description: 收款方类型
enum:
- PERSONAL
- CORPORATION
example: PERSONAL
accountInfo:
type: object
x-stoplight:
id: txzjb60otihlb
description: 收款账户信息
properties:
accountNo:
type: string
x-stoplight:
id: zlgfuqo9qe5nl
maxLength: 128
description: 收款方账号，根据付款方式不同填入相应账号
accountType:
type: string
x-stoplight:
id: gm7dt7b294rci
description: 收款账户类型,在不同国家-支付方式下规范不同
checkDigit:
type: string
x-stoplight:
id: dmxjcxdy45413
description: 收款方账户验证数字
bankInfo:
type: object
x-stoplight:
id: azuhcmni8ounk
description: 收款方银行信息
properties:
bankCode:
type: string
x-stoplight:
id: beay2xxcg2wfq
description: 用于识别特定金融机构下的收款方银行代码
maxLength: 64
example: '622666607777'
bankName:
type: string
x-stoplight:
id: o8yqybsls001h
description: 收款方银行名称
maxLength: 255
example: bank
bankBranch:
type: string
x-stoplight:
id: 3s50ylungx6hy
description: 收款人银行网点号/分行号
maxLength: 64
example: bank branch
bankCity:
type: string
x-stoplight:
id: 3xhkzvfo1bug7
description: 收款方银行所在城市
maxLength: 255
example: ShangHai
corAccountNo:
type: string
x-stoplight:
id: ltshbm6fud2j0
description: 收款方银行的代理账号（correspondent account）
maxLength: 128
name:
type: object
x-stoplight:
id: 5m2h94nx8kox2
description: 收款方姓名，支持英文、空格、逗号、中划线、点.
properties:
firstName:
type: string
x-stoplight:
id: f6d3dzvimnjbi
description: 收款方名
maxLength: 64
middleName:
type: string
x-stoplight:
id: 9nqt4wq2gwhtj
description: 收款方中间名，多段中间名时，使用空格进行分隔
maxLength: 64
lastName:
type: string
x-stoplight:
id: d1u1g4e1g923c
description: 收款方姓
maxLength: 64
fullName:
type: string
x-stoplight:
id: nmqiek8243mva
description: 收款方全名
maxLength: 512
document:
type: object
x-stoplight:
id: vrgoastype5kw
description: 收款方个人身份信息
properties:
documentType:
type: string
x-stoplight:
id: ipmdc9apsr379
description: 收款方个人身份证明类型
documentId:
type: string
x-stoplight:
id: r0ysey3hvgm2b
description: 收款方个人识别号码，在不同国家下可选类型不同
documentIssueDate:
type: string
x-stoplight:
id: vc3fm4j1kpmy3
description: 收款方个人识别号码生效日期，在不同国家下可选类型不同，yyyy-MM-dd格式
maxLength: 10
documentExpireDate:
type: string
x-stoplight:
id: j28tz5pouq8lm
description: 收款方个人识别号码失效日期，在不同国家下可选类型不同，yyyy-MM-dd格式
maxLength: 10
address:
type: object
x-stoplight:
id: ztreltng3qio8
description: 收款方地址信息
properties:
address:
type: string
x-stoplight:
id: ah4uo9n9bs7l8
description: 收款方地址
maxLength: 512
city:
type: string
x-stoplight:
id: dvsa7oqcfcx7y
description: 收款方城市
maxLength: 255
state:
type: string
x-stoplight:
id: 02k8y3w4h1vq8
description: 州
maxLength: 255
zipCode:
type: string
x-stoplight:
id: a2w9iucpy0a4g
description: 收款方邮编
maxLength: 32
payeePhone:
type: string
x-stoplight:
id: hjq5es1obebtq
description: 收款方移动电话号码，在不同国家-支付方式下填写规范不同
birthDate:
type: string
x-stoplight:
id: 956cku3l7umzt
description: 收款方出生日期，yyyy-MM-dd格式
email:
type: string
x-stoplight:
id: bx4w3kvnremv1
description: 收款方邮箱
payeeNationality:
type: string
x-stoplight:
id: 2jmi17uwzjhdn
description: 收款人国籍，ISO 3166-1 alpha-2标准，如CN，US
example: CN
payeeGender:
type: string
x-stoplight:
id: xuciwkjj47i5a
description: 收款人性别，枚举值F 或M（F=Female，M=Male）
payeeBirthCountry:
type: string
x-stoplight:
id: mpr6pav7zc5ov
description: 收款人出生国家，ISO 3166-1 alpha-2标准，如CN，US
payerInfo:
type: object
x-stoplight:
id: j86zaomlif708
description: 付款方信息
properties:
subMerchantNo:
type: string
x-stoplight:
id: l4db77evqe9hk
description: 子商户号。子商户在系统中的唯一标识
maxLength: 64
businessLegalName:
type: string
x-stoplight:
id: omjnaufbnjo1x
description: 付款公司主体注册名
maxLength: 70
registrationCountry:
type: string
x-stoplight:
id: ic0u79gxxtefg
description: 付款公司主体注册国家，2位大写国家编码
merchantCategoryCode:
x-stoplight:
id: 441pb11hqsnb3
description: >-
付款公司行业分类，枚举值，DIGITAL_GOODS_MEDIA：数娱类产品-媒介；DIGITAL_GOODS_APPLICATION：数字产品-应用软件类；TRAVEL_AGENCIES_AND_TRAVEL_RELATED_SERVICES：旅行社；COURIER_SERVICES_AIR_AND_GROUND_AND_FREIGHT_FORWARDERS：快递服务-空运、陆运及货物运输代理商；ADVERTISING_SERVICES：广告业务；TELECOMMUNICATION_SERVICE：电信服务；COMPUTER_NETWORKS_AND_INFORMATION_SERVICES：计算机网络/信息服务；MISCELLANEOUS_GENERAL_MERCHANDISE：电商-杂项百货。
enum:
- DIGITAL_GOODS_MEDIA
- DIGITAL_GOODS_APPLICATION
- TRAVEL_AGENCIES_AND_TRAVEL_RELATED_SERVICES
- COURIER_SERVICES_AIR_AND_GROUND_AND_FREIGHT_FORWARDERS
- ADVERTISING_SERVICES
- TELECOMMUNICATION_SERVICE
- COMPUTER_NETWORKS_AND_INFORMATION_SERVICES
- MISCELLANEOUS_GENERAL_MERCHANDISE
payerId:
type: string
x-stoplight:
id: 9knbuphvr66x3
description: 付款公司所属机构/平台商户号
name:
type: object
x-stoplight:
id: i0ofaq6f00xp6
description: 付款方姓名，支持英文、空格、逗号、中划线、点
properties:
firstName:
type: string
x-stoplight:
id: 863emmqlhq095
description: 付款方姓名，支持英文、空格、逗号、中划线、点，在不同国家-支付方式下填写规范不同
middleName:
type: string
x-stoplight:
id: 18uaxce2uftq0
description: 付款方中间名，多段中间名时，使用空格进行分隔
lastName:
type: string
x-stoplight:
id: qslpk7qot344v
description: 付款方姓
fullName:
type: string
x-stoplight:
id: 8ucay690op3jr
description: 付款方全名
channelExtra:
x-stoplight:
id: me7kdofkfw1a8
allOf:
- $ref: '#/components/schemas/ChannelExtraOption'
description: 扩展信息
riskParams:
type: object
x-stoplight:
id: l31ewqm7axast
description: 风控业务数据
properties:
registerName:
type: string
x-stoplight:
id: 7kwvo081ats4y
description: 注册账号持有人姓名
registerNo:
type: string
x-stoplight:
id: a326wdzuzy2k4
description: 商户网站/app上用户的注册标识
nickName:
type: string
x-stoplight:
id: l2qcjcuc02o76
description: 商户网站/app上用户的昵称
thirdAccountNoType:
type: string
x-stoplight:
id: bzu3ent64kjm8
description: 第三方 帐户类型： 枚举值 Facebook, Google, AppleID，Others
thirdAccountNo:
type: string
x-stoplight:
id: pex5650yz0pka
description: 第三方账号标识
bindEmail:
type: string
x-stoplight:
id: fw5s2h8jyh0e9
description: 账号绑定邮箱
bindPhoneNo:
type: string
x-stoplight:
id: x1j5klatuz9cn
description: 账号绑定手机号
accountLevel:
type: string
x-stoplight:
id: g0ryyc8q4qrvz
description: 账号等级
vipLevel:
type: string
x-stoplight:
id: 63zi8frp10jxp
description: VIP等级
regTime:
type: string
x-stoplight:
id: sniubgvym63y6
description: 账号注册时间，格式：yyyy-MM-dd HH:mm:ss
lastLoginTime:
type: string
x-stoplight:
id: tfphx8yzdk9yr
description: 最后一次登录/活跃时间，格式：yyyy-MM-dd HH:mm:ss
liveCountry:
type: string
x-stoplight:
id: a9ntbamq80g57
description: 现居住地址（国家维度），如CN
taxId:
type: string
x-stoplight:
id: gy3mop2dfnxeb
description: 用户税号
cumPayoutAmount:
type: string
x-stoplight:
id: cu2c6vc9fcgs4
description: 用户在商户侧，最近3个月累计出款成功金额（USD）
cumPayoutTxn:
type: string
x-stoplight:
id: fjn6job87bkhu
description: 用户在商户侧，最近3个月累计出款成功笔数
accountBalance:
type: string
x-stoplight:
id: heyio0z7dwqvc
description: 用户在商户侧，用户账号当前余额 (金币/钻石)
expressMerchantID:
type: string
x-stoplight:
id: xt6zz6wyxybo1
description: 针对平台类商户下，在平台注册的卖家注册账号
expiryDays:
type: string
x-stoplight:
id: ztpl8zlxrbv02
description: 取款码有效天数，当前仅在FawryCash中有效，支持传入1~15整数（1=24Hours）
remark:
type: string
x-stoplight:
id: 97ew2kkq4zrwn
description: 出款附言或备注，允许英文，数字，中划线，空格，点；受渠道约束，该字段可能会进行特殊处理，如超长截断或填充默认值
reference:
type: string
x-stoplight:
id: xvh3ggfsgnspm
description: 透传数据，在付款异步回调通知中原样返回，该字段主要用于商户携带订单的自定义数据
notifyUrl:
type: string
x-stoplight:
id: r9n5ebr1bfss1
description: 商户接收付款结果的后台回调地址，以http/https开头
example: https://www.google.com
notifyEmail:
type: string
x-stoplight:
id: z3cgv1i4uevte
description: 收款方通知邮箱，目前只有个别支付方式会发送取款码邮件，比如FAWRY
notifyPhone:
type: string
x-stoplight:
id: 6u1lvcpf5sbsa
description: 收款方通知电话
purpose:
x-stoplight:
id: 7z3ctlvi751bz
description: >-
出款目的，枚举值，ISUBIL:向公用事业提供商付款(i.e.水电煤账单)； EPTOUR:旅游业；
EPTKAG:支付旅游门票或旅行社费用； ISPAYR:支付工资； ISPAYRA:支付代理工资；
ISGDDS:货物买卖； ISSCVE:购买和销售服务； ISSUPP:供应商付款； ISLOGS:物流和运输服务付款；
INCEN:激励/促销/用户获取活动； GAME:游戏设备、游戏币和其他游戏物品； SAMENM:企业同名账户转账；
PAYCMSN:报销/福利发放/佣金发放； SAMENMC:法人/股东/董事个人账户； AGOPEXP:代运营费用结算；
ADEXP:广告费用结算；RFND:退货；SMCNTST:子商户结算；LGTEP:供应商付款-物流费用结算；GOODPAY:供应商付款-货款结算；SINVEST:股票投资；FINVEST:基金投资；TAXPAY:纳税/支付税款；LOANPAY:支付贷款；
OTHER:其他；
enum:
- ISUBIL
- EPTOUR
- EPTKAG
- ISPAYR
- ISPAYRA
- ISGDDS
- ISSCVE
- ISSUPP
- ISLOGS
- INCEN
- GAME
- SAMENM
- PAYCMSN
- SAMENMC
- AGOPEXP
- ADEXP
- RFND
- SMCNTST
- LGTEP
- GOODPAY
- SINVEST
- FINVEST
- TAXPAY
- LOANPAY
- OTHER
example: ISUBIL
examples:
- charset: UTF-8
version: 2.0.0
signType: RSA
memberId: '2023010558663764'
merchantId: '2023010558663764'
requestTime: '2026-05-24T14:29:32.682+08:00'
keyVersion: '1'
data:
merchantOrderId: '2026042914410001'
country: AF
chargeOption: SHA
clearingRail: SWIFT
userId: '2026042900010001'
sourceCurrency: AED
destinationCurrency: USD
trade:
amount: '1.01'
currency: USD
payeeInfo:
paymentMethodType: BANK_TRANSFER
targetOrg: FPS
payeeType: PERSONAL
accountInfo:
accountNo: string
accountType: string
checkDigit: string
bankInfo:
bankCode: '622666607777'
bankName: bank
bankBranch: bank branch
bankCity: ShangHai
corAccountNo: string
name:
firstName: string
middleName: string
lastName: string
fullName: string
document:
documentType: string
documentId: string
documentIssueDate: string
documentExpireDate: string
address:
address: string
city: string
state: string
zipCode: string
payeePhone: string
birthDate: string
email: string
payeeNationality: CN
payeeGender: string
payeeBirthCountry: string
payerInfo:
subMerchantNo: string
businessLegalName: string
registrationCountry: string
merchantCategoryCode: DIGITAL_GOODS_MEDIA
payerId: string
name:
firstName: string
middleName: string
lastName: string
fullName: string
channelExtra:
pixKeyType: cpf
pixKey: '11013601513'
documentNo: '11013601513'
name: string
lastName: string
email: string
phone: string
riskParams:
registerName: string
registerNo: string
nickName: string
thirdAccountNoType: string
thirdAccountNo: string
bindEmail: string
bindPhoneNo: string
accountLevel: string
vipLevel: string
regTime: string
lastLoginTime: string
liveCountry: string
taxId: string
cumPayoutAmount: string
cumPayoutTxn: string
accountBalance: string
expressMerchantID: string
expiryDays: string
remark: string
reference: string
notifyUrl: https://www.google.com
notifyEmail: string
notifyPhone: string
purpose: ISUBIL
TransferResDto:
title: TransferResDto
x-stoplight:
id: ymlqz03i4mk8e
allOf:
- $ref: '#/components/schemas/BaseResponse'
- type: object
x-stoplight:
id: xxauu1bskhbme
properties:
data:
type: object
x-stoplight:
id: lcyzj4f76pxhq
description: 返回数据
properties:
merchantOrderId:
type: string
x-stoplight:
id: 46ugwnyrf4n0m
description: 商户订单号
example: '20260430000111111'
orderId:
type: string
x-stoplight:
id: s6kzzcqon14ag
description: PayLoco交易流水号
example: INT2026061222222
status:
x-stoplight:
id: n63nbjfmrgv5x
description: 交易状态，SUCCESS成功, FAILED失败 ，PENDING进行中，BOUNCEBACK退票
enum:
- SUCCESS
- FAILED
- PENDING
- BOUNCEBACK
BaseRequest:
type: object
x-stoplight:
id: 4hhyl9c4c4skc
x-examples:
Example 1:
charset: UTF-8
version: 2.0.0
transType: string
accessType: PAY
signType: RSA
memberId: stringstri
merchantId: stringstri
required:
- charset
- version
- signType
- memberId
- merchantId
- requestTime
- keyVersion
properties:
charset:
type: string
description: 交互数据的编码【utf-8】
default: UTF-8
examples:
- UTF-8
version:
type: string
description: "接口版本，当前版本为【2.0.0】,目前只能传2.0.0，不能不传\t"
example: 2.0.0
maxLength: 8
signType:
type: string
description: 报文签名类型
example: RSA
memberId:
type: string
description: 机构号
example: '2023010558663764'
merchantId:
type: string
description: 商户号
example: '2023010558663764'
maxLength: 32
requestTime:
type: string
x-stoplight:
id: njc3cd378x9h1
description: >-
请求时间，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ssSSS+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC
8小时，即北京时间）。例如：2026-05-20T13:29:35.262+08:00表示，北京时间2026年5月20日13点29分35秒。
example: '2026-05-24T14:29:32.682+08:00'
maxLength: 32
keyVersion:
type: string
x-stoplight:
id: k14bjqd1dyfwh
description: 密钥版本 当前值为：1
maxLength: 8
example: '1'
examples:
- charset: UTF-8
version: 2.0.0
signType: RSA
memberId: '2023010558663764'
merchantId: '2023010558663764'
requestTime: '2026-05-24T14:29:32.682+08:00'
keyVersion: '1'
ChannelExtraOption:
title: ChannelExtraOption
x-stoplight:
id: dcgze1l7l10md
oneOf:
- x-stoplight:
id: amhdwy114nims
description: PIX
title: PIX
required:
- pixKeyType
- documentNo
- name
properties:
pixKeyType:
x-stoplight:
id: g1capsoi4wgx0
description: Pix密钥类型，枚举值为 "cpf" "email" "phone" "evp"
enum:
- cpf
- email
- phone
- evp
example: cpf
default: cpf
pixKey:
type: string
x-stoplight:
id: k68i4ki7l74gh
description: Pix密钥：11013601513
example: '11013601513'
documentNo:
type: string
x-stoplight:
id: voghwqzoezn1u
description: 目标账户持有人的证件号CPF，11位数字：11013601513
example: '11013601513'
name:
type: string
x-stoplight:
id: 922k0hms3c95o
description: |-
目标账号持有人的全名.如果设置了lastName，此处只需要填写
First Name：Joice M Santos Joice Mary Santos
lastName:
type: string
x-stoplight:
id: 9czka92fkibno
description: 目标账号持有人Last Name
email:
type: string
x-stoplight:
id: jf85dapx38c2p
description: 目标账号持有人的邮箱
phone:
type: string
x-stoplight:
id: jlle4lod3lcub
description: 目标账号持有人的电话
- x-stoplight:
id: xa4v3lapup7lg
description: DANA
title: DANA
required:
- phone
properties:
phone:
type: string
x-stoplight:
id: 8irraujyumuir
minLength: 12
maxLength: 14
example: '081617025661'
description: 手机号
- x-stoplight:
id: b5xplkdva885p
description: GOPAY
title: GOPAY
required:
- phone
properties:
phone:
type: string
x-stoplight:
id: 249ne63w18hcr
description: 手机号
example: '081617025661'
minLength: 12
maxLength: 14
- x-stoplight:
id: ob2b8koi2svzl
description: SHOPEEPAY
title: SHOPEEPAY
required:
- phone
properties:
phone:
type: string
x-stoplight:
id: ziaenk0wjmu0o
description: 手机号
minLength: 12
maxLength: 14
example: '081617025661'
- x-stoplight:
id: 645lkldkw70t7
description: ID-BANKTRANSFER
title: ID-BANKTRANSFER
required:
- accountNo
properties:
bankCode:
type: string
x-stoplight:
id: 109nzp1zpbx31
accountNo:
type: string
x-stoplight:
id: xv70dfi5y818d
description: 银行账户
example: '081617025661'
minLength: 6
maxLength: 20
- x-stoplight:
id: y07zx9vdlbt37
description: VN-BANKTRANSFER
title: VN-BANKTRANSFER
required:
- accountNo
- accountName
properties:
accountNo:
type: string
x-stoplight:
id: if7fkj2pmu81j
description: 银行账户
example: '6220229870211'
accountName:
type: string
x-stoplight:
id: w8jcivxsaq9es
description: 账户名称
example: Trầm Thái Dương
type: object
BaseResponse:
type: object
x-stoplight:
id: 4lloo3c92r1n3
x-examples:
Example 1:
isSuccess: true
errCode: '00000003'
errMessage: 处理中
status: PENDING
traceId: 33fae7b7aed1233f
examples:
- code: '00000000'
message: SUCCESS
traceId: 33fae7b7aed1233f
required:
- code
- message
- traceId
properties:
code:
type: string
description: |
响应状态码，’00000000’代表成功。’00000003’代表受理中,只代表接口请求成功，不代表订单状态。
example: '00000003'
x-stoplight:
id: zocifrrgwx3bv
message:
type: string
description: |+
返回描述，’SUCCESS.’ 。只代表接口请求成功，不代表订单状态。
example: SUCCESS
x-stoplight:
id: smef8x7rur0cy
traceId:
type: string
description: "请求消息唯一标识。traceId为本次调用产生的流水号，接口调用异常，可以提供此流水号用于排查问题。\t"
example: 33fae7b7aed1233f
securitySchemes:
signature:
type: apiKey
description: |-
## 加签（Signature）
加签是 Payloco 开放平台与商户之间用于保障报文**完整性**和**防篡改**的安全机制。
### 适用场景
1. **商户请求 Payloco**：商户使用**自身私钥**对请求报文进行加签。
2. **Payloco 返回响应**：商户使用 **Payloco 公钥** 对响应报文进行验签。
### 加签规则（商户请求端）
商户需对 HTTP 请求的 **Body** 进行签名，具体步骤如下：
### 1. 计算签名（SHA256withRSA）
```java
Signature signature = Signature.getInstance("SHA256withRSA");
signature.initSign(merchantPrivateKey);
// 必须使用 UTF-8 编码
byte[] bodyBytes = requestBody.getBytes(StandardCharsets.UTF_8);
signature.update(bodyBytes);
byte[] signedBytes = signature.sign();
```
### 2. 将加签内容进行 Base64 编码；
```java
String signature = Base64.getEncoder().encodeToString(signedHash);
```
### 3. 将编码后的内容放在请求头部 signature 参数中。
```java
POST /v2/payments/open/api/pay HTTP/1.1
Content-Type: application/json
signature: MIIC8jCCAdqgAwIBAgI...
```
name: signature
in: header
````