Introducción

Tu cuenta

En Openpay podrás tener dos tipos de cuenta:

a) Cuenta de Prueba

Para poder empezar a utilizar nuestra plataforma es necesario que tengas una cuenta en nuestro ambiente de pruebas. Si aún no tienes una cuenta puedes hacerlo aquí, es completamente gratis y muy sencillo.

Con esta cuenta podrás pobrar toda la funcionalidad de la API sin realizar cargos ni pagos reales. Utiliza este ambiente para integrar y probar tu aplicación.

La ubicación del ambiente de prueba es:

Portal de consulta (dashboard): https://sandbox-dashboard.openpay.co

API: https://sandbox-api.openpay.co

b) Cuenta de Producción

Para empezar a procesar cargos y envíos reales deberás solicitar tu activación en producción, esto lo puedes realizar desde tu cuenta de pruebas donde tendrás que llenar formulario con información de tu empresa. Tu información será revisada internamente y en caso de que necesitemos más información te contactaremos.

Una vez aceptada tu solicitud se te enviará un correo electrónico para que des de alta tu contraseña de acceso al portal de producción y podrás empezar a recibir y enviar pagos reales.

La ubicación del ambiente de producción es:

Portal de consulta (dashboard): https://dashboard.openpay.co

API: https://api.openpay.co

Nota: Una vez que estés en producción ten cuidado a que ambiente estás realizando tus peticiones.

Llaves de API

En cada ambiente que ocupes (pruebas o producción) tendrás dos llaves:

  • Llave pública: Que podrás utilizar en tu código front-end (como HTML) y sólo te permitirá poder crear tokens

  • Llave privada:
    Con ella podrás realizar todas las operaciones de la API, por lo que no debes compartirla con nadie y sólo debes tenerla en la parte back-end.

Organización de la API

Con nuestra API podrás manejar dos tipos de cuentas:

Tipos de cuentas

  • Comercio: Es tu cuenta principal la cual fue creada al momento de realizar tu registro y solo puedes tener una por registro.

  • Cliente: Es una cuenta que está asociada a tu cuenta de comercio y que puedes crear las que necesites.

Recursos

A lo largo de la documentación encontrarás llamadas por comercio y por cliente, las cuales te indicarán como manejar un recurso para una cuenta en especifico.

Cada cuenta tiene recursos que puedes crear (POST), actualizar (PUT), obtener (GET) o eliminar (DELETE), y dependiendo en donde realices la operación es el tipo de cuenta que se verá afectada; es decir si realizas un cargo a nivel de comercio, tu saldo principal se verá incrementado pero si lo realizas a nivel cliente este será el afectado.

Nota: Hay recursos como charges, payouts, cards, bank_accounts que están disponibles para los dos tipos de cuenta, por lo que debes tener cuidado al momento de hacer la llamada cual estás afectando.