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": "PE",
"targetName": "Test Name",
"targetDocument": "0000000",
"targetDocumentType": "RUC",
"targetBankAccountId": "0000000001",
"targetBankAccountType": "SAVINGS",
"amountInCents": 10000,
"currency": "PEN",
"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 PE | |
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: +51xxxxxxxxx | |
targetBirthDate | String | Target account holder BirthDate, format: yyyy-MM-dd | |
targetDocument | String | Target account holder identity | |
targetDocumentType | String | Target account holder identity type.DNI, RUC, PERU_CE, PERU_PASSPORT_ID. DNI -> National Identity Document RUC -> Unique Taxpayer Registry PERU_CE -> National Identity Card PERU_PASSPORT_ID -> Passport |
|
targetBankAccountId | String | Target bank account ID. | |
targetBankAccountType | String | Target bank account type.CHECKING, SAVINGS. | |
amountInCents | Long | The transfer amount. note: 100 = 1PEN | |
currency | String | The currency code of the transferred fund. enum value as PEN | |
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
Support all PERUVIAN banks with the CCI 20 digit account