Cash Payments

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

Info

The purchase status for cash payment methods will remain Pending until the customer completes payment either in a physical payment office.

Cash

The Cash payment method allows your customers to generate a coupon and complete the payment in a physical payment office.

Cash acquirers

	PaymentMethod	Acquirer
	`ABT`	Abitab
	`RDP`	RedPagos

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	Send the `PaymentMethod` according to the selected Cash acquirer in this table.
`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`	Yes	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": "RDP",
    "Order": "ORD1",
    "Amount": 2000,
    "Description":"Test transaction",
    "TargetCountryISO": "UY",
    "MetadataIn": {
        "PaymentExpirationInMinutes": "1440"
    },
    "Currency": "USD",
    "Capture": true,
    "Customer": {
        "Email": "testuser@mail.com",
        "Address": {
          "Country": "Uruguay",
          "State": "Montevideo",
          "City": "Montevideo",
          "AddressDetail": "La Paz 1020"
        },
        "FirstName" : "Mark",
        "LastName": "Doe",
        "DocumentNumber" : "12345672",
        "DocumentType": "CI.UY",
        "PhoneNumber" : "099111222"
    }
}

Response parameters

In the MetadataOut.PaymentBarcodeUrl parameter, the response returns the coupon in PDF format that the client must present in the agency to pay the generated debt.

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

Response example

{
    "TransactionId": "135849282501621568",
    "Result": "COMPLETED",
    "Status": "PENDING",
    "ErrorCode": null,
    "ErrorDescription": null,
    "Created": "2025-01-09T20:56:32.924",
    "AuthorizationDate": "2025-01-09T20:56:38.378",
    "AuthorizationCode": null,
    "Amount": 87302,
    "Currency": "UYU",
    "Installments": 1,
    "TaxableAmount": null,
    "Tip": null,
    "Url": "https://api.stage.bamboopayment.com/Purchase/135849282501621568",
    "MetadataOut": {
        "CouponValidity": "20250110",
        "PaymentBarcodeUrl": "https://gateway.stage.bamboopayment.com/purchase-coupons/PW_234375_20250110.pdf"
    },
    "Action": null,
    "PaymentMethod": {
        "Brand": "RedPagos",
        "CardOwner": null,
        "Bin": null,
        "IssuerBank": null,
        "Type": "PhysicalNetwork",
        "Expiration": null,
        "Last4": null
    }
}

Last modified January 27, 2025