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": "GWi6x680043558714428216",
    "country": "BR",
    "targetName": "Luiz Carlos",
    "targetEmail": "Patoshowp@gmail.com",
    "targetDocument": "97198102549",
    "targetBankCode": "036",
    "targetBankAgency": "3563",
    "targetBankAccountId": "72346",
    "amountInCents": 150,
    "currency": "BRL"
}

Response

Content-Type: application/json
{
    "statusCode": 200,
    "errorMsg": "",
    "transactionId": "",
    "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, CPF 11 digits
targetBankCode String Target Bank Code. three digits.
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

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, FAILED or REJECTED. We should use transferStatus to judge the payment status
transferStatusCode int Transfer status code, TransferErrorCode
transferErrorMsg String Transfer error message if failed
Back to top