Cash Payments

Learn how to integrate your solution to process Cash payments in Colombia.

The Cash payment method allows your customers to generate a payment voucher and complete the payment at a physical payment location.

Payment Networks

The following networks are available for cash payments.

Logo	PaymentMethod	Description
	`APC`	Apostar
	`BCC`	Bancolombia
	`EFC`	Efecty
	`GNC`	Gana
	`PNC`	Puntored
	`SPC`	Superpagos
	`SRC`	SuRed
	`SSC`	SuSuerte

Request parameters

To process cash payments, you need to include specific fields in your request. For information about authentication, response languages, and basic purchase parameters such as amount and currency, please refer to the Purchase operation article.

Property	Type	Mandatory?	Description
`PaymentMethod`	`string`	Yes	Find the value in the table Payment Method.
`TargetCountryISO`	`string`	Yes	Indicate the destination country.
`Customer` → `Email`	`string`	Yes	Customer’s email.
`Customer` → `FirstName`	`string`	No	Customer’s first name.
`Customer` → `LastName`	`string`	No	Customer’s last name.
`Customer` → `DocumentType`	`string`	No	Customer’s document type. Refer to the Document types table to see the possible values.
`Customer` → `DocumentNumber`	`string`	Yes	Customer’s Document Number.
`Customer` → `PhoneNumber`	`string`	No	Customer’s phone number.
`Customer` → `Address` → `Country`	`string`	No	Customer’s Country.
`Customer` → `Address` → `State`	`string`	No	Customer’s State.
`Customer` → `Address` → `City`	`string`	No	Customer’s City.
`Customer` → `Address` → `AddressDetail`	`string`	No	Customer’s Address Detail.
`Customer` → `Address` → `PostalCode`	`string`	No	Customer’s Postal Code.
`MetaDataIn` → `PaymentExpirationInMinutes`	`numeric`	No	Configure the expiration time for the payment using this field, specifying the duration in minutes. The API applies a default value if you don’t provide this information.

Considerations

Colombian Pesos (COP) does not support decimal amounts; all values will be rounded.
The amount parameter must include two zeros as decimal places. For example, COP 5,000 should be sent as 500000.

The purchase status for Alternative Payment methods will remain Pending until the customer completes the payment at a physical location.

Request example

{
    "PaymentMethod": "EFC",
    "Order": "CH2023-001",
    "Amount": 100000,
    "Currency": "COP",
    "Description": "Purchase Test",
    "TargetCountryISO": "CO",
    "Customer": {
        "FirstName": "Joao",
        "LastName": "Silva",
        "Email": "joao.silva@example.com",
        "DocumentType":"CC.CO",
        "DocumentNumber":"12345672",
        "PhoneNumber":"3188060418",
        "ReferenceCode":"123123"  
    },
    "MetaDataIn": {
        "PaymentExpirationInMinutes": "7200"
    }
}

Response parameters

The response will include the following parameters:

Property	Type	Description
`Response` → `Action` → `URL`	`string`	URL of the payment voucher to be presented by your customer at the physical network.
`Response` → `MetadataOut` → `PaymentCode`	`string`	Payment reference returned by the acquirer to identify the order generated.
`Response` → `MetadataOut` → `PaymentExpirationDate`	`date`	Date when the payment will expire. Format DD/MM/YYYY.
`Response` → `MetadataOut` → `AgreementCode`	`string`	Agreement number between the acquirer and the physical network.

For more information on the response parameters, please refer to the Response parameters section of the Purchase creation.

Response example

{
    "TransactionId": "79632697147789184",
    "Result": "ACTION_REQUIRED",
    "Status": "PENDING",
    "ErrorCode": null,
    "ErrorDescription": null,
    "Created": "2024-08-07T17:51:54.620",
    "AuthorizationDate": null,
    "AuthorizationCode": null,
    "Amount": 100000,
    "Currency": "COP",
    "TaxableAmount": null,
    "Tip": null,
    "Url": "https://api.stage.bamboopayment.com/Purchase/79632697147789184",
    "MetadataOut":{
        "PaymentCode": "6273036",
        "PaymentExpirationDate": "22/08/2023",
        "AgreementCode": "110342"
    },
    "Action": {
        "URL": "https://s3.amazonaws.com/gateway.stage.bamboopayment.com/purchase-coupons/1131277_691e4de3-6eda-43ce-a01d-a6ea539d70fe_20231117.html",
        "Reason": "REDIRECTION_NEEDED_EXTERNAL_SERVICE"
    },
     "PaymentMethod": {
        "Brand": "PayvalidaCashPFCO",
        "CardOwner": null,
        "Bin": null,
        "IssuerBank": null,
        "Type": "PhysicalNetwork",
        "Expiration": null,
        "Last4": null
    }
}

Last modified December 20, 2024