银行转账

将资金从电子钱包转移到外部银行机构。

HTTP请求

POST /wallets/{{walletsId}}/banktransfer

请求响应

Request Headers

{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}"
}

Request Body

{
    "externalIdentifier": "280a03fc-2255-11eb-adc1-0242ac120002",
    "targetName": "{{TARGET_PERSON_FULL_NAME}}",
    "targetDocument": "{{TARGET_PERSON_CPF}}",
    "targetBankName": "{{TARGET_BANK_NAME}}",
    "targetBankCode": "{{TARGET_BANK_CODE}}",
    "targetBankBranchId": "{{TARGET_BANK_BRANCH_ID}}",
    "targetBankAccountId": "{{TARGET_BANK_ACCOUNT_ID}}",
    "amount": 100,
    "currency": "BRL"
}

Content-Type: application/json

{
    "statusCode": 200,
    "errorMsg": "",
    "transactionId":"09461d96-2252-11eb-adc1-0242ac120002",
    "transferStatus":"IN_PROGRESS"
}

HTTP Headers 字段说明

Key	Value
Content-Type	application/json
Accept	application/json
Authorization	"bearer"+ "" + {{access_token}}

路径参数

参数	是否必填	类型	描述
walletId		String	转账中的源电子钱包ID

Request Body 字段说明

参数	类型	描述
idempotencyKey	String	此参数用于幂等目的，交易的唯一标识ID 长度不大于128个字节。
targetName	String	目标账号的收款人全名
targetDocument	String	目标账号的收款人的身份ID，例如巴西的CPF
targetBankName	String	目标账号的银行名称
targetBankCode	String	目标账号的银行代码
targetBankBranchId	String	目标账号的银行分支码
targetBankAccountId	String	目标账号的账号ID
amount	String	转账金额
currency	String	转账货币单位，例如巴西的BRL

Response Body 字段说明

参数	类型	描述
statusCode	int	状态代码，200 代表成功2, 401 访问受限, 422 参数错误, 500 内部错误
errorMsg	String	如果交易失败，返回的错误信息
transactionId	String	此次交易的ID
transferStatus	String	此次交易的目前状态, 枚举值，SETTLED, IN_PROGRESS 或者 FAILED。