Skip to content

Bank Transfer

Bank transfer is one of the popular payment methods in the Brazil market. For every bank transfer payment response, there’s a Liquido bank account which can be used by merchants to create a voucher for end customers to make transfer.

voucher

HTTP Request

POST /v1/payments/charges/bank_transfer

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Request Body
{
    "idempotencyKey": "1ec983fa-1a37-679b-809b-067861d87ab0",
    "amount": 100,
    "currency": "BRL",
    "country": "BR",
    "paymentMethod": " BANK_TRANSFER",
    "paymentFlow": "DIRECT",
    "payer": {
        "name": "Thiago Gabriel",
        "email": "thiago@example.com",
        "document": {
            "documentId": "53033315550",
            "type": "CPF"
        },
        "phone": "+55 81987654321",
        "billingAddress": {  
            "zipCode": "04849333",
            "state": "SP",
            "city": "sao paulo",
            "district": "Jardim Gaivotas",
            "street": "Rua 9 de setembro",
            "number": "15",
            "complement": "casa",
            "country": "BR"
        }
    },
    "orderInfo": {  
        "orderId": "test-order-id",  
        "shippingInfo": { 
            "name": "shipping test name",  
            "phone": "shipping phone",  
            "email": "thiago@example.com",
            "address": { 
                "street": "street name",
                "number": "building number",
                "complement": "unit, apt, etc.",
                "district": "district, neighborhood, etc.",
                "city": "city name",
                "state": "state, state code",
                "zipCode": "zip code, postal code",
                "country": "BR"
            }
        }
    },
    "callbackUrl": "http://api.client.com/notifications",
    "description": "hello world",
    "subMerchantId": "UUID"
}
Content-Type: application/json
{
    "transferStatusCode": 200,
    "transferErrorMsg": null,
    "idempotencyKey": "BankTransfer-20220909001",
    "referenceId": "BankTransfer-20220909001",
    "paymentMethod": "BANK_TRANSFER",
    "amount": 100,
    "currency": "BRL",
    "country": "BR",
    "finalAmount": 100,
    "finalCurrency": "BRL",
    "createTime": "2022-09-09 00:02:22 GMT-07:00",
    "scheduledTime": null,
    "finalStatusTime": null,
    "payer": {
        "name": "Thiago Gabriel",
        "document": {
            "documentId": "00740886967",
            "type": "CPF"
        },
        "email": "thiago@example.com",
        "phone": "+55 81987654321",
        "billingAddress": {
            "street": "street name",
            "number": "building number",
            "complement": "unit, apt, etc.",
            "district": "district, neighborhood, etc.",
            "city": "city name",
            "state": "state, state code",
            "zipCode": "zip code, postal code",
            "country": "BR"
        }
    },
    "transferStatus": "IN_PROGRESS",
    "description": "hello world",
    "callbackUrl": "https://api.liquido.com/v1/cashier/callback/",
    "transferDetails": {
        "bankTransfer": {
            "expirationTime": "2022-09-16 00:02:22 GMT-07:00",
            "bankAccountInfo": {
                "bankCode": "332",
                "beneficiaryName": "antonio silva",
                "bankAccountNumber": "286435",
                "bankAccountType": "CHECKING",
                "bankBranchId": "0001",
                "ispb": "13140088",
                "document": {
                    "documentId": "60131743007",
                    "type": "CPF"
                }
            }
        }
    },
    "subMerchantId": "UUID"
}

Notification / Callback

Content-Type: application/json
{
    "eventType": "CHARGE_SUCCEEDED",
    "data": {
        "chargeDetails": {
            "transferStatusCode": 200,
            "transferErrorMsg": null,
            "idempotencyKey": "BankTransfer-20220909001",
            "referenceId": "BankTransfer-20220909001",
            "paymentMethod": "BANK_TRANSFER",
            "amount": 100,
            "currency": "BRL",
            "country": "BR",
            "finalAmount": 100,
            "finalCurrency": "BRL",
            "createTime": "2022-09-09 00:02:22 GMT-07:00",
            "scheduledTime": null,
            "finalStatusTime": null,
            "payer": {
                "name": "Thiago Gabriel",
                "document": {
                    "documentId": "00740886967",
                    "type": "CPF"
                },
                "email": "thiago@example.com",
                "phone": "+55 81987654321",
                "billingAddress": {
                    "street": "street name",
                    "number": "building number",
                    "complement": "unit, apt, etc.",
                    "district": "district, neighborhood, etc.",
                    "city": "city name",
                    "state": "state, state code",
                    "zipCode": "zip code, postal code",
                    "country": "BR"
                }
            },
            "transferStatus": "IN_PROGRESS",
            "description": "hello world",
            "callbackUrl": "https://api.liquido.com/v1/cashier/callback/",
            "transferDetails": {
                "bankTransfer": {
                    "expirationTime": "2022-09-16 00:02:22 GMT-07:00",
                    "bankAccountInfo": {
                        "bankCode": "332",
                        "beneficiaryName": "antonio silva",
                        "bankAccountNumber": "286435",
                        "bankAccountType": "CHECKING",
                        "bankBranchId": "0001",
                        "ispb": "13140088",
                        "document": {
                            "documentId": "60131743007",
                            "type": "CPF"
                        }
                    }
                }
            },
            "subMerchantId": "UUID"
        }
    }
}

Request Headers Parameters

Key Value
Authorization "bearer" + " " + {{access_token}}
x-api-key {{api_key}}

Request Body Parameters

Parameter Required Type Description
idempotencyKey String Unique key to ensure idempotent requests. given by the merchant in their system.
amount Long The transfer amount, The minimum settlement granularity of the current currency, such as 100=1BRL
country String country code
currency String The currency code of the transferred fund
paymentMethod String payment method, enum value as BANK_TRANSFER
paymentFlow String payment flow, enum value as DIRECT or REDIRECT
payer JSON payer info
orderInfo JSON order info
description String description of payment
callbackUrl String URL where Liquido will send notifications associated to changes to this payment. will receive a post request.
sandboxStatus String DEBUG ONLY, used to specify the transfer status in response as following: APPROVED, DECLINED, ERROR
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.

Payer Object Parameters

Parameter Required Type Description
name String fullname(Input specification: Only a combination of uppercase and lowercase letters, numbers and spaces is allowed. Spanish and Portuguese letters, and other special characters are not allowed).
email String email.
document JSON payer's identity proof, CPF or CNPJ
phone String Mobile phone number. Should include “+55” as a prefix.
billingAddress JSON Billing address info.

Document Object Parameters

Parameter Required Type Description
documentId String identity number
type String enum of CPF or CNPJ

BillingAddress Object Parameters

Parameter Required Type Description
zipCode String zip code.
state String state.
city String city name.
street String street name.
number String street number.

OrderInfo Object Parameters

Parameter Required Type Description
orderId String order identity number
shippingInfo JSON shipping info

ShippingInfo Object Parameters

Parameter Required Type Description
name String shipping name
phone String Mobile phone number. Should include “+55” as a prefix.
email String email address
address JSON the same as billingAddress

Response Body Parameters

Parameter Type Description
transferStatus String Transfer status, SETTLED, IN_PROGRESS, FAILED
transferStatusCode Integer Transfer status code, 200 transaction SETTLED or IN_PROGRESS, other FAILED
transferErrorMsg String Transfer error message if failed
referenceId String Unique key to payment ticket, generated by Liquido.
idempotentKey String Unique key to ensure idempotent requests. given by the merchant in their system
amount Long The transfer amount
country String country code
currency String The currency code of the transferred fund
finalAmount Long The final amount that is used for creating the charge order. EX: for charge orders with FX conversion, this field represents the converted amount from the original requested amount.
finalCurrency String The currency code of the finalAmount.
paymentMethod String payment method, enum value as BANK_TRANSFER
payer JSON payer info
description String description of payment
callbackUrl String URL where Liquido will send notifications associated to changes to this payment. will receive a post request.
createTime String Payment ticket created time
scheduledTime String Payment ticket scheduled time
finalStatusTime String Transfer final status update time, final status include SETTLED, FAILED
subMerchantId String The sub merchant ID.
transferDetails JSON The transfer details that includes bankAccountInfo, and you can use it to create voucher for end customers.

TransferDetails Object Parameters

Parameter Type Description
bankTransfer JSON The bank transfer details

BankTransfer Object Parameters

Parameter Type Description
expirationTime String The expiration time of the payment
bankAccountInfo JSON The information of bank account

BankAccountInfo Object Parameters

Parameter Type Description
bankCode String The bankcode of the bank, 3 digits
beneficiaryName String The beneficiary name, such as BRL_LIQUIDO
bankAccountNumber String The beneficiary bank account number
bankBranchId String The beneficiary bank branch Id
bankAccountType String The beneficiary bank account type, such as ContaCorrente
ispb String The ISPB of the bank, used in the same way as the shorter bank code, 8 digits
document JSON payer's identity proof, CPF or CNPJ

Transfer Status

Parameter Description
IN_PROGRESS The transaction of this method has started, but no transactions have been processed yet.
SETTLED The funds of the transaction of this payment have been transferred to the store.
REFUNDING The transaction of this payment is refunding.
REFUNDED The transaction of this payment method has been refunded.
CHARGED_BACK The transaction of this payment has been reported as chargeback.
FAILED There was an error while processing the transaction of this payment. This status is followed by a message with more details about the error.

Notification Event Type

CHARGE_SUCCEEDED,
CHARGE_FAILED,
CHARGE_CHARGED_BACK,
CHARGE_REFUND_SUCCEEDED,
CHARGE_REFUND_FAILED;
Back to top