Cash Payments

Learn how to integrate your solution to process payments with cash collection networks.

Info

The purchase status for Cash collection networks will remain Pending until the customer completes the payment.

Cash collection networks

Using this payment method, your customer can go to a Cash collection network and complete the payment using the generated reference number.

Networks

You can offer your customer the possibility to pay using cash in the following networks:

	PaymentMethod	Description
	`BCP`	BCP
	`ARC`	Caja Arequipa
	`CSC`	Caja Cusco
	`HCC`	Caja Huancayo
	`ICC`	Caja Ica
	`PIC`	Caja Piura
	`TNC`	Caja Tacna
	`TRC`	Caja Trujillo
	`IBC`	Interbank
	`WUC`	Western Union
	`BBV`	BBVA

Request parameters

You need to include specific fields for this payment method to work correctly. Check the Purchase operation article for details on authentication, languages of the response, and basic purchase parameters such as amount and currency.

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`	No	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.

Request example

{
	"PaymentMethod": "BCP",
    "Order": "CH2023-001",
	"Amount": 100,
    "Currency": "PEN",
    "TargetCountryISO": "PE",
    "Customer": {
        "FirstName": "Joao",
        "LastName": "Silva",
        "ReferenceCode": "JS-001",
        "PhoneNumber":"936023105"
        "DocumentNumber": "12345678901",
        "DocumentType": "DNI.PE",
        "Email": "joao.silva@example.com",
        "Address": {
            "Country": "PE",
            "City": "Lima",
            "State": "SP",
            "PostalCode": "01310-200",
            "AddressDetail": "Avenida Paulista 1000"
        }
    },
	"MetaDataIn": {
        "PaymentExpirationInMinutes": "1440"
    }
}

Response parameters

In the response, you will find the following parameters:

Property	Type	Description
`Response` → `MetadataOut` → `PaymentUrl`	`string`	URL of the payment information.
`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": "135483816503424192",
    "Result": "COMPLETED",
    "Status": "PENDING",
    "ErrorCode": null,
    "ErrorDescription": null,
    "Created": "2025-01-08T20:44:19.039",
    "AuthorizationDate": "2025-01-08T20:44:19.088",
    "AuthorizationCode": "429801",
    "Amount": 378,
    "Currency": "PEN",
    "Installments": 1,
    "TaxableAmount": null,
    "Tip": null,
    "Url": "https://api.stage.bamboopayment.com/Purchase/135483816503424192",
    "MetadataOut": {
        "AuthorizationCode": "429801",
        "OperationId": "345231",
        "TransactionNumber": "802092"
    },
    "Action": null,
    "PaymentMethod": {
        "Brand": "Bcp",
        "CardOwner": null,
        "Bin": null,
        "IssuerBank": null,
        "Type": "PhysicalNetwork",
        "Expiration": null,
        "Last4": null
    }
}

Last modified January 20, 2025