Skip to content

Logo

Okpay

Supports in this guide: Payments, Payouts

Note

No independently verifiable public website could be confirmed for this provider - the only reference found was Corefy's own connector page, which cannot be used to verify it. Contact your account manager for onboarding details.

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

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

Prerequisites: get from Okpay

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

  • Merchant ID -> Corefy field merchant_id.
  • Merchant private key -> Corefy field merchant_private_key.

VND, PKR, depending on the local payment method (bank QR, JazzCash, EasyPaisa).

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

Connect Provider account in Corefy Dashboard

Step 1 - Open connection form

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

Step 2 - Fill in fields and select settings

  • Merchant ID
  • Merchant private key
  • Currency / Features -> choose values available for your account (VND, PKR)
  • Test Mode -> (enable if you are using sandbox credentials)

Success

You have connected Okpay Provider account!

First request to Corefy API (MIN)

What it does: creates a payment-invoice and redirects the customer to Okpay's hosted payment page.

Payment - MIN

POST /api/payment-invoices 

{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "reference_id": "8a632a8a-1da4-4e6c-ade7-bbacd8313e0a",
      "service": "bank_qr_vnd_hpp",
      "currency": "VND",
      "amount": 50000
    }
  }
}

Important

No customer fields are sent to Okpay for Payments - they are not part of the request at all.

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

This connector has no additional request fields beyond the MIN example above - no Options or Constants are configured for Payments.

Refunds

Okpay 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 and sends funds via the selected local payout method.

Payout - MIN

POST /api/payout-invoices 

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "reference_id": "8a632a8a-1da4-4e6c-ade7-bbacd8313e0a",
      "service": "bank_transfer_vnd",
      "currency": "VND",
      "amount": 5,
      "fields": {
        "account_number": "123",
        "bank_code": "234",
        "beneficiary_full_name": "qwe qwe"
      }
    }
  }
}

Important

  • fields.account_number, fields.bank_code, and fields.beneficiary_full_name are required for all Payout services (bank_transfer_vnd, jazzcash_pkr, easypaisa_pkr) - including JazzCash/EasyPaisa, where bank_code is still read from the same field.
  • No customer fields are sent to Okpay for Payouts either - they are not part of the request at all.

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

This connector has no additional request fields beyond the MIN example above - no Options or Constants are configured for Payouts.

Additional info

  1. Active reconciliation is available - both the asynchronous callback and an active status request can finalize Payments and Payouts.
  2. No recurring - this connector does not support saving/charging a token through Corefy.
  3. No Options or Constants are configured for this connector on either flow.

FAQ / Troubleshooting

  • Invalid credentials / auth error -> verify the Merchant ID and Merchant private key for the selected environment (test_mode)
  • Currency or service is not supported -> confirm allowed currencies/features in your Okpay account and in Corefy - only VND and PKR are available
  • Payout rejected for missing fields -> account_number, bank_code, and beneficiary_full_name are required for every Payout method
  • Refund fails -> Okpay does not support refunds through Corefy

Question

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