Skip to main content

Payretailers

Introduction​

Payretailers is a service where the users receive a payment reference that allows them to make a payment using PSE, EFECTY and PAGO_FACIL. It also accepts pay-outs. It can be used both in the Paylands checkout and redirection method.

Restrictions and requirements​

Currently only the following currencies are supported: USD, ARS, COP, PEN.

Extra data required​

When generating the payment order, these fields must be provided for checkout and redirection payments:

  • Profile: first_name, last_name, email, document_identification_number, phone
  • Billing_address: city, country, zip_code, address1

For payouts:

  • Profile: first_name, last_name, email, document_identification_number, phone.
  • Billing_address: city, country, zip_code, address1
  • Payment: bank_name, recipient_pix_key, account_agency_number, awa_swift

Example:

"extra_data": {
    "checkout": {
        "uuid": "C42043F9-B77C-4918-BD43-86C526B4F24D"
    },
    "profile": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@gmail.com",
        "document_identification_number": "92309089",
        "phone": {
            "number": "02614235138",
            "prefix": "54"
        }
    },
    "billing_address": {
        "city": "Castellon",
        "country": "COL",
        "address1": "Avinguda del Mar 23",
        "zip_code": "12000",
        "state_code": "CT"
    },
    "payment": {
        "bank_name": "Banco do Brasil S.A.",
        "recipient_pix_key": "111111111",
        "account_agency_number": "001",
        "awa_swift": "1234"
    }
}

PSE and Efecty​

Both PSE and EFECTY alternative payment methods (apm) are available using Paylands' checkout and redirection methods. Both methods are only accepted in Colombia and using Colombian pesos or USD.

Example:

"extra_data": {
    "checkout": {
        "uuid": "C42043F9-B77C-4918-BD43-86C526B4F24D"
    },
    "profile": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@gmail.com",
        "document_identification_number": "92309089",
        "phone": {
            "number": "02614235138",
            "prefix": "54"
        }
    },
    "billing_address": {
        "city": "Castellon",
        "country": "COL",
        "address1": "Avinguda del Mar 23",
        "zip_code": "12000",
        "state_code": "CT"
    }
}

Pago Fácil​

This payment method is also available using Paylands' checkout and redirection method. This method is only available in Argentina and using Argentinean pesos or USD currency.

Example:

"extra_data": {
    "checkout": {
        "uuid": "C42043F9-B77C-4918-BD43-86C526B4F24D"
    },
    "profile": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@gmail.com",
        "document_identification_number": "92309089",
        "phone": {
            "number": "02614235138",
            "prefix": "54"
        }
    },
    "billing_address": {
        "city": "Castellon",
        "country": "ARG",
        "address1": "Avinguda del Mar 23",
        "zip_code": "12000",
        "state_code": "CT"
    }
}

Khipu payment​

To make a payment with Khipu apm, we can opt for two flows, both redirection and checkout. This method is only accepted in Argentina and Peru, so the country must be ['ARG', 'PER'] and using the currency of Argentine pesos (ARS), Peruvian soles (PEN) or USD. Currently in our sandbox environment, it can only be tested for Peru.

Example:

"extra_data": {
    "checkout": {
        "uuid": "C42043F9-B77C-4918-BD43-86C526B4F24D"
    },
    "profile": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@gmail.com",
        "document_identification_number": "92309089",
        "phone": {
            "number": "02614235138",
            "prefix": "54"
        }
    },
    "billing_address": {
        "city": "Castellon",
        "country": "PE",
        "address1": "Avinguda del Mar 23",
        "zip_code": "12000",
        "state_code": "CT"
    }
}

Limits for transactions

The following table reflects the transaction limits based on business type, user and country:

CountryCash limit per user per dayCash limit per user per monthOnline limit per user per dayOnline limit per user per monthCredit Card limit per user per dayCredit Card limit per user per month
Ecuador2.000 USD30.000 USD35.000 USD80.000 USDNot availableNot available
Perú2.000 USD30.000 USD35.000 USD80.000 USDNot availableNot available
México2.000 USD30.000 USD35.000 USD80.000 USDNot availableNot available
Panamá2.000 USD30.000 USD35.000 USD80.000 USDNot availableNot available
El Salvador2.000 USD30.000 USD35.000 USD80.000 USDNot availableNot available
Nicaragua2.000 USD30.000 USD35.000 USD80.000 USDNo disponibleNot available
Costa Rica2.000 USD30.000 USD35.000 USD80.000 USD2.500 USD7.000 USD
Chile2.000 USD30.000 USD35.000 USD80.000 USD35.000 USD80.000 USD
Brazil10.000 USD30.000 USD35.000 USD80.000 USDNot availableNot available
Guatemala2.000 USD8.000 USDNot availableNot availableNot availableNot available
Colombia10.000 USD30.000 USD35.000 USD80.000 USD2.500 USD7.000 USD
Argentina10.000 USD30.000 USD35.000 USD80.000 USD2.500 USD7.000 USD

Limits for payouts

The following table reflects the transaction limits based on business type, user and country:

CountryLimit per dayLimit per weekLimit per monthLimit per yearLimit per transaction
Brazil10.000 USD70.000 BRL150.000,00 BRLNo limitNo limit
Argentina5.000 USDNo limit20.000 USDNo limitNo limit
México5.000 USDNo limit20.000 USDNo limitNo limit
Chile5.000 USDNo limit20.000 USDNo limitNo limit
Colombia5.000 USDNo limit20.000 USDNo limit10.000.000 COP
Perú3.500 USDNo limit7.000 USD84.000 USDNo hay
Ecuador3.500 USDNo limit7.000 USD84.000 USDNo limit

Transaction errors

With this table we reflect possible errors that may arise in the payment process:

Error MessageMeaning
PAYMENT_METHOD_NOT_ALLOWEDThe payment method ID used in the request is not active or enabled, and cannot be used.
PAYMENT_PSP_ERRORGeneric error message received from the PSP, normally originated from a timeout on the PSP side in high traffic instances.
PERSONAL_ID_VALIDATION_FAILEDThe PersonalID doesn't exist or belongs to a minor, deceased individuals or PEP and associates. Also the payment will be blocked if the PersonalID is related to any international lists of money laundering and/or terrorist financing.
TRANSACTION_INVALID_FIELD_LANGUAGEThe "Language" field of the request contains an invalid language value.
TRANSACTION_INVALID_FIELD_CURRENCYThe "Currency" field contains an unsupported or invalid currency value.
TRANSACTION_INVALID_FIELD_COUNTRYThe "Country" field contains an unsupported or invalid country value.
TRANSACTION_INVALID_EMAILThe "Email" field contains an invalid value(normally due to email syntax).
TRANSACTION_INVALID_CPF(Brazil only) the "personalID" field contains an invalid value.
TRANSACTION_MIN_AMOUNTThe “Amount” field contains a value that is below the minimum limit for the requested payment method.
TRANSACTION_MAX_AMOUNTThe “Amount” field contains a value that exceeds the maximum limit for the requested payment method.
INVALID_AMOUNTThe value sent for “amount” is not an integer.
TRANSACTION_REQUIRED_COUNTRYThe "Country" parameter is empty.
TRANSACTION_REQUIRED_CURRENCYThe "Currency" parameter is empty.
TRANSACTION_BLOCKED BY_CUSTOMER_LIMIT_RULEThe daily/monthly limit of transaction attempts for this customer has been reached, and no transactions can be generated for the customer until the next day/week/month.
CUSTOMER_COMPLIANCE_VALIDATION_FAILED(Brazil only) the "personalID" field contains a non-existent CPF.
MERCHANT_COMPLIANCE VALIDATION_ERRORIf one of your users is blocked with this error message please expose your case on our Freshdesk.
PAYMENT_PSP_ERRORGeneric error message received from the payment partner PSP, usually comes from a timeout on PSP’s side in high traffic instances.
TRANSACTION_CREATION_ERRORThe payment method used in the request is not active and cannot be used. Shop credentials have been disabled.
PAYMENT_AMOUNT_NOT_EQUALThe paid amount differs from the original amount or QR amount.
PAYER_CPF_NOT_EQUALThe payer's document number(CPF) does not match the buyer's document number.
CORPORATE_BANK_ACCOUNT_PAYMENT_NOT_ALLOWEDThe transaction was paid from a corporate bank account.
PAYMENT_COMPLIANCE_VALIDATION_FAILEDThe transaction was paid from a corporate bank account.
CUSTOMER_INVALID_AGEUnderaged.
CUSTOMER_INVALID_AGE_NULLPayer age not available.
CUSTOMER_INVALID_STATUSCPF is not valid/ active (deceased customer).
CUSTOMER_IS_PEPPolitically exposed person.
CUSTOMER_IS_PEP_RELATEDFamily member of a politically exposed person.
CUSTOMER_IS_IN_INTERNATIONAL_LISTSCustomer is in the lavajato/laft list.
CUSTOMER_SUSPENDED_STATUSCPF suspend by government triggered/criminal illegal activities.
CUSTOMER_POSSIBLE_INVALID_STATUSIn process of losing CPF.
CUSTOMER_NOT_FOUNDNo CPF data available.