Overpay¶

Website: overpay.io

Set up Account H2H merchant account¶

Step 1: Create Merchant Account¶

To create an account send connection request at the overpay.io/contacts or contact manager directly. Submit the required documents to verify your account and gain access.

Step 2: Get required credentials¶

Credentials that have to be issued:

• Shop ID
• Public Key
• Secret Key
• Test mode true/false
• 3DS Mode
• Provider URL
• Currency

Connect Merchant Account¶

Step 1. Connect H2H account at the Corefy Dashboard¶

Press Connect at Overpay Provider Overview page in 'New connection' section and choose H2H Merchant account option to open Connection form.

Enter credentials:

• overpay__shop_id → Shop ID
• overpay__public_key → Public Key
• overpay__secret_key → Secret Key
• overpay__test_mode → true/false
• overpay__3ds_mode → 3DS Mode
• overpay__provider_url → Provider URL
• overpay__currency → choose currency (You can set these parameters according to available currencies and features for your Overpay wallets and services, but it's necessary to check details of the connection with your Overpay account manager.)

You have connected Overpay H2H merchant account!

API examples:¶

Minimum data set to create a payment invoices for payment_card service = Maximum data set¶

SALE

{
  "data":{
    "type":"payment-invoice",
    "attributes":{
      "reference_id":"pay_IatcZSKRgrF0S3IR05OgVRWg",
      "currency":"KZT",
      "amount":"6.00",
      "test_mode":false,
      "service":"payment_card",
      "retry_limit":0,
      "flow":"charge",
      "options":{
        "bypass_status_page":false,
        "attempts_limit":0,
        "auto_repay":false,
        "theme_options":[
        ],
        "h2h":false,
        "return_url":"http:\/\/com.paycore.local\/return?id=cpi_BMrk8PrEtKHCEZ9N",
        "restrict_saved_cards":false,
        "use_eight_digit_bin_first":false,
        "h2h_hide_auth_payload":false,
        "refund_new_model":false,
        "async_cascading":false,
        "allow_partially":false
      },
      "expires":"2024-05-14T12:31:19+00:00",
      "metadata":{
        "fee":"0.00",
        "fee_strategy":"internal"
      },
      "payload":{
        "use_tokens_from":[
          "coma_5pe7GmNU56rBR7lT"],
        "commerce_invoice_reference_id":"0e0597d7-b980-4228-b684-2db34b60cdaf",
        "commerce_invoice_id":"cpi_BMrk8PrEtKHCEZ9N",
        "invoice_root_source":"platform_dashboard",
        "commerce_account_id":"coma_5pe7GmNU56rBR7lT",
        "rate_scheme":"ers_iBxbnB8TaiE6f73C"
      }
    }
  }
}

Constants¶

If some parameters are not sent in the transaction creation request, they will take the values from the set constants.

Here is a list of constants with their corresponding parameters:

• IP → constant [ip]
• DESCRIPTION → constant [description]
• LANG → constant [language]
• EMAIL → customer [email]
• REASON → constant [reason]
• COUNTRY → customer [address] [country]
• CITY → customer [address] [city]
• STATE → customer [address] [state]
• ZIP ->> customer [address] [zip]
• ADDRESS → customer [address] [address]

Provider Options¶

• ignore_callback
  • for cascading to work correctly, we exclude the possibility of finalizing payments using asynchronous callbacks, ignore the callback, do not change the status of the transaction on it in any way and rely only on the status request for finalization (Reconciliation)
• send_customer_data
  • if the option is disabled - the billing_address data will not be sent