Payok¶

Online Payment Solutions

Set up Account Provider account¶

Step 1: Create Provider account¶

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

payok_merchant_id → Merchant ID
payok_public_key → Public key
payok_private_key → Private key

Connect Provider Account¶

Step 1. Connect Provider account at the Corefy Dashboard¶

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

Connect

Enter credentials:

Merchant ID
Public key
Private key
Currency → choose currency (You can set these parameters according to available currencies and features for your Payok wallets and services, but it's necessary to check details of the connection with your Corefy account manager.)
Test Mode → true/false

Success

You have connected Payok Provider account!

API examples:¶

Minimal data set to create a payment invoices for ovo_idr_hpp service¶

PAYMENT
{
  "data":{
    "type":"payment-invoice",
    "attributes":{
      "service":"ovo_idr_hpp",
      "commerce_account":"Hello_world",
      "currency":"IDR",
      "amount":10000,
      "flow":"charge",
      "gateway_options":{
        "cardgate":{
          "tokenize":""
        }
      },
      "customer":{
        "reference_id":"acf3c94d-da66-4ee9-bed4-be9fb29bf780",
        "name":"John doe",
        "email":"[email protected]",
        "phone":"+3807711122233",
        }
      },
      "test_mode":false,
      "options":{
        "allow_partially":false,
        "bypass_hpp":false,
        "send_operation_context_on_return":false
      },
      "reference_id":"9ece2e52-3a87-4f87-bc26-467b82d8ce00",
      "service_fields":[
      ]
    }
  }
}

Maximal data set to create a payment invoices for ovo_idr_hpp service¶

PAYMENT
{
  "data":{
    "type":"payment-invoice",
    "attributes":{
      "service":"ovo_idr_hpp",
      "commerce_account":"Hello_world",
      "currency":"IDR",
      "amount":10000,
      "flow":"charge",
      "gateway_options":{
        "cardgate":{
          "tokenize":""
        }
      },
      "customer":{
        "reference_id":"acf3c94d-da66-4ee9-bed4-be9fb29bf780",
        "name":"John doe",
        "personal_id": "12345",
        "phone":"+3807711122233",
        "email":"[email protected]",
        "ip": "192.168.4.2",
        "address":{
          "country":"UK",
          "city":"London",
          "post_code":"123111",
          "full_address":"London City",
        }
      },
      "test_mode":false,
      "options":{
        "allow_partially":false,
        "bypass_hpp":false,
        "send_operation_context_on_return":false
      },
      "reference_id":"9ece2e52-3a87-4f87-bc26-467b82d8ce00",
      "service_fields":[
      ]
    }
  }
}

Minimum data set to create a payout invoices for upi_inr service¶

this request will be successful only if the constants are filled

PAYOUT

POST /api/commerce/payout-invoices HTTP/1.0
{
  "data":{
    "type":"payout-invoice",
    "attributes":{
      "service":"upi_inr",
      "commerce_account":"hello_world",
      "currency":"INR",
      "amount":100,
      "customer":{
        "reference_id":"602ab3a8-65dc-49c2-875a-3e76097f7195"
      },
      "test_mode":false,
      "reference_id":"8765cb06-eeb7-4fd9-a9c1-92f402e691a3",
      "fields":{
        "account_number":"110147429820",
        "beneficiary_full_name":"JUHAN MUNDA",
        "ifsc_bank_code":"CNRB0004425"
      },
      "options":{
        "attempts_limit":0,
        "split_mode":false,
        "allow_partially":false,
        "auto_process":false
      }
    }
  }
}

Maximum data set to create a payout invoices for upi_inr service¶

PAYOUT
POST /api/commerce/payout-invoices HTTP/1.0
{
  "data":{
    "type":"payout-invoice",
    "attributes":{
      "service":"upi_inr",
      "commerce_account":"Hello_world",
      "currency":"INR",
      "amount":100,
      "customer":{
        "reference_id":"602ab3a8-65dc-49c2-875a-3e76097f7195",
        "firstName":"JUHAN MUNDA",
        "lastName":"JUHAN MUNDA",
        "email":"[email protected]",
        "phone":"912084422881"
      },
      "test_mode":false,
      "reference_id":"8765cb06-eeb7-4fd9-a9c1-92f402e691a3",
      "fields":{
        "account_number":"110147429820",
        "beneficiary_full_name":"JUHAN MUNDA",
        "ifsc_bank_code":"CNRB0004425"
      },
      "options":{
        "attempts_limit":0,
        "split_mode":false,
        "allow_partially":false,
        "auto_process":false
      }
    }
  }
}

Constants¶

Сonstants

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:

FULL_NAME → customer [address] [full_name]
EMAIL → customer [address] [email]
PHONE → customer [address] [phone]
DEVICE_ID → customer [device_id]

Сonstants

EMAIL → customer [address] [email]
PHONE → customer [address] [phone]

Provider Options¶

Provider_Options

Use english language - sends language parameter to provider
- No → the language sends depending on the currency
- YES → English language sends
- OPTION OFF → default value → language sends depending on the currency

Question

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