Skip to content

Bank Transfer

Bank Transfer Payment

Create a Bank Transfer payment

HTTP Request

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 Details

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

Request Body Details

Parameter Required Type Description
idempotencyKey String Unique key to ensure idempotent requests
country String country code, enum value as BR
targetName String Target account holder full name
targetLastName String Target account holder Last Name
targetEmail String Target account holder email
targetPhone String Target account holder phone . ps: +55xxxxxxxxx
targetBirthDate String Target account holder BirthDate, format: yyyy-MM-dd
targetDocument String Target account holder identity, it can be a 11-digit CPF or a 14-digit CNPJ.
targetBankCode String Target Bank Code. three digits.see Supported Bank.
targetBankAgency String Target Bank Agency Code.
targetBankAccountId String Target Bank Account Id.
amount String DEPRECATED. The transfer amount. note: 1 = 1BRL. Please use amountInCents instead. amountInCents will be preferred if both exist.
amountInCents Long The transfer amount. note: 100 = 1BRL/1USD
currency String The currency code of the transferred fund. enum value as BRL, USD
callbackUrl String URL where Liquido will send notifications associated to changes to this payment. will receive a post request.
subMerchantId String The sub merchant ID. Required for PSPs.
riskData JSON The risk data of the payment. MERCHANT_APP_NAME or MERCHANT_WEBSITE must be provided in risk Data. Please see here for further details.

Create A Payment With Risk Data

Please see here for further details.

Response Body Details

Parameter Type Description
idempotencyKey String Unique key to ensure idempotent requests
statusCode Integer 200 Success, 401 Access denied, 422 Required fields missing or invalid data, 500 internal error
errorMsg String Error message if failed
transferStatus String Transfer status, SETTLED, IN_PROGRESS, FAILED or REJECTED. We should use transferStatus to judge the payment status
transferStatusCode Integer Transfer status code, TransferErrorCode
transferErrorMsg String Transfer error message if failed

Supported Bank

Bank ID Bank Name
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.
Back to top