Skip to content

Logo

OKTO

Digital Payments for the Real World. We power digital payments for every online and retail environment globally.

Website: www.oktopayments.com

Set up Account Provider account

Step 1: Create Provider account

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

  • okto__merchant_account_number → Merchant account number
  • okto__api_key → API Key
  • okto__test_mode → Test mode
  • okto__country → Country
  • okto__callback_signature_key → Callback signature key

Connect Provider Account

Step 1. Connect Provider account at the Corefy Dashboard

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

Connect

Enter credentials:

  • Merchant account number
  • API Key
  • Test mode
  • Country
  • Callback signature key

Success

You have connected OKTO Provider account!

API examples:

Minimum data set to create a payment invoices for required service

  • BRL (pix_brl_hpp)

PAYMENT

POST /api/payment-invoices HTTP/1.1
{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "service": "pix_brl_hpp",
      "currency": "BRL",
      "amount": 75,
      "customer": {
        "reference_id": "20af9b35-fbd7-410e-9736-adeea7f22176",
        "name": "John Doe"
      },
      "callback_url": "https:\/\/1e96-3-65-180-235.ngrok-free.app\/webhook",
      "test_mode": true,
      "reference_id": "d1dc6082-dca7-4cce-b06a-6331951c5b15",
      "service_fields": {
        "cpf_number": "604.184.437-34"
      }
    }
  }
}

  • PEN (bank_transfer_pen_hpp)

PAYMENT

POST /api/payment-invoices HTTP/1.1
{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "service": "bank_transfer_pen_hpp",
      "currency": "PEN",
      "amount": 53,
      "customer": {
        "reference_id": "abe2ad63-30df-4e9c-9a05-06e23c5a5beb",
        "name": "John Doe",
        "email": "[email protected]"
      },
      "callback_url": "https:\/\/1e96-3-65-180-235.ngrok-free.app\/webhook",
      "test_mode": true,
      "reference_id": "fcaf86bf-1998-4356-aa94-b8f2e3f8274f",
      "service_fields": {
        "document_type": "TAX_ID_NUMBER",
        "document_id": "27983285123"
      }
    }
  }
}

  • PEN (bank_transfer_pen_hpp)

PAYMENT

POST /api/payment-invoices HTTP/1.1
{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "service": "bank_transfer_pen_hpp",
      "currency": "PEN",
      "amount": 53,
      "customer": {
        "reference_id": "abe2ad63-30df-4e9c-9a05-06e23c5a5beb",
        "name": "John Doe",
        "email": "[email protected]"
      },
      "callback_url": "https:\/\/1e96-3-65-180-235.ngrok-free.app\/webhook",
      "test_mode": true,
      "reference_id": "fcaf86bf-1998-4356-aa94-b8f2e3f8274f",
      "service_fields": {
        "document_type": "TAX_ID_NUMBER",
        "document_id": "27983285123"
      }
    }
  }
}

  • PEN (cash_pen_hpp)

PAYMENT

POST /api/payment-invoices HTTP/1.1
{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "service": "cash_pen_hpp",
      "currency": "PEN",
      "amount": 47,
      "customer": {
        "reference_id": "4cba99e3-dcc1-4dc6-b880-47f9dab0aa9d",
        "name": "John Doe",
        "email": "[email protected]"
      },
      "callback_url": "https:\/\/1e96-3-65-180-235.ngrok-free.app\/webhook",
      "test_mode": true,
      "reference_id": "cba66cf9-c964-461c-9704-852606787bf6",
      "service_fields": {
        "document_type": "TAX_ID_NUMBER",
        "document_id": "27983285123"
      }
    }
  }
}

  • PEN (bank_transfer_pen_hpp)

PAYMENT

POST /api/payment-invoices HTTP/1.1
{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "service": "bank_transfer_clp_hpp",
      "currency": "CLP",
      "amount": 25,
      "customer": {
        "reference_id": "f0c2eb68-b2d3-4baa-8db1-974cad0dc50c",
        "name": "John Doe",
        "email": "[email protected]"
      },
      "callback_url": "https:\/\/1e96-3-65-180-235.ngrok-free.app\/webhook",
      "test_mode": true,
      "reference_id": "3d37f72c-9d05-4259-bc7d-0deaaf530119",
      "service_fields": {
        "document_type": "TAX_ID_NUMBER",
        "document_id": "27983285-K"
      }
    }
  }
}

  • CLP (bank_transfer_clp_hpp)

PAYMENT

POST /api/payment-invoices HTTP/1.1
{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "service": "bank_transfer_clp_hpp",
      "currency": "CLP",
      "amount": 25,
      "customer": {
        "reference_id": "f0c2eb68-b2d3-4baa-8db1-974cad0dc50c",
        "name": "John Doe",
        "email": "[email protected]"
      },
      "callback_url": "https:\/\/1e96-3-65-180-235.ngrok-free.app\/webhook",
      "test_mode": true,
      "reference_id": "3d37f72c-9d05-4259-bc7d-0deaaf530119",
      "service_fields": {
        "document_type": "TAX_ID_NUMBER",
        "document_id": "27983285-K"
      }
    }
  }
}

  • CLP (cash_clp_hpp)

PAYMENT

POST /api/payment-invoices HTTP/1.1
{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "service": "payment_card_clp_hpp",
      "currency": "CLP",
      "amount": 26,
      "customer": {
        "reference_id": "62e9b508-4cdc-404f-afc5-3dbb772fe9f0",
        "name": "John Doe",
        "email": "[email protected]"
      },
      "callback_url": "https:\/\/1e96-3-65-180-235.ngrok-free.app\/webhook",
      "test_mode": true,
      "reference_id": "a398fdf0-c17a-4cdf-b0be-670c0ebcc740",
      "service_fields": {
        "document_type": "TAX_ID_NUMBER",
        "document_id": "27983285-K"
      }
    }
  }
}

  • CLP (payment_card_pen_hpp)

PAYMENT

POST /api/payment-invoices HTTP/1.1
{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "service": "payment_card_clp_hpp",
      "currency": "CLP",
      "amount": 26,
      "customer": {
        "reference_id": "62e9b508-4cdc-404f-afc5-3dbb772fe9f0",
        "name": "John Doe",
        "email": "[email protected]"
      },
      "callback_url": "https:\/\/1e96-3-65-180-235.ngrok-free.app\/webhook",
      "test_mode": true,
      "reference_id": "a398fdf0-c17a-4cdf-b0be-670c0ebcc740",
      "service_fields": {
        "document_type": "TAX_ID_NUMBER",
        "document_id": "27983285-K"
      }
    }
  }
}

  • MXN (bank_transfer_mxn_hpp)

PAYMENT

POST /api/payment-invoices HTTP/1.1
{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "service": "bank_transfer_mxn_hpp",
      "currency": "MXN",
      "amount": 57,
      "customer": {
        "reference_id": "33cbc7ab-8ad2-4235-8b26-9d9dd9dee5e9",
        "name": "John Doe",
        "email": "[email protected]"
      },
      "callback_url": "https:\/\/1e96-3-65-180-235.ngrok-free.app\/webhook",
      "test_mode": true,
      "reference_id": "13dec2f4-4660-409a-8ddc-bdb5e10de1a2",
      "service_fields": {
        "document_type": "TAX_ID_NUMBER",
        "document_id": "152612***6765"
      }
    }
  }
}

  • MXN (cash_mxn_hpp)

PAYMENT

POST /api/payment-invoices HTTP/1.1
{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "service": "cash_mxn_hpp",
      "currency": "MXN",
      "amount": 36,
      "customer": {
        "reference_id": "100008",
        "name": "John Doe",
        "email": "[email protected]"
      },
      "callback_url": "https:\/\/1e96-3-65-180-235.ngrok-free.app\/webhook",
      "test_mode": true,
      "reference_id": "e40d8e90-a56f-4c0e-944c-4b1d7cf19a9a",
      "service_fields": {
        "document_type": "TAX_ID_NUMBER",
        "document_id": "152612***6765"
      }
    }
  }
}

  • MXN (payment_card_mxn_hpp)

PAYMENT

POST /api/payment-invoices HTTP/1.1
{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "service": "payment_card_mxn_hpp",
      "currency": "MXN",
      "amount": 48,
      "customer": {
        "reference_id": "b88a4a83-47e3-4bd9-9e19-cc3e578aaef5",
        "name": "John Doe",
        "email": "[email protected]"
      },
      "callback_url": "https:\/\/1e96-3-65-180-235.ngrok-free.app\/webhook",
      "test_mode": true,
      "reference_id": "d12000ae-3d50-410a-a322-5c817c8d9f00",
      "service_fields": {
        "document_type": "TAX_ID_NUMBER",
        "document_id": "152612***6765"
      }
    }
  }
}

  • ARS (bank_transfer_ars_hpp)

PAYMENT

POST /api/payment-invoices HTTP/1.1
{
  "data": {
    "type": "payment-invoice",
    "attributes": {
      "service": "bank_transfer_ars_hpp",
      "currency": "ARS",
      "amount": 156,
      "customer": {
        "reference_id": "c7868614-e1ff-4ffe-b00e-82ee59ac42e9"
      },
      "callback_url": "https:\/\/1e96-3-65-180-235.ngrok-free.app\/webhook",
      "test_mode": true,
      "reference_id": "dedb9b77-d066-414e-ba0c-c8ac4f071eed"
    }
  }
}

Question

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