Alternative Payment Methods

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

Info

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

PagoEfectivo Ecuador

PagoEfectivo provides a network of physical payment centers where your customers can pay their purchases in cash or using their bank app. Your customer can pay giving the debt identifier (CIP) in a physical payment office or using their bank app.

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
`PaymentMediaId`	`numeric`	Yes	The `PaymentMediaId` for this payment method is 29.
`TargetCountryISO`	`string`	Yes	Indicate the destination country.
`Customer` → `Email`	`string`	Yes	Customer’s email.
`Customer` → `FirstName`	`string`	Yes	Customer’s first name.
`Customer` → `LastName`	`string`	Yes	Customer’s last name.
`Customer` → `DocumentTypeId`	`numeric`	Yes	Customer’s document type. Refer to the Document types table to see the possible values.
`Customer` → `DocNumber`	`string`	Yes	Customer’s Document Number.
`Customer` → `PhoneNumber`	`string`	Yes	Customer’s phone number. The phone number format must be `<characteristic>\|<number>`. Example: `+593\|971516229`.
`Customer` → `BillingAddress` → `Country`	`string`	No	Customer’s Country.
`Customer` → `BillingAddress` → `State`	`string`	No	Customer’s State.
`Customer` → `BillingAddress` → `City`	`string`	No	Customer’s City.
`Customer` → `BillingAddress` → `AddressDetail`	`string`	No	Customer’s Address Detail.
`Customer` → `BillingAddress` → `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. The expiration date must be at least 10 minutes and less than six months from the current date (in UTC GMT -5).

Request example

{
    "PaymentMediaId": "29",
    "Amount": 1000,
    "MetadataIn": {
        "PaymentExpirationInMinutes": "1440"
    },
    "Currency": "USD",
    "TargetCountryISO": "EC",
    "Capture": true,
    "Customer": {
        "Email": "lvargas@mail.com",
        "FirstName": "Luis",
        "LastName": "Vargas",
        "PhoneNumber": "+593|971516229",
        "DocNumber": "12345672",
        "DocumentTypeId": 10
    },
    "Description": "Prueba Ecuador Cash"
}

Response parameters

In the response, you will find the following parameters:

Property	Type	Description
`Response` → `MetadataOut` → `PaymentCode`	`string`	Payment code generated by PagoEfectivo.
`Response` → `MetadataOut` → `PaymentExpirationDate`	`date`	Date when the CIP will expire. Format ISO 8601.
`Response` → `MetadataOut` → `PaymentUrl`	`string`	URL of the HTML document of the CIP.

PrintScreen

Response example

{
    "Response": {
        "PurchaseId": 6820007,
        "Created": "2023-06-16T13:30:33.527",
        "TrxToken": null,
        "Order": null,
        "Transaction": {
            "TransactionID": 10597785,
            "Created": "2023-06-16T13:30:33.527",
            "AuthorizationDate": "",
            "TransactionStatusId": 2,
            "Status": "Pending",
            "ErrorCode": null,
            "Description": "",
            "ApprovalCode": null,
            "Steps": [
                {
                    "Step": "Pago Efectivo Ecuador Get Token",
                    "Created": "2023-06-16T13:30:33.760",
                    "Status": "Get Token OK",
                    "ResponseCode": "100",
                    "ResponseMessage": "Solicitud exitosa.",
                    "Error": "",
                    "AuthorizationCode": null,
                    "UniqueID": null,
                    "AcquirerResponseDetail": null
                },
                {
                    "Step": "Pago Efectivo Ecuador Generate CIP",
                    "Created": "2023-06-16T13:30:33.840",
                    "Status": "PhysicalNetwork Pending",
                    "ResponseCode": "100",
                    "ResponseMessage": "Solicitud exitosa.",
                    "Error": "",
                    "AuthorizationCode": null,
                    "UniqueID": null,
                    "AcquirerResponseDetail": "{'code':'100','message':'Solicitud exitosa.','cip':'166358610','operationNumber':null}"
                }
            ]
        },
        "Capture": true,
        "Amount": 1000,
        "OriginalAmount": 1000,
        "TaxableAmount": 0,
        "Tip": 0,
        "Installments": 1,
        "Currency": "USD",
        "Description": "Prueba Ecuador Cash",
        "Customer": {
            "CustomerId": 2989883,
            "Created": "2023-06-16T13:30:32.383",
            "CommerceCustomerId": null,
            "Owner": "Anonymous",
            "Email": "lvargas@mail.com",
            "Enabled": true,
            "ShippingAddress": null,
            "BillingAddress": null,
            "Plans": null,
            "AdditionalData": null,
            "PaymentProfiles": [
                {
                    "PaymentProfileId": 2980262,
                    "PaymentMediaId": 29,
                    "Created": "2023-06-16T13:30:32.400",
                    "LastUpdate": "2023-06-16T13:30:32.727",
                    "Brand": "PagoEfectivoEcuador",
                    "CardOwner": null,
                    "Bin": null,
                    "IssuerBank": null,
                    "Installments": null,
                    "Type": "PhysicalNetwork",
                    "IdCommerceToken": 0,
                    "Token": null,
                    "Expiration": null,
                    "Last4": "",
                    "Enabled": null,
                    "DocumentNumber": "12345672",
                    "DocumentTypeId": 10,
                    "ExternalValue": null,
                    "AffinityGroup": null
                }
            ],
            "CaptureURL": null,
            "UniqueID": null,
            "URL": "https://api.siemprepago.com/v1/api/Customer/2989883",
            "FirstName": "Luis",
            "LastName": "Vargas",
            "DocNumber": "12345672",
            "DocumentTypeId": 10,
            "PhoneNumber": "+593|971516229",
            "ExternalValue": null
        },
        "RefundList": null,
        "PlanID": null,
        "UniqueID": null,
        "AdditionalData": null,
        "CustomerUserAgent": null,
        "CustomerIP": null,
        "URL": "https://api.siemprepago.com/v1/api/Purchase/6820007",
        "DataUY": {
            "IsFinalConsumer": false,
            "Invoice": null,
            "TaxableAmount": 0
        },
        "DataDO": {
            "Invoice": null,
            "Tax": 0
        },
        "Acquirer": {
            "AcquirerID": 67,
            "Name": "Pago Efectivo Ecuador",
            "CommerceNumber": null
        },
        "CommerceAction": null,
        "PurchasePaymentProfileId": 2980262,
        "LoyaltyPlan": null,
        "DeviceFingerprintId": null,
        "MetadataIn": {
            "PaymentExpirationInMinutes": "1440"
        },
        "MetadataOut": {
            "PaymentCode": "166358610",
            "PaymentExpirationDate": "2023-06-17T08:30:33-05:00",
            "PaymentUrl": "https://payment.pagoefectivo.pe/A222B8A6-740A-4E75-8431-CA3B3E873180.html"
        },
        "CrossBorderData": null,
        "CrossBorderDataResponse": {
            "TargetCountryISO": "EC",
            "TargetCurrencyISO": "USD",
            "TargetAmount": 10.0
        },
        "Redirection": null,
        "AntifraudData": null,
        "PaymentMediaId": null,
        "TargetCountryISO": null,
        "PurchaseType": 1,
        "IsFirstRecurrentPurchase": false
    },
    "Errors": []
}

Last modified December 20, 2024