Online IPS

Global Payments. Local Expertise.

Supports in this guide: Payments

Provider website: onlineips.net

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

Choose account type
Get your credentials (from Online IPS)
Connect in Dashboard
Send an API request

Choose account type

Online IPS can be connected in different ways (depending on your needs):

If you do H2H card payments (card data sent directly) -> choose H2H Merchant account
If you do PIX or Boleto (Brazil) -> choose Provider account

If you're not sure which one to use, confirm with your Corefy account manager.

Prerequisites: get from Online IPS

Contact your Online IPS support manager. Submit the required documents to verify your account and gain access, then get the following credentials (the same ones are used for both account types).

Username -> Corefy field req_username.
Password -> Corefy field req_password.
Site ID -> Corefy field site_id.
Account ID -> Corefy field account_id.
Product ID -> Corefy field product_id.

Important

Be sure to check with the manager if you require to provide a white list of IPs, and if so, specify IP addresses from the Corefy list.

Payments processing (connect H2H Merchant account, create payment-invoice)

Connect H2H Merchant account in Corefy Dashboard

Step 1 - Open connection form

Open Online IPS in the provider directory and press Connect at Online IPS Provider Overview page in the New connection section. Choose H2H Merchant account.

Step 2 - Fill in fields and select settings

Username
Password
Site ID
Account ID
Product ID
Save Instant Token
Card On File Flag
Default Address Params -> USA or Brazil
Test Mode -> (enable if you are using sandbox credentials)

Choose Currency and Features. BRL, USD, EUR, and GBP are confirmed; check with your Corefy account manager which are enabled for your account.

Success

You have connected Online IPS H2H Merchant account!

First request to Corefy API (MIN)

What it does: creates a payment-invoice; card data itself is collected and submitted separately by Corefy's checkout/SDK layer, not as part of this request.

Payment - MIN

POST /api/payment-invoices

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

Payment - MAX

POST /api/payment-invoices

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "6795502c-e27d-4d07-85e0-93245aab9a3f",
      "service": "payment_card_usd_hpp",
      "currency": "USD",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123",
        "name": "John Smith",
        "email": "johnsmith@gmail.com",
        "phone": "+15551234567",
        "address": {
          "country": "US",
          "region": "California",
          "city": "Los Angeles",
          "full_address": "1 Main street",
          "post_code": "90001"
        }
      }
    }
  }
}

Important

customer is technically optional, but you should still always send it: anything you omit (name, email, billing address) is replaced with a hardcoded placeholder (e.g. a fake Phoenix, AZ or Rio de Janeiro address, depending on your Default Address Params setting, and john@example.com for email) rather than failing the request. A real transaction needs real customer/billing data to actually be accepted by card issuers - the placeholders exist only so the request has some value in every field, not as a usable fallback for production traffic.

Extended request (MAX)

Why add extra fields (typical reasons): - Provide additional customer details for compliance/reconciliation - Positively influence conversion rate - Include optional fields required by your specific flow

No Options or Constants are configured for this flow - the three connection-time settings above (Save Instant Token, Card On File Flag, Default Address Params) are account-level fields, not per-request Options.

Card On File Flag / Save Instant Token

What they do: when Card On File Flag is enabled, every sale on this account is tagged to the provider as either a stored-card charge or a new-card charge, based on Save Instant Token: enabling Save Instant Token tags every sale as "card on file" (previously stored), leaving it disabled tags every sale as "new card." When Card On File Flag is disabled, this tag isn't sent at all.

When to use: set these according to your actual card-storage practice - ask your Online IPS account manager if you're not sure which combination matches your account/MIT-CIT compliance setup.

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

Connect Provider account in Corefy Dashboard

Step 1 - Open connection form

Open Online IPS in the provider directory and press Connect at Online IPS Provider Overview page in the New connection section. Choose Provider account.

Step 2 - Fill in fields and select settings

Username
Password
Site ID
Account ID
Product ID
Payment Method -> PIX or Boleto
Test Mode -> (enable if you are using sandbox credentials)

Important

Pick one payment method per connection. If you need both PIX and Boleto, connect a second Provider account for the other method.

Success

You have connected Online IPS Provider account!

First request to Corefy API (MIN)

What it does: creates a payment-invoice and returns a redirect link to the PIX or Boleto payment page.

Payment - MIN

POST /api/payment-invoices

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

Payment - MAX

POST /api/payment-invoices

{
  "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",
        "address": {
          "country": "BR",
          "region": "Pirituba",
          "city": "Rio de Janeiro",
          "street": "60 rua Poty Medeiros",
          "post_code": "20000-000"
        }
      },
      "fields": {
        "cpf_number": "70634982826"
      }
    }
  }
}

Important

fields.cpf_number is the customer's Brazilian CPF (individual tax ID) - required for the payment to actually work with Brazilian banks, even though the request technically still goes through with a placeholder value if you omit it. The same applies to customer.name/customer.email/customer.address - always send the real values; placeholders exist only so no field is ever blank, not as a usable production fallback. This connector also supports boleto_bancario_brl_hpp (same required fields).

Extended request (MAX)

Why add extra fields (typical reasons): - Provide additional customer details for compliance/reconciliation - Positively influence conversion rate - Include optional fields required by your specific flow

No Options or Constants are configured for this flow.

Additional info

Callback routing is automatic - Corefy generates the callback URL per transaction, for both account types, nothing to configure in Online IPS' own back-office.

FAQ / Troubleshooting

Invalid credentials / auth error -> verify credentials for the selected environment and account type
PIX/Boleto payment fails at the bank despite a successful API response -> check that real customer data and a valid fields.cpf_number were actually sent - a request missing them still succeeds at the API level using placeholder values, but those won't pass at the bank
Currency or service is not supported -> confirm allowed currencies/features in your Online IPS account and in Corefy
Not sure which account type to use? -> ask your Corefy account manager

Question

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