Payout

When performing a payout, the customer initiates a payout and then just waits for the funds to be credited to their account. The customer themself doesn't participate in the payout processing procedure.

Countries and regions Colombia
Payment currencies COP, USD
Payment amount limits Contact your key account manager at Monetix for details. Also you can check the payment amount limits in your project by using Dashboard.
Payment processing time Contact your key account manager at Monetix for details.
Currency conversion On the Monetix side
Refund
Onboarding and access fee Contact your key account manager at Monetix for details.

Operations support

Interfaces
Payment Page Gate Dashboard
Payout

You can check the payment amount limits in your project by using Dashboard. To check your payment amount limits, go to Dashboard, select the Projects section, and then click the Payment methods tab.

The following sections provide more information about the payment processing flow and the analysis of completed payments.

Payout by using Gate

General information

To perform a payout by using Gate with the Bank transfers in Colombia payment method:

  1. Send a request with all the required parameters and signature to the Monetix URL.
  2. Accept the callback with the payout result from the payment platform.

The following picture provides the details of the payout processing flow in the Bank transfers in Colombia payment method.

Figure 1. Payout processing flow when performing a payout by using Gate
  1. The customer initiates a payout in your system.
  2. Your system sends the payout request to the Monetix payment platform.
  3. The payment platform sends you a response in which it acknowledges your request and provides the request validation result. (For more information about the response format, see Response structure.)
  4. The payment platform processes the request and forwards it to the provider service.
  5. The provider service informs the payment platform about the payout result.
  6. The payment platform sends a callback with the payout result to your system.
  7. Your system sends the payout result to the customer.

Request

This section provides the instructions on how to build the request for payout with the Bank transfers in Colombia payment method.

HTTP request method POST
Request body format JSON
API endpoint/v2/payment/bank-transfer/colombia/payout
Full API endpoint specification /v2/payment/bank-transfer/{payment_method}/payout
Table 1. Basic parameters of a payout request

strictly required—the parameter must be in the initial request.

✱—the parameter may not be required in some cases. Contact your account manager at Monetix for details.
ObjectObject/Parameter Description

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

customer
object
strictly required

id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

ip_address
string
strictly required

IP address of the customer's device.

Example: 198.51.100.47

first_name
string
strictly required

Customer's first name.

Example: John

last_name
string
strictly required

Customer's last name.

Example: Doe

email
string
strictly required

Customer's email.

Example: johndoe@example.com

phone
string
strictly required✱

Customer's phone number linked to the bank account, 10 digits without a plus sign (+), spaces or punctuation.

Example: 1234567890

identify
object
strictly required

doc_number
string
strictly required

Number of the document proving your customer's identity.

Example: 1234567

doc_type
string
strictly required✱

Type of the document proving your customer's identity.

Possible values:

  • CC—Cédula de Ciudadanía—Citizenship Card
  • NIT—Número de Identificación Tributaria—The Colombia Unique Taxpayer Number

Example: CC

account
object
strictly required

number
string
strictly required

Account number which the customer uses to receive a payout or the mobile phone number linked to the customer's account. Refer to your key account manager at Monetix to find out what exactly you need to submit in this parameter.

Example: 1234567890

type
string
strictly required✱

Customer's account type.

Possible values:

  • CACC—Current Account
  • SVGS—Savings Account

Example: CACC

bank_id
integer
strictly required✱

Customer's bank ID. For information on how to get the list of the supported banks IDs, see Banks available for payout.

Example: 12345

payment
object
strictly required

currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

Example: COP

amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency codes.

Example: 100.00 COP must be sent as 10000

You can also add any other optional parameters to the payout request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from a request to initiate a payout with the Bank transfers in Colombia payment method:

Figure 2. Example of the payout request body
{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com",
        "phone": "1234567890",
        "identify": {
            "doc_number": "1234567",
            "doc_type": "CC"
        }
    },
    "account": {
        "number": "1234567890",
        "type": "CACC",
        "bank_id": 12345
    },
    "payment": {
        "currency": "COP",
        "amount": 10000
    }
}

Callback

In the Bank transfers in Colombia payment method, the payment platform returns the payout result in a callback. For the information about the callback structure, see Callbacks in Gate.

The following is an example of a callback body with the information about a successfully completed payout.

Figure 3. Example of the data from a successful payout callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "payout",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Bank transfer Colombia",
        "sum": {
            "amount": 10000,
            "currency": "COP"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "payout",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "COP"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "COP"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined payout.

Figure 4. Example of the data from a declined payout callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "payout",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Bank transfer Colombia",
        "sum": {
            "amount": 10000,
            "currency": "COP"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "payout",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "COP"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "COP"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Related topics

Banks available for payout

Supported banks

In the Bank transfers in Colombia payment method, payments are performed through the banks the payment method supports. For the payout to be performed, your request must contain the ID of the customer's bank in the account.bank_id parameter.

The table below lists the banks available for payout in the Bank transfers in Colombia payment method.

Table 2. Banks available for payout
BankID
Banca Digital Nequi74532
Banco Agrario70992
Banco AV Villas71002
Banco Caja Social BCSC SA71012
Banco Colpatriam71022
Banco Compartir S.A.71032
Banco Cooperativo Coopcentral71042
Banco Corpbanca Colombia S.A71052
Banco Davivienda SA71062
Banco de Bogotá71072
Banco de Comercio Exterior71082
Banco de las Microfinanzas Bancamia S.A.71092
Banco de Occidente71102
Banco Falabella S.A71112
Banco Finandina S.A71122
Banco GNB Sudameris71132
Banco Multibank S.A71152
Banco Mundo Mujer S.A.71162
Banco Pichincha71182
Banco Popular71192
Banco Procredit Colombia71202
Banco Santander de Negocios Colombia S.A.71212
Banco Serfinanza S.A.71222
Banco W S.A.71232
Bancolombia71142
Bancoomeva71172
BBVA Colombia71242
Citibank71252
Coltefinanciera S.A71262
Confiar Cooperativa Financiera71272
Cooperativa Financiera de Antioquia71282
Cootrafa Cooperativa Financiera71292
Daviplata71302
Financiera Juriscoop Compañía de Financiamiento71312
Giros y Finanzas CF71322
Itaú Corpbanca Colombia S.A.71332

The table with the list of banks is provided for informational purposes only. It may change without notice. To get the current list of banks the Bank transfers in Colombia payment method supports, contact your key account manager at Monetix.