Wallet Fri (Guatemala)

This payment solution is only available in Guatemala

Fri

Fri is an open digital wallet that allows you to send, request and receive money. In addition, it offers the convenience of paying through QR codes, all thanks to the direct linking of your accounts in affiliated financial institutions.

We simplify the collection process by providing a complete payment request with the necessary value and details. This request is sent directly to the registered wallet user via a webhook, ensuring you receive an immediate notification on your device. From there, they have the ability to review the transaction and make an informed decision to either approve or decline it with a single click.

• The payment request can only be made to phone numbers registered in the application, otherwise the ticket will be in rejected status informing that the number is not registered.

• A Bank Transfer - Wallet payment order expires by default within 10 days iafter the creation date.

• However, the expiration date can be set according to our clients requirements between 1 to 10 days

• This payment solution is only available in Guatemala

Money request

POST https://api.stage.localpayment.com/api/payin

Headers

Name	Type	Description
Authorization*	string	Mandatory. JWT token in format Bearer eyJ0... . For more information about authentication, please refer to Authentication

Request Body

Name	Type	Description
paymentMethod*	OBJECT	Mandatory. Payment method details
paymentMethod.type*	string	Mandatory.wallet
paymentMethod.code*	string	Mandatory. Select among the codes available in each country here NOTE: yment method code might affect the collection currency in bimonetary countries. For more info, see the side note on currency field.
paymentMethod.flow*	string	Mandatory. The payment method data could be embeded in the API request (DIRECT)or collected via an aditional form or plugin (REDIRECT). Currently, only DIRECT flow is allowed.
externalId*	string	Mandatory. An ID that is meaningful to you and your system. It must be unique and alphanumeric, no characters allowed.
country*	string	Mandatory. "GTM" Guatemala in ISOCode3 format
amount*	number	Mandatory. Amount to charge to your end user. For GTQ, use 2 decimal places separated by a dot.
currency*	string	Mandatory. The currency in which the amount is expressed. It could be A) the local currency of the selected country or B) the account's currency. If A), the amount will be charged to the customer's cash payment method. If B) and it differs from the local currency, the amount specified will be credited to your account and Localpayment will perform a Foreign Exchange operation to collect the amount expressed in local currency. In bimonetary countries, paymentMethod.code resolves possible ambiguity: the payment will be executed in the currency of that specific payment method network. e.i.: SPID (USD); SPEI (MXN)
accountNumber*	string	Mandatory. Your Localpayment account number in which the amount will be credited.
conceptCode*	string	Mandatory. Choose the suitable concept code from our Concept Code List. Based on our experience, the most usual are 0039 (remittances) and 0040 (corporate payments).
comment	string	Optional. A comment related to the transaction. It should be something meaningful to your business.
merchant*	OBJECT	Mandatory. Party Object.
merchant.type*	string	Mandatory. Possible value: COMPANY
merchant.name*	string	Mandatory. Name of business
payer*	OBJECT	Mandatory. Party Object. Information related to the payer.
type*	string	Mandatory. Possible values: COMPANY, INDIVIDUAL
name*	string	Mandatory. Individual first name / company name
lastName	string	Mandatory for individuals / Ignored for companies.
document*	OBJECT	Mandatory.Party Object. Valid identity document.
document.type*	string	Mandatory. Document types: CPF / CNPJ
document.id*	string	Mandatory. Identity document Id. Usually numbers or combination of numbers and letters.
userReference	string	Optional. Username or id in your platform.
email	string	Mandatory
phone*	OBJECT	Mandatory. Party Object. Contact phone number
phone.countryCode*	string	Mandadatory. Possible values: gt
phone.areaCode*	string	Mandatory. Country Area Code
phone.number*	string	Mandatory. Phone number registered in the application
birthdate	string	Optional. Individual birthdate / company incorporation date. ISO 8601 format (YYYY-MM-DD)
nationality	string	Optional
address	OBJECT	Optional. Party Object. Contact address
address.street	string	Optional
address.number	string	Optional
address.city	string	Optional
address.state	string	Optional
address.country	string	Optional
address.comment	string	Optional. Additional info, such as floor or apartment number.
intermediaries	array	Optional. Array of Party objects. It represents others parties in the payment chain because of the end user is not your direct customer. Take into account the array sequence: your client should be the first element, the client of your client should be the second and so on, until there are no more intermediaries.
commercialData	OBJECT	Mandatory. Party Object. Extra information related to the goods or services traded.
item.id	string	Mandatory. Item ID
items.quantity	number	Mandatory. Item quantity
items.description	string	Mandatory. Item description
item.title	string	Mandatory. Item title
item.unitPrice	number	Mandatory.Unit price

200: OK

{
    "transactionType": "PayIn",
    "externalId": "{{externalId}}",
    "internalId": "{{internalId}}",
    "paymentMethod": {
        "type": "Wallet",
        "code": "1880",
        "flow": "DIRECT"
    },
    "country": "GTM",
    "currency": "GTQ",
    "amount": 10.0,
    "accountNumber": "{{YourAccountNumber}}",
    "confirmed": {
        "currency": "GTQ",
        "amount": 10.0,
        "fxQuote": 1.0
    },
    "payment": {
        "currency": "GTQ",
        "fxQuote": 1.0,
        "financingFee": 0.0,
        "amount": 10.0
    },
    "localTaxes": [],
    "withHoldings": [],
    "fees": {
        "description": "Fee",
        "currency": "GTQ",
        "fxSource": 1.0,
        "fxQuote": 1.0,
        "amount": 0.0,
        "account": "{{YourAccountNumber}}"
    },
    "status": {
        "code": "100",
        "description": "INPROGRESS",
        "detail": "The payin is pending the confirmation"
    },
    "merchant": {
        "type": "COMPANY",
        "name": "LocalPayment"
    },
    "payer": {
        "type": "INDIVIDUAL",
        "name": "Prueba",
        "lastname": "Prueba",
        "document": {
            "type": "CUI",
            "id": "3463426000101"
        },
        "email": "[e-mail]",
        "phone": {
            "countryCode": "gt",
            "areaCode": "502",
            "number": "55555555"
        },
        "address": {
            "street": "",
            "city": "",
            "state": "",
            "country": "",
            "comment": ""
        }
    },
    "intermediaries": [],
    "date": {
        "creationDate": "2024-05-23T14:15:13.368+00:00",
        "processedDate": "2024-05-23T14:15:14.6506329",
        "expirationDate": "2024-05-30T14:15:13.550683"
    },
    "errors": []
}

400: Bad Request

{
    "externalId": "{{externalId}}",
    "internalId": "{{internalId}}",
    "status": {
        "code": "915",
        "description": "REJECTED",
        "detail": "The phone number provided doesn't match any account"
    },
    "errors": [
        {
            "code": "915",
            "detail": "The phone number provided doesn't match any account"
        }
    ]
}

Examples: Money request

To create a wallet payment order through the LP api, examples of the request body are detailed below.

Request wallet

{
      "externalId": "{{externalId}}",
      "paymentMethod": {
        "type": "Wallet",
        "code": "1880",
        "flow": "DIRECT"
      },
      "country": "GTM",
      "currency": "GTQ",
      "amount": 10,
      "accountNumber": "{{YourAccountNumber}}",
      "conceptCode": "0001",
      "comment": "Acme",
      "merchant": {
        "type": "COMPANY",
        "name": "LocalPayment"
      },
      "payer": {
        "type": "INDIVIDUAL",
        "name": "Prueba",
        "lastName": "Prueba",
        "document": {
          "type": "CUI",
          "id": "3463426000101"
        },
        "email": "[e-mail]",
        "phone": {
          "countryCode": "gt",
          "areaCode": "502",
          "number": "55555555"
        },
        "address": {
          "street": "",
          "city": "",
          "state": "",
          "country": "",
          "comment": ""
        }
      },
      "intermediaries": [],
      "commercialData": {
        "items": [
          {
            "id": "1441",
            "title": "test2",
            "description": "prueba",
            "quantity": "1",
            "unitPrice": 1
          }
        ]
      }
    }

Check the Payin Status Codes

Payin