PayRetailers

Supports in this guide: Payments, Payouts

Provider website: payretailers.com

What you need to do for start processing transactions (brief summary)

1. Choose account type
2. Get your credentials (from PayRetailers)
3. Connect in Dashboard
4. Send an API request

Choose account type

PayRetailers has a single account type that covers both directions:

• Provider account -> used for both payments (bank transfer, cash vouchers, local wallets/fintechs across Latin America) and payouts

If you're not sure whether PayRetailers fits your use case, confirm with your Corefy account manager.

Prerequisites: get from PayRetailers

Contact your PayRetailers account manager to get your account verified and receive the following credentials.

• Shop ID -> Corefy field shop_id.
• Shop Secret -> Corefy field shop_secret -> used to sign every request.
• Subscription Key (optional) -> Corefy field subscription_key.

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "8e3dbbb0-17af-4c9a-bedb-93bdac6900a2",
      "service": "pix_brl_hpp",
      "currency": "BRL",
      "amount": 10
    }
  }
}

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "6795502c-e27d-4d07-85e0-93245aab9a3f",
      "service": "pix_brl_hpp",
      "currency": "BRL",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123",
        "name": "John Smith",
        "email": "johnsmith@gmail.com",
        "individual_tax_id": "70634982826",
        "address": {
          "country": "BR",
          "city": "Rio de Janeiro",
          "full_address": "1 Main street",
          "post_code": "20000-000"
        }
      },
      "fields": {
        "phone": "+5511999999999"
      }
    }
  }
}

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "reference_id": "0dde9e79-2c64-4703-adaf-93d710633401",
      "service": "pix_brl",
      "currency": "BRL",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123"
      },
      "fields": {
        "pix_key": "recipient@example.com"
      }
    }
  }
}

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "reference_id": "3c6d2f8e-8a2a-4e7a-9b1a-2f6a7b9c0d1e",
      "service": "spei_mxn",
      "currency": "MXN",
      "amount": 1000,
      "customer": {
        "reference_id": "cus_123",
        "email": "johnsmith@gmail.com"
      },
      "fields": {
        "beneficiary_name": "John",
        "beneficiary_lastname": "Smith",
        "document_id": "AAAA000101HDFRRL09",
        "bank_code": "002",
        "account_number": "012180001234567895"
      }
    }
  }
}

Additional info

1. Callback routing is automatic - Corefy generates the callback URL per transaction, nothing to configure in PayRetailers' own back-office.

2. Local payment methods available on the Payments (Provider account) flow (actual availability depends on what's enabled for your account) - PayRetailers covers over 80 service codes across:

   Country	Currency	Examples
   Brazil	BRL	PIX, bank transfer
   Mexico	MXN	SPEI, OXXO (cash), BBVA Bancomer, Scotiabank, Banco Azteca (cash), Calimax/Soriana/Farmacias Santa Maria (cash)
   Peru	PEN	Banco de Credito, BBVA Continental, Interbank, Scotiabank, several Cajas (Arequipa/Huancayo/Tacna/Trujillo), Kasnet/Tambo/Ripley (cash)
   Colombia	COP	PSE
   Chile	CLP	WebPay, Khipu, Mach, Fintoc, Multicaja, several banks (BCI, de Chile, Estado, Falabella, Santander), Lider/Express Lider (cash)
   Costa Rica	CRC	Banco Nacional (online and cash)
   Guatemala	GTQ	Banco de Antigua, Caja de Desarrollo, Fundacion Genesis (all cash)
   USD-denominated	USD	Equivalents of most of the above banks/wallets, plus Western Union Panama, Pichincha Mi Vecino, Red Activa (cash)

   Ask your account manager for the exact list of service codes available to your account - many methods also have a _cash variant (returns a voucher/reference for the customer to pay at a physical location) alongside the online redirect version.

3. Local payout methods: PIX (BRL), SPEI (USD/MXN), and generic bank transfer (BRL/CLP/MXN/COP/USD/PEN).

FAQ / Troubleshooting

• Invalid credentials / auth error -> verify credentials for the selected environment
• Payment stuck pending for a long time -> normal for cash/bank-transfer methods until the customer completes it; set finalize_after_minutes if you want an automatic cutoff
• Local payment/payout rejected for missing tax ID -> most methods require the customer's/beneficiary's local tax ID - send it via customer.individual_tax_id or the method-specific fields.* override
• Currency or service is not supported -> confirm allowed currencies/features in your PayRetailers account and in Corefy