Bank Transfer
Bank Transfer
Transfer the funds from digital wallet to an external bank institution.
HTTP Request
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"
}
Key |
Value |
Content-Type |
application/json |
Accept |
application/json |
Authorization |
"bearer"+ "" + {{access_token}} |
PATH Parameters
Parameter |
Required |
Type |
Description |
walletId |
|
String |
The walletId which was returned by API createWallet |
Request Body Parameters
Parameter |
Required |
Type |
Description |
idempotencyKey |
|
String |
Unique key to ensure idempotent requests |
targetName |
|
String |
Target account holder full name |
targetDocument |
|
String |
Target bank account holder identity, such as CPF for Brazil |
targetBankName |
|
String |
Target bank name |
targetBankCode |
|
String |
Target bank code |
targetBankBranchId |
|
String |
Target bank branch id |
targetBankAccountId |
|
String |
Target bank account id |
amount |
|
String |
The transfer amount |
currency |
|
String |
The currency of the transferred fund |
Response Body Details
Parameter |
Type |
Description |
statusCode |
int |
200 Success, 401 Access denied, 422 Required fields missing or invalid data, 500 internal error |
errorMsg |
String |
error message if failed |
transactionId |
String |
The transaction id |
transferStatus |
String |
Transfer status, settled, in progress or failed |