交易提交 - 珊瑚跨境开放平台

请求参数

Header 参数

X-Request-Id

string

请求标识

必需

默认值:

Body 参数application/json

partnerSerialNumber

string

必需

流水标识〔集成产商流水〕

<= 36 字符

beneficiaryId

string

必需

收款方标识
转账场景下, 该值需赋值为受益人标识
提现场景下, 该值需赋值为受益人标识
钱包间转账场景下, 该值需赋值为用户标识「目标」

business

enum<string>

业务类型

必需

枚举值:

WALLETPAYOUTWITHDRAW

sourceAmount

number

可选

来源金额来源金额
〔来源金额〕、〔目标金额〕二选一
〔来源金额〕、〔目标金额〕均非空场景下优先使用〔来源金额〕

sourceCurrency

enum<string>

来源币种

必需

枚举值:

USDEURJPYGBPAUDCADCNYIDRSGDHKDKRWDKKMYRTHBAEDVND

targetAmount

number

可选

目标金额来源金额
〔来源金额〕、〔目标金额〕二选一
〔来源金额〕、〔目标金额〕均非空场景下优先使用〔来源金额〕

targetCurrency

enum<string>

目标币种

必需

枚举值:

USDEURJPYGBPAUDCADCNYIDRSGDHKDKRWDKKMYRTHBAEDVND

postscript

string

附言

可选

<= 128 字符

purpose

enum<string>

用途

可选

枚举值:

GOODSLOGISTICSWAREHOUSINGADSCOMMISSIONOTHER

otherPurpose

string

可选

用途
当字段〔purpose〕为「其他」时, 该字段必填

document

array[string]

可选

文件标识〔合同、发票〕
下列场景下该字段必填
1、首次交易
2、单笔超过 10 万（等额美元）或同客户同个供应商当月累计超过100 万（等额美元）

示例

{
  "partnerSerialNumber": "string",
  "beneficiaryId": "string",
  "business": "WALLET",
  "sourceAmount": 0,
  "sourceCurrency": "USD",
  "targetAmount": 0,
  "targetCurrency": "USD",
  "postscript": "string",
  "purpose": "GOODS",
  "otherPurpose": "string",
  "document": [
    "string"
  ]
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://gateway-openapi.coralglobal.cn/v1/payout/apply' \
--header 'X-Request-Id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "partnerSerialNumber": "string",
    "beneficiaryId": "string",
    "business": "WALLET",
    "sourceAmount": 0,
    "sourceCurrency": "USD",
    "targetAmount": 0,
    "targetCurrency": "USD",
    "postscript": "string",
    "purpose": "GOODS",
    "otherPurpose": "string",
    "document": [
        "string"
    ]
}'

返回响应

🟢200成功

application/json

Body

code

string

错误编码

可选

message

string

错误信息

可选

data

object (PayoutApplyVO)

响应主体

可选

partnerSerialNumber

string

可选

流水编号〔集成产商流水〕

serialNumber

string

可选

流水编号〔珊瑚跨境流水〕

toAmount

number

金额〔受益人〕

可选

toCurrency

string

币种〔受益人〕

可选

fromAmount

number

金额〔付款人〕

可选

fromCurrency

string

币种〔付款人〕

可选

exchangeRate

number

汇率

可选

transactionFee

number

金额〔手续费〕

可选

transactionFeeCurrency

string

币种〔手续费〕

可选

serviceFee

number

金额〔服务费〕

可选

serviceFeeCurrency

string

币种〔服务费〕

可选

gmtCreate

string

可选

创建时间〔yyyy-MM-dd HH:mm:ss〕

status

enum<string>

状态

可选

枚举值:

PENDINGSUCCESSFAILREFUNDEDRETURN_TICKET

timestamp

string

时间戳

可选

示例

{
  "code": "",
  "message": "",
  "data": {
    "partnerSerialNumber": "",
    "serialNumber": "",
    "toAmount": 0,
    "toCurrency": "",
    "fromAmount": 0,
    "fromCurrency": "",
    "exchangeRate": 0,
    "transactionFee": 0,
    "transactionFeeCurrency": "",
    "serviceFee": 0,
    "serviceFeeCurrency": "",
    "gmtCreate": "",
    "status": ""
  },
  "timestamp": ""
}