Skip to content

Logo

iPague

Supports in this guide: Payments, Payouts

Provider website: ipague.com.br

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

  1. Get your credentials (from iPague)
  2. Connect in Dashboard
  3. Send an API request

Prerequisites: get from iPague

Contact your iPague account manager to get your account verified and receive the following credential.

  • API key -> Corefy field api_key.

BRL only, via PIX.

Payments processing (connect Provider account, create payment-invoice)

Connect Provider account in Corefy Dashboard

Step 1 - Open connection form

Open iPague in the provider directory and press Connect at iPague Provider Overview page in the New connection section.

Step 2 - Fill in fields and select settings

  • API key
  • Test Mode -> (enable if you are using sandbox credentials)

Success

You have connected iPague Provider account!

First request to Corefy API (MIN)

What it does: creates a payment-invoice for a PIX QR code payment.

Payment - MIN

POST /api/payment-invoices 

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "bf76e230-7660-4910-bd2a-1ee79553ea3e",
      "service": "pix_qr_brl_invoice",
      "currency": "BRL",
      "amount": 123,
      "service_fields": {
        "document_type": "CPF",
        "cpf_number": "28788426505",
        "payer_first_name": "Test",
        "payer_last_name": "Test"
      }
    }
  }
}

Important

service_fields.document_type, service_fields.cpf_number, service_fields.payer_first_name and service_fields.payer_last_name are all required - if any of them is missing, iPague rejects the request before it's sent (no fake/default value is substituted). No customer fields are used by this connector at all.

Refunds

iPague does not support refunds.

Payouts processing (connect Provider account, create payout-invoice)

Connect Provider account in Corefy Dashboard

Uses the same Provider account connected above - no separate connection step.

First request to Corefy API (MIN)

What it does: creates a payout-invoice for a PIX payout.

Payout - MIN

POST /api/payout-invoices 

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "reference_id": "63303f79-8ac9-4785-97d4-57de5afba7d3",
      "service": "pix_brl",
      "currency": "BRL",
      "amount": 11,
      "fields": {
        "account_type": "CPF",
        "cpf_number": "678686867",
        "pix_key": "johndoe123",
        "beneficiary_name": "John",
        "beneficiary_lastname": "Doe"
      }
    }
  }
}

Important

fields.account_type, fields.cpf_number and fields.pix_key identify the PIX recipient; fields.beneficiary_name/fields.beneficiary_lastname are combined into the payout's sender name field if both are present.

Refunds

iPague does not support refunds on Payouts.

Additional info

  1. Payments: active reconciliation is available, and iPague also sends an asynchronous callback (webhook URL is generated and sent automatically with every request - nothing to configure on iPague's side).
  2. Payouts: active reconciliation is available; iPague does not send an asynchronous callback for Payouts, so status updates rely on Corefy polling.
  3. No recurring - this connector does not support saving/charging a token through Corefy.
  4. No Options or Constants are configured for this connector.

FAQ / Troubleshooting

  • Invalid credentials / auth error -> verify the API key for the selected environment (Test Mode on/off)
  • Payment rejected for missing fields -> document_type, cpf_number, payer_first_name and payer_last_name are all required in service_fields
  • Payout rejected -> confirm fields.account_type, fields.cpf_number and fields.pix_key are present and valid
  • Refund fails -> iPague does not support refunds through Corefy

Question

Still looking for help connecting your iPague account? Please contact our support team!