Skip to content

Logo

Apay

Supports in this guide: Payments

Provider website: not reliably confirmed at the time of writing ("Apay" is too generic a name to confirm a specific public website independently; confirm the current website with your account manager before sharing it with anyone)

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

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

Prerequisites: get from Apay

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

  • Merchant ID -> Corefy field merchant_id.
  • API Key -> Corefy field api_key -> used as a bearer token to authenticate every request.
  • Callback Secret Key -> Corefy field callback_secret_key -> sent to Apay with every request and used to verify callback notifications.
  • API URL (optional) -> Corefy field api_url -> leave as default unless your account manager tells you otherwise.
Payments processing (connect Provider account, create payment-invoice)

Connect Provider account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

  • Merchant ID
  • API Key
  • Callback Secret Key
  • API URL (optional)
  • Test Mode -> (enable if you are using sandbox credentials)

Success

You have connected Apay Provider account!

First request to Corefy API (MIN)

What it does: creates a payment-invoice and redirects the customer to an Apay-hosted page to complete the payment. Apay supports a very wide range of local payment methods across Latin America, Africa, India, and Turkey (SPEI, PSE, Nequi, WebPay, UPI, Mercado Pago, Pix, Pago Móvil, Yape, PagoEfectivo, Havale, mobile money rails such as Orange Money/Airtel Money/MTN, and more), plus cards, Apple Pay, Google Pay, and open banking; the exact set available depends on what's enabled for your specific account - check with your account manager.

Payment - MIN

POST /api/payment-invoices 

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

Payment - MAX

POST /api/payment-invoices 

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "6795502c-e27d-4d07-85e0-93245aab9a3f",
      "service": "payment_card_eur_hpp",
      "currency": "EUR",
      "amount": 10,
      "customer": {
        "reference_id": "cus_123",
        "name": "John Smith",
        "email": "johnsmith@gmail.com",
        "metadata": {
          "ip": "203.0.113.5"
        }
      }
    }
  }
}

customer is entirely optional - everything is only used to prefill the hosted form, it never blocks the sale.

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 Constants are configured for this connector.

Options

  • seconds_to_expire -> optional, number (as a string) - how long the payment link stays valid, in seconds; defaults to 360 if not set.
  • api_type -> optional, enum (V1/V2) - selects which version of Apay's own API Corefy talks to; defaults to V1. With V2, empty optional customer fields are omitted from the request entirely instead of being sent as empty values - ask your account manager which version your account is set up for.
  • disable_reconcile -> optional, boolean - turns off Corefy's active status checks (reconciliation) for this connection entirely; Corefy then relies only on Apay's asynchronous callback to learn the final status.

Refunds

Apay supports full refunds only (no partial refunds).

Additional info

  1. Callback routing is automatic - Corefy generates the callback/return URLs per transaction, nothing to configure in Apay's own back-office.
  2. No payouts - this connector does not support payouts through Corefy.

FAQ / Troubleshooting

  • Invalid credentials / auth error -> verify Merchant ID/API Key/Callback Secret Key for the selected environment
  • Payment link expired before the customer completed it -> increase seconds_to_expire (default is 360 seconds)
  • Refund rejected for a partial amount -> only full refunds are supported
  • Status never updates after a successful payment -> check whether disable_reconcile is enabled on your connection - if so, Corefy relies only on Apay's callback, not active status checks
  • Currency or service is not supported -> confirm allowed currencies/features in your Apay account and in Corefy

Question

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