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": "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"
}

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 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_PASSPORTID.
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.
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

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 and 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