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": "CO",
"targetName": "Test Name",
"targetEmail": "test@example.com",
"targetDocument": "0000000",
"targetDocumentType": "CC",
"targetBankCode": "1040",
"targetBankAccountId": "0000000001",
"targetBankAccountType": "SAVINGS",
"amountInCents": 10000,
"currency": "COP",
"comment": "transfer payout test",
"callbackUrl": "https://api.client.com/callback/",
"subMerchantId": "UUID"
}
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 CO | |
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: +57xxxxxxxxx | |
targetBirthDate | String | Target account holder BirthDate, format: yyyy-MM-dd | |
targetDocument | String | Target account holder identity | |
targetDocumentType | String | Target account holder identity type.CC, TI, NIT, CE, COLOMBIA_PASSPORT_ID. CC -> Adult Colombia Citizen ID TI -> Child Colombia Citizen ID NIT -> Company Tax ID CE -> Colombia Foreigner ID COLOMBIA_PASSPORT_ID -> Passport |
|
targetBankCode | String | Target bank code.see Supported Bank. | |
targetBankAgency | String | Target bank agency code. | |
targetBankAccountId | String | Target bank account ID. | |
targetBankAccountType | String | Target bank account type.CHECKING, SAVINGS. | |
amountInCents | Long | The transfer amount. note: 100 = 1COP | |
currency | String | The currency code of the transferred fund. enum value as COP | |
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 and 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 Code | Bank Name |
---|---|
1040 | AGRARIAN BANK |
1031 | BANCOLDEX S.A. |
1007 | BANCOLOMBIA |
1061 | BANCOOMEVA |
1059 | BANCAMIA S.A. |
1805 | BANCO BTG PACTUAL |
1051 | BANCO DAVIVIENDA S.A. |
1071 | BANCO J.P. MORGAN COLOMBIA S.A |
1052 | BANCO OF VILLAS |
1065 | BANCO SANTANDER DE NEGCIOS CO |
1053 | BANCO W S.A. |
1062 | BANK FALABELLA SA |
1063 | BANK FINANDINA S.A. |
1012 | BANK GNB SOUTH AMERIS |
1001 | BANK OF BOGOTA |
1069 | BANK SERFINANZA SA |
1013 | BBVA COLOMBIA |
1064 | BANCO MULTIBANK S.A. |
1058 | BANCO PROCREDIT COL |
1808 | BOLD CF |
1032 | CAJA SOCIAL BANK BCSC SA |
1009 | CITIBANK |
1370 | COLTEFINANCIERA SA |
1066 | COOPCENTRAL COOPERATIVE BANK |
1289 | COOTRAFA COOPERATIVE FINANCIAL |
1558 | CREDIFINANCIERA BANK SA. |
1812 | COINK |
1551 | DAVIPLATA |
1802 | DING TECNIPAGOS SA |
1303 | DRAFT AND FINANCES CF |
1283 | FINANCIAL COOPERATIVE OF ANTI |
1121 | FINANCIAL JURISCOOP SA COMP |
1814 | GLOBAL66 |
1010 | HSBC |
1637 | IRIS |
1014 | ITAU |
1006 | ITAU before Corpbanca |
1286 | JFK FINANCIAL COOPERATIVE |
1070 | LULO BANK SA |
1067 | MIBANCO S.A. |
1801 | MOVE |
1507 | NEQUI |
1809 | NU |
1060 | PICHINCHA BANK |
1560 | PIBANK |
1803 | POWWI |
1811 | RAPPIPAY |
1002 | POPULAR BANK |
1019 | SCOTIABANK COLPATRIA SA |
1292 | TRUST |
1804 | WALA |
1023 | WESTERN BANK |
1047 | WOMEN'S WORLD BANK |