跳转至

银行转账

TED汇款请求

请求付款，并将资金转移到外部银行机构。注意，此汇款方式对方到账时间受银行营业时间影响。

HTTP请求

POST /v1/payments/payouts/transfer

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Request Body
{
    "idempotencyKey": "idempotency-key",
    "country": "BR",
    "targetName": "Luiz Carlos",
    "targetEmail": "account@example.com",
    "targetDocument": "97123456789",
    "targetBankCode": "036",
    "targetBankAgency": "3563",
    "targetBankAccountId": "72346",
    "amountInCents": 150,
    "currency": "BRL",
    "callbackUrl": "https://api.client.com/callback/",
    "subMerchantId": "UUID"
}
Content-Type: application/json
{
    "idempotencyKey": "idempotency-key",
    "statusCode": 200,
    "errorMsg": "",
    "transferStatus": "IN_PROGRESS",
    "transferStatusCode": 200,
    "transferErrorMsg": ""
}

HTTP Headers 字段说明

Key Value
Content-Type application/json
Authorization "Bearer" + " " + {{access_token}}
x-api-key {{api_key}}

Request Body 字段说明

参数 是否必填 类型 描述
idempotencyKey String 此参数用于幂等目的，交易的唯一标识ID 长度不大于128个字节。
country String 用户的国际缩写码，遵循ISO 3166-1 alpha-2 code标准, BR
targetName String 目标账号持有人的全名.如果设置了targetLastName，此处只需要填写First Name
targetLastName String 目标账号持有人Last Name
targetEmail String 目标账户持有人的电子邮箱
targetPhone String 目标账户持有人的电话，格式 +55xxxxxxxxx
targetBirthDate String 目标账户持有人的生日信息，格式 yyyy-MM-dd
targetDocument String 目标账户持有人的证件号，可以是11位数的CPF或者14位数的CNPJ。
targetBankCode String 目标账号的银行代码, 请看支持的银行。
targetBankAgency String 目标账号的银行分支码
targetBankAccountId String 目标账号的账号ID
amount String 已弃用。汇款金额，注意： 1 = 1BRL。请使用amountInCents代替，如果和amountInCents同时存在，会优先使用amountInCents
amountInCents Long 汇款金额，注意： 100 = 1BRL/1USD
currency String 必传。BRL、USD
callbackUrl String 接收交易状态变更通知的地址，接收post请求
subMerchantId String 子商户ID。商户类型为PSP时必填。
riskData JSON 支付的风险信息。MERCHANT_APP_NAME 或 MERCHANT_WEBSITE 在riskData中必须填一个。 请参考这里查看更多详情。

创建一个带风控信息的支付

请参考这里查看更多详情。

Response Body 字段说明

参数 类型 描述
idempotencyKey String 交易的唯一标识ID
statusCode Integer 此次请求API状态代码，200代表API请求成功, 401 访问受限, 422 参数错误, 500 内部错误
errorMsg String 如果API请求失败，返回的错误信息
transferStatus String 此次交易的目前状态, 枚举值，"SETTLED", "IN_PROGRESS", "FAILED" 或者 "REJECTED"，交易状态应以transferStatus为准
transferStatusCode Integer 此次交易的状态码，交易异常码
transferErrorMsg String 此次交易失败原因

支持的银行

银行Id 银行名称
246 Banco ABC Brasil S.A.
299 Banco Afinz S.A. Banco Múltiplo
000 Banco Agibank S.A.
025 Banco Alfa S.A.
065 Banco Andbank (Brasil) S.A.
096 Banco B3 S.A.
024 Banco BANDEPE S.A.
318 Banco BMG S.A.
752 Banco BNP Paribas Brasil S.A.
107 Banco BOCOM BBM S.A.
063 Banco Bradescard S.A.
036 Banco Bradesco BBI S.A.
394 Banco Bradesco Financiamentos S.A.
237 Banco Bradesco S.A.
218 Banco BS2 S.A.
208 Banco BTG Pactual S.A.
626 Banco C6 Consignado S.A.
336 Banco C6 S.A.
473 Banco Caixa Geral - Brasil S.A.
040 Banco Cargill S.A.
739 Banco Cetelem S.A.
233 Banco Cifra S.A.
745 Banco Citibank S.A.
M19 Banco CNH Industrial Capital S.A.
756 Banco Cooperativo Sicoob S.A.
748 Banco Cooperativo Sicredi S.A.
222 Banco Credit Agricole Brasil S.A.
505 Banco Credit Suisse (Brasil) S.A.
368 Banco CSF S.A.
003 Banco da Amazônia S.A.
083 Banco da China Brasil S.A.
707 Banco Daycoval S.A.
654 Banco Digimais S.A.
335 Banco Digio S.A.
001 Banco do Brasil S.A.
047 Banco do Estado de Sergipe S.A.
037 Banco do Estado do Pará S.A.
041 Banco do Estado do Rio Grande do Sul S.A.
004 Banco do Nordeste do Brasil S.A.
224 Banco Fibra S.A.
094 Banco Finaxis S.A.
125 Banco Genial S.A.
390 Banco GM S.A.
612 Banco Guanabara S.A.
M11 Banco IBM S.A.
012 Banco Inbursa S.A.
604 Banco Industrial do Brasil S.A.
077 Banco Inter S.A.
249 Banco Investcred Unibanco S.A.
184 Banco Itaú BBA S.A.
029 Banco Itaú Consignado S.A.
479 Banco ItauBank S.A
376 Banco J. P. Morgan S.A.
074 Banco J. Safra S.A.
217 Banco John Deere S.A.
630 Banco Letsbank S.A.
600 Banco Luso Brasileiro S.A.
243 Banco Master S.A.
389 Banco Mercantil do Brasil S.A.
370 Banco Mizuho do Brasil S.A.
746 Banco Modal S.A.
066 Banco Morgan Stanley S.A.
456 Banco MUFG Brasil S.A.
007 Banco Nacional de Desenvolvimento Econômico e Social - BNDES
212 Banco Original S.A.
623 Banco PAN S.A.
611 Banco Paulista S.A.
643 Banco Pine S.A.
747 Banco Rabobank International Brasil S.A.
633 Banco Rendimento S.A.
120 Banco Rodobens S.A.
422 Banco Safra S.A.
033 Banco Santander (Brasil) S.A.
743 Banco Semear S.A.
276 Banco Senff S.A.
366 Banco Société Générale Brasil S.A.
464 Banco Sumitomo Mitsui Brasileiro S.A.
082 Banco Topázio S.A.
634 Banco Triângulo S.A.
653 Banco Voiter S.A.
655 Banco Votorantim S.A.
610 Banco VR S.A.
119 Banco Western Union do Brasil S.A.
348 Banco XP S.A.
021 BANESTES S.A. Banco do Estado do Espírito Santo
755 Bank of America Merrill Lynch Banco Múltiplo S.A.
250 BCV - Banco de Crédito e Varejo S.A.
144 BEXS Banco de Câmbio S.A.
017 BNY Mellon Banco S.A.
128 Braza Bank S.A. Banco de Câmbio
070 BRB - Banco de Brasília S.A.
104 Caixa Econômica Federal
320 China Construction Bank (Brasil) Banco Múltiplo S.A.
477 Citibank N.A.
487 Deutsche Bank S.A. - Banco Alemão
062 Hipercard Banco Múltiplo S.A.
269 HSBC Brasil S.A. - Banco de Investimento
341 Itaú Unibanco S.A.
488 JPMorgan Chase Bank, National Association
399 Kirton Bank S.A. - Banco Múltiplo
254 Paraná Banco S.A.
751 Scotiabank Brasil S.A. Banco Múltiplo
014 State Street Brasil S.A. - Banco Comercial
095 Travelex Banco de Câmbio S.A.
129 UBS Brasil Banco de Investimento S.A.
回到页面顶部