Impaya¶

Website: impaya.com

Set up Account¶

Step 1: Create Provider account¶

To create an account send connection request at the impaya.com/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:

• Merchant account ID
• Merchant key

Connect Provider Account¶

Step 1. Connect Provider account at the Corefy Dashboard¶

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

Enter credentials:

• merchant_account_id → Merchant account ID
• merchant_key → Merchant key

API examples¶

Data set to create a Payment:¶

POST /api/commerce/payment-invoices HTTP/1.1
{
  "data":{
    "type":"payment-invoice",
    "attributes":{
      "service":"pay_id_aud_hpp",
      "commerce_account":"Hello_World :)",
      "currency":"AUD",
      "amount":1,
      "reference_id":"d6b71566-eeb1-4c6c-baa5-9694e540b0d8",
      "flow":"charge",
      "gateway_options":{
        "cardgate":{
          "tokenize":""
        }
      },
      "customer":{
        "reference_id":"1b273826-8cfe-4007-9750-f72bd4ed06f7",
        "name":"Serge Mai",
        "email":"[email protected]",
        "address":{
          "country":"UA",
          "city":"Kiev"
        }
      },
      "test_mode":false,
      "options":{
        "allow_partially":false
      },
      "service_fields":[
      ]
    }
  }
}

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:

• HPP_LANGUAGE → route [constant]

Default values¶

If some parameters are not passed in the request to create a transaction and the corresponding constants have no values, then default values will be passed instead.

Here is the list of default values with their corresponding parameters:

• HPP_LANGUAGE → 'ENG';