https://github.com/culqi/culqi-go
Cliente Go (Golang) para Culqi API.
https://github.com/culqi/culqi-go
Last synced: about 2 months ago
JSON representation
Cliente Go (Golang) para Culqi API.
- Host: GitHub
- URL: https://github.com/culqi/culqi-go
- Owner: culqi
- License: mit
- Created: 2017-01-07T00:34:51.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-12-10T22:32:40.000Z (6 months ago)
- Last Synced: 2025-04-04T07:35:58.177Z (2 months ago)
- Language: Go
- Homepage:
- Size: 205 KB
- Stars: 3
- Watchers: 6
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
# Culqi-Go
[](https://pkg.go.dev/github.com/culqi/culqi-go)
[](https://github.com/culqi/culqi-go)
[](https://codeclimate.com/github/culqi/culqi-go)
Nuestra Biblioteca Go oficial, es compatible con la v2.0 del Culqi API, con el cual tendrás la posibilidad de realizar cobros con tarjetas de débito y crédito, Yape, PagoEfectivo, billeteras móviles y Cuotéalo con solo unos simples pasos de configuración.
Nuestra biblioteca te da la posibilidad de capturar el `status_code` de la solicitud HTTP que se realiza al API de Culqi, así como el `response` que contiene el cuerpo de la respuesta obtenida.
| Versión actual| Culqi API|
|----|----|
| 1.0.0 (15-08-2023) |v2 [Referencia de API](https://apidocs.culqi.com/)|
## Requisitos
- Go 1.6+
* Afiliate [aquí](https://afiliate.culqi.com/).
* Si vas a realizar pruebas obtén tus llaves desde [aquí](https://integ-panel.culqi.com/#/registro), si vas a realizar transacciones reales obtén tus llaves desde [aquí](https://panel.culqi.com/#/registro).
> Recuerda que para obtener tus llaves debes ingresar a tu CulqiPanel > Desarrollo > ***API Keys***.
> Recuerda que las credenciales son enviadas al correo que registraste en el proceso de afiliación.
* Para encriptar el payload debes generar un id y llave RSA ingresando a CulqiPanel > Desarrollo > RSA Keys.
## Instalación
### Vía "go get"
Ejecuta los siguientes comandos:
```bash
go get github.com/culqi/culqi-go
go get "github.com/google/uuid"
```
### Manualmente
Clonar el repositorio o descargarse el código fuente.
```bash
$ git clone [email protected]:culqi/culqi-go.git
```
## Inicio rápido
Importando culqi-go:
```go
import (
culqi "github.com/culqi/culqi-go"
)
```
## Configuración
Para empezar a enviar peticiones al API de Culqi debes configurar tu llave pública (pk), llave privada (sk).
Para habilitar encriptación de payload debes configurar tu rsa_id y rsa_public_key.
```go
func main() {
// 1. llaves
culqi.Key("pk_test_xxx", "sk_test_xxx")
encryptiondData = []byte(`{
"rsa_public_key": "` + rsa_public_key + `",
"rsa_id": "` + rsa_id + `"
}`)
}
```
## Encriptar payload
Para encriptar el payload necesitas crear un id RSA y llave RSA, para esto debes ingresa a tu panel y hacer click en la sección “Desarrollo / RSA Keys” de la barra de navegación a la mano izquierda.
Luego declara en variables el id RSA y llave RSA en tu backend, y envialo en las funciones de la librería.
Ejemplo
```go
rsa_public_key := "la llave pública RSA";
rsa_id := "el id de tu llave"
_, res, err := culqi.CreateToken(jsonData, encryptiondData...)
```
## Servicios
### Crear un token
Antes de crear un Cargo o Card es necesario crear un `token` de tarjeta.
Lo recomendable es generar los 'tokens' con [Culqi Checkout v4](https://docs.culqi.com/es/documentacion/checkout/v4/culqi-checkout/) o [Culqi JS v4](https://docs.culqi.com/es/documentacion/culqi-js/v4/culqi-js/) **debido a que es muy importante que los datos de tarjeta sean enviados desde el dispositivo de tus clientes directamente a los servidores de Culqi**, para no poner en riesgo los datos sensibles de la tarjeta de crédito/débito.
> Recuerda que cuando interactúas directamente con el [API Token](https://apidocs.culqi.com/#tag/Tokens/operation/crear-token) necesitas cumplir la normativa de PCI DSS 3.2. Por ello, te pedimos que llenes el [formulario SAQ-D](https://listings.pcisecuritystandards.org/documents/SAQ_D_v3_Merchant.pdf) y lo envíes al buzón de riesgos Culqi.
```go
statusCode, res, err := culqi.CreateToken(jsonData)
```
### Crear un cargo
Crear un cargo significa cobrar una venta a una tarjeta. Para esto previamente deberías generar el `token` y enviarlo en parámetro **source_id**.
Los cargos pueden ser creados vía [API de devolución](https://apidocs.culqi.com/#tag/Cargos/operation/crear-cargo).
```go
statusCode, res, err := culqi.CreateCharge(json)
```
Para realizar un cargo recurrente, puedes utilizar el siguiente código:
```go
var optiomalParams := []byte(`{
"custom_headers": {
"X-Charge-Channel": "recurrent"
}
}`)
statusCode, res, err := culqi.CreateCharge(json, optiomalParams...)
```
### Crear devolución
Solicita la devolución de las compras de tus clientes (parcial o total) de forma gratuita a través del API y CulqiPanel.
Las devoluciones pueden ser creados vía [API de devolución](https://apidocs.culqi.com/#tag/Devoluciones/operation/crear-devolucion).
```go
statusCode, res, err := culqi.CreateRefund(json)
```
### Crear un Cliente (customer)
El **cliente** es un servicio que te permite guardar la información de tus clientes. Es un paso necesario para generar una [tarjeta](/es/documentacion/pagos-online/recurrencia/one-click/tarjetas).
Los clientes pueden ser creados vía [API de cliente](https://apidocs.culqi.com/#tag/Clientes/operation/crear-cliente).
```go
statusCode, res, err := culqi.CreateCustomer(json)
```
### Crear una tarjeta (card)
La **tarjeta** es un servicio que te permite guardar la información de las tarjetas de crédito o débito de tus clientes para luego realizarles cargos one click o recurrentes (cargos posteriores sin que tus clientes vuelvan a ingresar los datos de su tarjeta).
Las tarjetas pueden ser creadas vía [API de tarjeta](https://apidocs.culqi.com/#tag/Tarjetas/operation/crear-tarjeta).
```go
statusCode, res, err := culqi.CreateCard(json)
```
### Crear un plan
El plan es un servicio que te permite definir con qué frecuencia deseas realizar cobros a tus clientes.
Un plan define el comportamiento de las suscripciones. Los planes pueden ser creados vía el [API de Plan](https://apidocs.culqi.com/#/planes#create) o desde el **CulqiPanel**.
```go
statusCode, res, err := culqi.CreatePlan(jsonDataPlan)
```
### Crear una suscripción (suscription)
La suscripción es un servicio que asocia la tarjeta de un cliente con un plan establecido por el comercio.
Las suscripciones pueden ser creadas vía [API de suscripción](https://apidocs.culqi.com/#tag/Suscripciones/operation/crear-suscripcion).
```go
statusCode, res, err := culqi.CreateSubscription(jsonData)
```
### Crear una orden
Es un servicio que te permite generar una orden de pago para una compra potencial.
La orden contiene la información necesaria para la venta y es usado por el sistema de **PagoEfectivo** para realizar los pagos diferidos.
Las órdenes pueden ser creadas vía [API de orden](https://apidocs.culqi.com/#tag/Ordenes/operation/crear-orden).
```go
statusCode, res, err := culqi.CreateOrder(jsonData)
```
## Pruebas
```bash
$ go test -v ./test/ -public_key=pk_test_xxx -secret_key=sk_test_xxx
```
---
## Documentación
- [Referencia de Documentación](https://docs.culqi.com/)
- [Referencia de API](https://apidocs.culqi.com/)
- [Demo Checkout V4 + Culqi 3DS](https://github.com/culqi/culqi-go-demo-checkoutv4-culqi3ds)
- [Wiki](https://github.com/culqi/culqi-go/wiki)
## Changelog
Todos los cambios en las versiones de esta biblioteca están listados en
[CHANGELOG](CHANGELOG).
## Autor
Team Culqi
## Licencia
El código fuente de culqi-python está distribuido bajo MIT License, revisar el archivo LICENSE.