Referencia de la API de QuikiPay ()
Introducción
¡Bienvenido a la API de QuikiPay!
QuikiPay es una plataforma de pagos digitales que permite a empresas de todo el mundo vender productos y servicios a clientes en LATAM a través de métodos de pago locales populares (Tarjeta de crédito, Tarjeta de débito, Criptomoneda, Transferencia bancaria), y también para realizar pagos a empresas (comercios) en LATAM y personas físicas (PayOut).
Este documento tiene como objetivo guiar a los desarrolladores para conectar su plataforma a nuestros servicios a través de una API.
Cómo empezar
1) Tienes que registrar una cuenta https://sandbox.quikipay.com
2) Verifica tu cuenta usando tu correo electrónico.
3) Una vez verificado, inicie sesión en su cuenta con sus credenciales, vaya a la pestaña API KEY y busque la clave API. La clave API (ID de comerciante) se utiliza en cada solicitud.
Si no quieres ser cliente prueba nuestra API! Simplemente póngase en contacto con nuestro equipo en br@quikipay.com / mt@quikipay.com para obtener una credencial gratuita y acceso instantáneo a nuestro entorno sandbox para probar nuestros productos.
Si tienes alguna duda sobre nuestro producto desde una perspectiva comercial, echa un vistazo a aquí o ponte en contacto con nuestro equipo comercial.
Verificar
Si no es desarrollador, no se preocupe, Quikipay tiene un método de pago. Este tipo de integración no requiere desarrollo.
Simplemente presione una API, enviará una URL de ENLACE DE PAGO en respuesta y tendrá que redirigir al usuario al enlace de pago.
Quikipay procederá y entretendrá el proceso de pago para el usuario y lo redirigirá de nuevo con succuss/fail estados
Note : success_url y cancel_url deben ser URL POST
El método de pago funciona con una base de IP de geolocalización, QP mostrará todos los métodos de pago admitidos en el país respectivo del usuario final, pero si desea mostrar el método de pago del país seleccionado, entonces puede pasar "country_code" como campo opcional en el cuerpo de la solicitud. El código de país debe ser Iso-alfa-2, que se puede obtener de here
PARÁMETROS SOLICITADOS (application/json)
merchant
requerido
Cuerda
API KEY
customer_name
requerido
Cuerda
Nombre del cliente
customer_email
requerido
Correo electrónico
Correo electrónico del cliente
code
opcional
Cuerda
Payment Method Code to Bound checkout to specific PM
currency
requerido
Cadena (código de 3 dígitos)
Código de moneda del país
amount
requerido
Cuerda
La cantidad que desea pagar. No requerido en caso de pagos Crypto Base.
sub_wallet_id
opcional
Cuerda
Sub Wallet UUID. Requerido en caso de pago Crypto Base con billetera.
order_id
requerido
Cuerda
La identificación de la orden.
product_data
opcional
Cuerda
Product Data
success_url
requerido
Cuerda
POST url, Quikipay redirigirá después de una transacción exitosa.
cancel_url
requerido
Cuerda
POST url, Quikipay redirigirá después de una transacción fallida.
callback_url
requerido
Cuerda
POST url, la url donde el webhook enviará datos en formato de publicación. Más información
signature
requerido
Cuerda
La firma es "Hash" del cuerpo de su solicitud Como crear firma
| Numero de serie | Método de pago | Código | Los paises | Alcance |
|---|---|---|---|---|
| 1 | CREDIT DEBIT CARD | XCP-09 | Chile, Venezuela, Costa Rica, El Salvador, Peru, Panama, Argentina, Colombia, Mexico, Brazil, Ecuador, Guatemala, Others | { CHECKOUT } |
| 2 | CRYPTO | C-01 | Chile, Venezuela, Costa Rica, El Salvador, Peru, Panama, Argentina, Colombia, Mexico, Brazil, Ecuador, Guatemala, Others | { CHECKOUT } |
| 3 | BANK CASH | SPC-03 | Costa Rica, Peru, Panama, Colombia, Mexico, Brazil, Ecuador, Guatemala | { CHECKOUT } |
| 4 | BANK ONLINE | SPB-04 | Costa Rica, Peru, Colombia, Mexico, Brazil, Ecuador, Guatemala | { CHECKOUT } |
| 5 | BANK ONLINE | BT-01 | Chile, Argentina | { CHECKOUT } |
| 6 | BANK ONLINE | SPBB-04 | Brazil | { CHECKOUT } |
| 7 | BANK ONLINE | CCX-12 | Venezuela | { CHECKOUT } |
| 8 | BANK ONLINE | TB-13 | Chile | { CHECKOUT } |
| 9 | BANK CASH | BCD-14 | Chile, Argentina | { CHECKOUT } |
| 10 | CREDIT DEBIT CARD | CTC-01 | Chile, Venezuela, Costa Rica, El Salvador, Peru, Panama, Argentina, Colombia, Mexico, Brazil, Ecuador, Guatemala, Others | { CHECKOUT } |
| 11 | CREDIT DEBIT CARD | WT-01 | Chile, Venezuela, Costa Rica, El Salvador, Peru, Panama, Argentina, Colombia, Mexico, Brazil, Ecuador, Guatemala, Others | { CHECKOUT } |
Respuestas
RESPUESTA ESQUEMA (application/json)
payment_url
Cuerda
"https://sandbox.quikipay.com/pay/qoUTfsfCMCfDN"
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
https://sandbox.quikipay.com/api/v1.1/payment/checkout
Esquema del cuerpo de la solicitud
{
"merchant" : "bp2igV9ORor9U1BwF0omKvNQezSIIhpn5",
"customer_email" : "Johndoe@gmail.com",
"currency" : "USD",
"order_id" : "15df568r8dvsdfsdfrg6",
"amount" : "1000",
"success_url" : "https://sandbox.quikipay.com/success",
"cancel_url" : "https://sandbox.quikipay.com/cancel",
"callback_url" : "https://sandbox.quikipay.com/callback",
"products_data" : "null",
"code" : (optional) "C-01",
"country_code" : (optional) (Iso-alpha-2) "CL",
signature : "7b2432f49cfa24490203fb731
}
Muestras de respuesta
Respuesta 200
{
"payment_url" : "https://test.quikipay.com/pay/oFngYdLOMr"
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Pagos
El momento del pago es un paso del ciclo de vida de una venta que ocurre cuando la información sobre el producto y las preferencias de pago del consumidor está listo. Por favor sigue el instrucciones a continuación para saber qué información se necesita para procesar un pago. Típicamente, un pago podría estar en el siguiente estado:
Métodos de pago
La siguiente tabla muestra los campos específicos para obtener un método de pago.
Los países están relacionados con los USUARIOS FINALES. Significa que si su usuario final pertenece a CHILE y desea aceptar el pago en moneda CLP, entonces debe elegir los métodos de pago de QUIKIPAY Chile.
- La siguiente tabla muestra el nombre de los países con el código de país y moneda.
| Nombre del país | Código de país | Código de moneda |
|---|---|---|
| Chile | cl | { CLP } |
| Venezuela | ve | { VEF } |
| Costa Rica | cr | { CRC } |
| El Salvador | sv | { USD } |
| Perú | pe | { SOL, USD } |
| Panamá | pa | { PAB, USD } |
| Argentina | ar | { ARS } |
| Colombia | co | { COP } |
| México | mx | { MXN } |
| Brasil | br | { BRL } |
| Ecuador | ec | { USD } |
| Guatemala | gt | { GTQ } |
| Otras | o | { USD } |
ENCABEZADO SOLICITADO
Api-Key
No requerido
No requerido
Sin clave API o token
PARÁMETROS DE URL
Country Code
requerido
Cadena (2 dígitos)
Su código de país p.ej
cl,pe,ar,co,cr,mx,br,o
Currency Code
requerido
Cadena (3 dígitos)
Su código de moneda
p.ej CLP,SOL,PAB,ARS,COP,CRC,MXN,BRL,USD
Respuestas
ESQUEMA DE RESPUESTA(application/json)
Success Code
Booleano (Verdadero o Falso)
Verdadero
Country Name
Cuerda
El nombre de tu país.
Data
Cadena (json)
Lista de métodos de pago utilizados en el país requerido, nombre de pago y código de pago.
ESQUEMA DE RESPUESTA(application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Moneda no válida para el país de destino.
Muestras de respuesta
Respuesta 200
{
"success" : true,
"country" : {
"country" : "Chile",
"country_code" : "cl",
"currency_code" : "CLP"
},
"data" : {
"CRYPTO" : {
"name" : "CRYPTO (C-01)",
"code" : "C-01"
},
"DEBIT CARD" : {
"name" : "DEBIT CARD (BD-05)",
"code" : "BD-05"
}
}
}
Respuesta de error 422
{
"success" : "false",
"message" : "Invalid Currency for target country"
}
Métodos de pago
Habilitar y Deshabilitar Métodos de Pago
1) El primer paso es registrarse como comerciante en Quikipay. Después de eso, el administrador habilita los métodos de pago del comerciante, y el comerciante puede ver sus métodos de pago.
2) El comerciante puede habilitar o deshabilitar los métodos de pago según sus necesidades
Establecer Límite Mínimo de Depósito
1)Si el método de pago está habilitado desde el lado del administrador, el comerciante puede establecer el límite mínimo de depósito para cada método de pago.
1) Para establecer el límite mínimo para un método de pago, haga clic en su botón de actualización.
3) Haga clic en el botón de actualización después de escribir el límite mínimo que desea.
Habilitar y Deshabilitar Aceptación Automática de Cripto
Hay tres opciones disponibles para los comerciantes si el método de pago de criptomonedas (C-01) ha sido habilitado por el administrador.
-
Aceptación Automática de Cripto (C-01)
-
Aceptación Automática de Cripto Excedida (C-01)
-
Reembolso de Cripto (C-01)
Aceptación Automática de Cripto (C-01)
Esto se utiliza para aceptar transacciones con montos bajos de hasta 3 USD.
Aceptación Automática de Cripto Excedida (C-01)
Cuando se detecta un monto pagado en exceso, se utiliza para aceptar la transacción.
Reembolso de Cripto (C-01)
Se utiliza para reembolsar transacciones cuando se detecta un monto bajo.
Crear un pago
Quikipay proporciona múltiples métodos de pago a los comerciantes. El comerciante puede integrar el pago métodos para los usuarios finales. Si el comerciante quiere aceptar el pago de Chile, debe integrar el pago de CHILE métodos con moneda CLP.
Por favor seleccione su país:El pago se puede crear utilizando las siguientes formas:
Códigos de métodos de pago
Mostrar todos los métodos de pagoNote : Se requiere el código del método de pago para seleccionar o elegir su método de pago para pagar.
La siguiente tabla muestra los métodos de pago disponibles para con códigos:
| Numero de serie | Método de pago | Código | Alcance |
|---|---|---|---|
| 1 | CREDIT DEBIT CARD | XCP-09 | { API } |
| 2 | CRYPTO | C-01 | { API } |
| 3 | BANK ONLINE | BT-01 | { API } |
| 4 | BANK ONLINE | TB-13 | { API } |
| 5 | BANK CASH | BCD-14 | { API } |
| 6 | CREDIT DEBIT CARD | CTC-01 | { API } |
| 7 | CREDIT DEBIT CARD | WT-01 | { API } |
| 1 | CREDIT DEBIT CARD | XCP-09 | { API } |
| 2 | CRYPTO | C-01 | { API } |
| 3 | CREDIT DEBIT CARD | CTC-01 | { API } |
| 4 | CREDIT DEBIT CARD | WT-01 | { API } |
| 1 | CREDIT DEBIT CARD | XCP-09 | { API } |
| 2 | CRYPTO | C-01 | { API } |
| 3 | BANK CASH | SPC-03 | { API } |
| 4 | BANK ONLINE | SPB-04 | { API } |
| 5 | CREDIT DEBIT CARD | CTC-01 | { API } |
| 6 | CREDIT DEBIT CARD | WT-01 | { API } |
| 1 | CREDIT DEBIT CARD | XCP-09 | { API } |
| 2 | CRYPTO | C-01 | { API } |
| 3 | CREDIT DEBIT CARD | CTC-01 | { API } |
| 4 | CREDIT DEBIT CARD | WT-01 | { API } |
| 1 | CREDIT DEBIT CARD | XCP-09 | { API } |
| 2 | CRYPTO | C-01 | { API } |
| 3 | BANK CASH | SPC-03 | { API } |
| 4 | BANK ONLINE | SPB-04 | { API } |
| 5 | CREDIT DEBIT CARD | CTC-01 | { API } |
| 6 | CREDIT DEBIT CARD | WT-01 | { API } |
| 1 | CREDIT DEBIT CARD | XCP-09 | { API } |
| 2 | CRYPTO | C-01 | { API } |
| 3 | BANK CASH | SPC-03 | { API } |
| 4 | CREDIT DEBIT CARD | CTC-01 | { API } |
| 5 | CREDIT DEBIT CARD | WT-01 | { API } |
| 1 | CREDIT DEBIT CARD | XCP-09 | { API } |
| 2 | CRYPTO | C-01 | { API } |
| 3 | BANK ONLINE | BT-01 | { API } |
| 4 | BANK CASH | BCD-14 | { API } |
| 5 | CREDIT DEBIT CARD | CTC-01 | { API } |
| 6 | CREDIT DEBIT CARD | WT-01 | { API } |
| 1 | CREDIT DEBIT CARD | XCP-09 | { API } |
| 2 | CRYPTO | C-01 | { API } |
| 3 | BANK CASH | SPC-03 | { API } |
| 4 | BANK ONLINE | SPB-04 | { API } |
| 5 | CREDIT DEBIT CARD | CTC-01 | { API } |
| 6 | CREDIT DEBIT CARD | WT-01 | { API } |
| 1 | CREDIT DEBIT CARD | XCP-09 | { API } |
| 2 | CRYPTO | C-01 | { API } |
| 3 | BANK CASH | SPC-03 | { API } |
| 4 | BANK ONLINE | SPB-04 | { API } |
| 5 | CREDIT DEBIT CARD | CTC-01 | { API } |
| 6 | CREDIT DEBIT CARD | WT-01 | { API } |
| 1 | CREDIT DEBIT CARD | XCP-09 | { API } |
| 2 | CRYPTO | C-01 | { API } |
| 3 | BANK CASH | SPC-03 | { API } |
| 4 | BANK ONLINE | SPB-04 | { API } |
| 5 | BANK ONLINE | SPBB-04 | { API } |
| 6 | CREDIT DEBIT CARD | CTC-01 | { API } |
| 7 | CREDIT DEBIT CARD | WT-01 | { API } |
| 1 | CREDIT DEBIT CARD | XCP-09 | { API } |
| 2 | CRYPTO | C-01 | { API } |
| 3 | BANK CASH | SPC-03 | { API } |
| 4 | BANK ONLINE | SPB-04 | { API } |
| 5 | CREDIT DEBIT CARD | CTC-01 | { API } |
| 6 | CREDIT DEBIT CARD | WT-01 | { API } |
| 1 | CREDIT DEBIT CARD | XCP-09 | { API } |
| 2 | CRYPTO | C-01 | { API } |
| 3 | BANK CASH | SPC-03 | { API } |
| 4 | BANK ONLINE | SPB-04 | { API } |
| 5 | CREDIT DEBIT CARD | CTC-01 | { API } |
| 6 | CREDIT DEBIT CARD | WT-01 | { API } |
| 1 | CREDIT DEBIT CARD | XCP-09 | { API } |
| 2 | CRYPTO | C-01 | { API } |
| 3 | CREDIT DEBIT CARD | CTC-01 | { API } |
| 4 | CREDIT DEBIT CARD | WT-01 | { API } |
Pago Con Tarjeta De Crédito/Débito (XCP-09)
No es más que enviar dinero utilizando una tarjeta Master Débito/Crédito, de forma segura y rápida. Estamos aceptando MASTER CARD de todos los países y tarjetas VISA.
Limitaciones:
- Límite máximo 10.000$ / día
- El comerciante puede establecer un límite de pedido mínimo desde el Panel de comerciantes
- Máximo de solicitudes exitosas 5 / día / dirección IP o Tarjeta
- Solicitudes fallidas máximas 10 / día / dirección IP o tarjeta
Tarjetas de prueba (ARS)
| Número de tarjeta | Mes/año | Cvv | Marca | Estado |
|---|---|---|---|---|
| 4507990000004905 | 08/30 | 123 | Visa | ACCEPTED |
| 4546400044997331 | 08/30 | 123 | Visa | DENIED |
| 4258210000474094 | 08/30 | 123 | Visa | INSUFFICIENT FUNDS |
| 4517721004856075 | 08/30 | 123 | Visa | ACCEPTED |
| 4517720194823929 | 08/30 | 123 | Visa | INSUFFICIENT FUNDS |
| 5299910010000015 | 08/30 | 123 | MasterCard | ACCEPTED |
| 5204230010000010 | 08/30 | 123 | MasterCard | INSUFFICIENT FUNDS |
Tarjetas de prueba (USD)
| Número de tarjeta | Mes/año | Cvv | Marca | Estado |
|---|---|---|---|---|
| 4059310181757001 | 5/30 | 321 | Visa | ACCEPTED |
| 4916012776136988 | 5/30 | 321 | Visa | ACCEPTED |
| 4716040174085053 | 5/30 | 321 | Visa | ACCEPTED |
| 4143766247546688 | 5/30 | 321 | Visa | ACCEPTED |
| 5451819737278230 | 5/30 | 321 | MasterCard | ACCEPTED |
| 5161216979741515 | 5/30 | 321 | MasterCard | ACCEPTED |
| 5372362326060103 | 5/30 | 321 | MasterCard | ACCEPTED |
Los siguientes son los parámetros necesarios para la tarjeta de débito/crédito.
A SEON, nuestro objetivo es facilitar la lucha contra el fraude. Nuestra actualización reciente presenta las Listas personalizadas como otra forma de ayudarlo a detectar el fraude antes de que suceda. Las listas personalizadas son una forma conveniente de crear sus listas de seguimiento para ciertas transacciones e interacciones, sin tener que crear reglas con capas de parámetros..
SEON api también está integrado en nuestro sistema para acceder a esto necesita instalar JavaScript Agente v4
card_holder_name
requerido
Cuerda
Nombre del titular de la tarjeta.
card_number
requerido
Cadena de 16,13,18 dígitos
Número de tarjeta.
document_type
requerido
[
NATIONAL_ID
OR TAX_ID
]
Tipo de Documento.
document_no
requerido
125686849
Documento núm.
phone_number
requerido
+923125686849
Número de teléfono.
expiration_month
requerido
Cadena de 2 dígitos
Meses de vencimiento.
expiration_year
requerido
Cadena de 2 dígitos, por ejemplo, 21
Año de caducidad
cvv
requerido
Cadena de 3 dígitos, por ejemplo, 221
CVV
sub_wallet_id
opcional
Cuerda
UUID de subbilletera. Solo es necesario cuando el comerciante tiene permiso para crear subbilletera.
Responses
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Su pago se ha realizado correctamente..
JSON
Cuerda
Detalles de la transacción
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"customer_name" : "John Doe",
"customer_email" : "Johndoe@gmail.com",
"currency_code" : "USD",
"success_url" : "https://sandbox.quikipay.com/",
"cancel_url" : "https://sandbox.quikipay.com/",
"callback_url" : "https://sandbox.quikipay.com/",
"end_user_ip" : "106.243.245.255",
"order_id" : "15df568r8sdfsdfrg6",
"amount" : "50.025",
"payment_method_code" : "XCP-09",
"card_number" : "55555561111114321",
"cvv" : "586",
"card_holder_name" : "abc",
"document_type" : "NATIONAL_ID",
"document_no" : "12548769",
"phone_number" : "+9231539052337",
"expiration_year" : "23",
"expiration_month" : "08",
"signature" : "d506668e384120ccc81fed82076196a98"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"message" : "Your payment is proceeded successfully.",
"error_code" : null,
"transaction" : {
"id" : 19003,
"user_id" : 2,
"support_ticket_id" : null,
"order_id" : "X-01SFDfEDddfsddssdsddsfdsg",
"currency_symbol" : "CLP",
"second_currency" : null,
"quantity" : "100.00000000",
"paid_amount" : "100.00000000",
"paid_amount_usd" : "100.00000000",
"fees" : "7.50000000",
"fx_rate" : "1xUSD= 1USD",
"deposit_at" : "2022-03-11 10:33:12",
"status" : "COMPLETED",
"rejected_reason" : null,
"customer_email" : "kaleemjan786@gmail.com",
"created_at" : "2022-03-11T13:33:12.000000Z",
"modified_at" : "2022-03-11 14:18:33",
"updated_at" : "2022-03-11T17:18:38.000000Z",
"payment_Type" : "Cryptocurrency(BTC)",
"products_data" : null,
"customer_name" : "test customer",
"end_user_ip" : "1.178.63.255",
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
document-new.stripe_payment (CST-09)
document-new.stripe_all_over_world.
Los siguientes son los parámetros necesarios para la tarjeta de débito/crédito.
Responses
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Su pago se ha realizado correctamente..
JSON
Cuerda
Detalles de la transacción
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"customer_name" : "John Doe",
"customer_email" : "Johndoe@gmail.com",
"currency_code" : "USD",
"success_url" : "https://sandbox.quikipay.com/",
"cancel_url" : "https://sandbox.quikipay.com/",
"callback_url" : "https://sandbox.quikipay.com/",
"end_user_ip" : "106.243.245.255",
"order_id" : "15df568r8sdfsdfrg6",
"amount" : "50.025",
"payment_method_code" : "CST-09",
"signature" : "d506668e384120ccc81fed82076196a98"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"message" : "Your payment is proceeded successfully.
Kindly redirect customer to following url to proceed",
"order_id" : "X-asesds2s13",
"url" : "https://checkout.stripe.com/c/pay/cs_test_a1D7YXDoZJpBHM097lfsw9kC"
"transaction" : {
"id" : 20472
"payment_id" : 21605,
"order_id" : "X-asesds2s13",
"user_id" : 2,
"deposit_id" : 1951,
"pay_amount" : 500,
"pay_currency" : "SOL",
"code" : "CST-09",
"currency_symbol" : "USD",
"second_currency" : null,
"quantity" : "135.7588",
"deposit_at" : "2023-10-27 03:52:17",
"status" : "PENDING",
"rejected_reason" : null,
"payment_Type" : "Stripe (Credit/Debit Card)",
"customer_email" : "approved.cardpay@xcoop.global",
"customer_name" : "test customer",
"end_user_ip" : "1.178.63.255",
"fx_rate" : "1xUSD = 1 USD",
"country_code" : "AR",
"modified_at" : "2023-10-27T06:52:17.116813Z",
"updated_at" : "2023-10-27T06:52:17.000000Z",
"created_at" : "2023-10-27T06:52:17.000000Z",
}
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Pago Con Tarjeta De Crédito/Débito (CTC-01)
No es más que enviar dinero utilizando una tarjeta Master Débito/Crédito, de forma segura y rápida. Estamos aceptando MASTER CARD de todos los países y tarjetas VISA.
Tarjetas de prueba (USD)
| Número de tarjeta | Mes/año | Cvv | Marca | Estado |
|---|---|---|---|---|
| 4111111111111111 | 10/33 | 123 | Visa | Accepted |
Los siguientes son los parámetros necesarios para la tarjeta de débito/crédito.
card_holder_name
requerido
Cuerda
Nombre del titular de la tarjeta.
document_type
requerido
[
NATIONAL_ID
OR TAX_ID
]
Tipo de Documento.
document_no
requerido
125686849
Documento núm.
Responses
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Su pago se ha realizado correctamente..
JSON
Cuerda
Detalles de la transacción
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"customer_name" : "John Doe",
"customer_email" : "Johndoe@gmail.com",
"currency_code" : "USD",
"success_url" : "https://sandbox.quikipay.com/",
"cancel_url" : "https://sandbox.quikipay.com/",
"callback_url" : "https://sandbox.quikipay.com/",
"end_user_ip" : "106.243.245.255",
"order_id" : "15df568r8sdfsdfrg6",
"amount" : "50.025",
"payment_method_code" : "CTC-01",
"card_holder_name" : "abc",
"document_type" : "NATIONAL_ID",
"document_no" : "12548769",
"signature" : "d506668e384120ccc81fed82076196a98"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"message" : "Your payment is proceeded successfully.
Kindly redirect customer to following url to proceed",
"order_id" : "X-QWs8s9as",
"url" : "http://dev-ramp-deposit.nivapay.com/order?
order_id=74793R1N6O&hash=93c04796154e9222f5f043c9e95cdce9",
"transaction" : {
"payment_id" : 21756,
"order_id" : "X-QWs8s9as",
"user_id" : 153,
"deposit_id" : 2609,
"pay_amount" : 24000,
"pay_currency" : "ARS",
"code" : "CTC-01",
"currency_symbol" : "USD",
"second_currency" : null,
"quantity" : "65.7534",
"deposit_at" : "2024-01-31 09:35:39",
"status" : "PENDING",
"rejected_reason" : null,
"payment_Type" : "CTC (Credit/Debit Card)",
"tx_Type" : null,
"customer_email" : "kaleemjan786@gmail.com",
"customer_name" : "test customer",
"products_data" : null,
"end_user_ip" : "1.178.63.255",
"fx_rate" : null,
"country_code" : "AR",
"modified_at" : "2024-01-31T12:35:39.445304Z",
"updated_at" : "2024-01-31T12:35:39.000000Z",
"created_at" : "2024-01-31T12:35:39.000000Z",
"id": 20616
},
"billing_descriptor": {
"company": {
"name": "QuikiPay",
"logo": "https://dev.quikipay.com/payImages/logo.png"
},
"merchant": {
"company_name": "codingfire",
"logo": "http://localhost/quikipay-dev/public/storage/uploads/21xUhEMXVAgirXROaMw53gcH8QQtw2JXJRAyIVIq.jpeg"
}
}
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Pago Con Tarjeta De Crédito/Débito (WT-01)
No es más que enviar dinero utilizando una tarjeta Master Débito/Crédito, de forma segura y rápida. Estamos aceptando MASTER CARD de todos los países y tarjetas VISA.
Para la verificación del teléfono, pase 0000 con cualquier país en la zona de pruebas.
Tarjetas de prueba (USD)
| Número de tarjeta | Mes/año | Cvv | Marca | Estado |
|---|---|---|---|---|
| 4111111111111111 | 10/33 | 123 | Visa | Accepted |
Los siguientes son los parámetros necesarios para la tarjeta de débito/crédito.
card_holder_name
requerido
Cuerda
Nombre del titular de la tarjeta.
phone_number
opcional
125686849
Número de teléfono.
Responses
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Su pago se ha realizado correctamente..
JSON
Cuerda
Detalles de la transacción
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"customer_name" : "John Doe",
"customer_email" : "Johndoe@gmail.com",
"currency_code" : "USD",
"success_url" : "https://sandbox.quikipay.com/",
"cancel_url" : "https://sandbox.quikipay.com/",
"callback_url" : "https://sandbox.quikipay.com/",
"end_user_ip" : "106.243.245.255",
"order_id" : "15df568r8sdfsdfrg6",
"amount" : "50.025",
"payment_method_code" : "WT-01",
"card_holder_name" : "abc",
"phone_number" : (optional) "12548769",
"signature" : "d506668e384120ccc81fed82076196a98"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"message" : "Your payment is proceeded successfully.
Kindly redirect customer to following url to proceed",
"order_id" : "X-ASAS12s12e",
"url" : "https://quikipay.camaleonx.com/?address=0xc5d638701fcA97
70123bC2C6C4843f75377F6f69&commodity=MATIC&network=mumbai&
commodity_amount=65.75&sc_address=0xD35Adc7d8C869fFf554707A
99eA2b5cE5eAb7043&sc_input_data=0x1c9472feca43def0000000000
e&signature=5B5CAC41A16FA2273390C&click_id=021ace96-73af58adcd48d
&phone=30303030&email=kaleemjan786%40gmail.com&full_name=
Homer%20Simpson%20Simpson&date_of_birth=kaleemjan786%40
gmail.com&country_of_residence=AR",
"transaction" : {
"payment_id" : 21859,
"order_id" : "X-ASAS12s12e",
"user_id" : 2,
"deposit_id" : 2682,
"pay_amount" : 24000,
"pay_currency" : "ARS",
"code" : "WT-01",
"currency_symbol" : "USD",
"second_currency" : null,
"quantity" : "65.7534",
"deposit_at" : "2024-03-29 06:23:59",
"status" : "PENDING",
"rejected_reason" : null,
"payment_Type" : "WT (Credit/Debit Card)",
"tx_Type" : null,
"customer_email" : "kaleemjan786@gmail.com",
"customer_name" : "test customer",
"products_data" : null,
"data" : "{\"url\":\"https:\/\/quikipay.camaleonx.com\/?address=0xc5d638701fcA97
70123bC2C6C4843f75377F6f69&commodity=MATIC&network=mumbai&
commodity_amount=65.75&sc_address=0xD35Adc7d8C869fFf554707A
99eA2b5cE5eAb7043&sc_input_data=0x1c9472feca43def0000000000
e&signature=5B5CAC41A16FA2273390C&click_id=021ace96-73af58adcd48d
&phone=30303030&email=kaleemjan786%40gmail.com&full_name=
Homer%20Simpson%20Simpson&date_of_birth=kaleemjan786%40
gmail.com&country_of_residence=AR\",\"identificator\":\
"820548e2804111ab23d31e9bb35f0764\",\"cpId\":2682}",
"end_user_ip" : "1.178.63.255",
"fx_rate" : null,
"country_code" : "AR",
"modified_at" : "2024-03-29T09:23:59.728729Z",
"updated_at" : "2024-03-29T09:23:59.000000Z",
"created_at" : "2024-03-29T09:23:59.000000Z",
"id" : 20713
},
"billing_descriptor" : {
"company" : {
"name" : "QuikiPay",
"logo" : "https://dev.quikipay.com/payImages/logo.png"
},
"merchant" : {
"company_name": "QuikiPay Testing",
"logo": "http://localhost/quikipay-dev/public/storage/uploads/sdtTE5u5ZtKkDZ50ldYSjd4FPKgXgoqLMthUmCJz.jpeg"
}
}
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Criptomoneda (todos los países) (C-01)
No es más que enviar dinero usando criptomonedas, de forma segura y rápida. Este punto final devolverá Qrcode, dirección y tasa FX para el pago, el cliente tendrá 45 minutos para el pago después de que caduque esa página de pago. Quikipay está operando en TUSDT, BUSDT, BCCOIN, USDT, USDC, BTC, ETH, LTC, XRP por ahora.
Cuando un cliente paga después de 45 minutos, la transacción se moverá a Transacciones retrasadas. Aprender más sobre Cuando los clientes paguen, el Comerciante notificará mediante Webhook (en la pestaña Notificación). Puedes aprender más sobre webhook en la pestaña webhook.
PAGAR CON MONEDERO : Los pagos de Crypto Base también se pueden pagar con Wallet pasando sub_wallet_id y se pueden pagar a través de Sub Wallet instantáneamente si Sub Wallet tiene fondos de transacción pagaderos..
Los siguientes son los parámetros requeridos para CryptoCurrency con información básica del cliente y autenticación (verdadera) como se menciona en .
crypto_code
requerido
Cadena (BTC, USDT)
Código de moneda criptográfica.
sub_wallet_id
opcional
Cuerda
Sub Wallet UUID. Requerido en caso de pago Crypto Base con billetera.
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Su pago se ha realizado correctamente..
data
JSON
DETALLE DE LA TRANSACCIÓN
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Código de error
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
string
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"customer_name" : "John Doe",
"customer_email" : "Johndoe@gmail.com",
"currency_code" : "USD",
"success_url" : "https://sandbox.quikipay.com/",
"cancel_url" : "https://sandbox.quikipay.com/",
"callback_url" : "https://sandbox.quikipay.com/",
"end_user_ip" : "106.243.245.255",
"order_id" : "15df568r8sdfsdfrg6",
"amount" : "50.025",
"payment_method_code" : "C-01",
"crypto_code" : "BTC",
"signature" : "7b2432f49cfa24490203fb731"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"message" : "Your payment is proceeded successfully.",
"data" : {
"address" : "19Y585787gN4RoBfvFrF7xaY4L5pL",
"expiry" : "30 Minutes from now.",
"amount" : 0.001746,
"currency_symbol" : "BTC",
"qr_code" : "<img class="img-float font"
height="auto" width="20" src="https://chart.googleapis
.com/chart?chs=300x300&cht=qr&chl={\"id\":8416,\"import
_date\":\"08-13-2021\",\"type\":\"BTC\",\"address\":\
"19Y585787gN4RoBfvFrCzNBkF7xaY4L5pL\",\"tag\":null,\
"payment_id\":\"95cb5653-7642-4afb-8115-a6ecb33ee98a-
2-P\",\"user_id\":2,\"created_at\":\"2021-08-16T23:
43:33.000000Z\",\"updated_at\":\"2022-03-11T13:33:12.
000000Z\"}?amount=0.001746&choe=UTF-8"/>"
}
}
Respuestas de error 400,401,403,404,500
{
"code" : Error code,
"message" : "error message."
}
Transferencia de fondos bancarios (BT-01)
El módulo de transferencia bancaria de Quikipay es un proceso de transferencia bancaria manual, cuando se crea una orden, Quikipay Devolver información bancaria, el cliente tiene que pagar por esa información para asegurar el pedido. Quikipay necesita una imagen de ID de cliente y una imagen de recibo de depósito bancario para confirmar el pedido, para cargar este información que tienes que usar CARGAR DATOS DE RECIBO sección.You can get min_limit or max_limit in response section.
Los siguientes son los parámetros requeridos .
Se mencionan todos los códigos de país encima de la mesa Puede utilizar los códigos de país donde BT-01 está habilitado. PERÚ puede aceptar USD y SOL, por eso puede usar el código de país PE y la moneda USD o SOL.
country_code
requerido
Cuerda
Código de país Alpha2. cl, pe, ar, etc.
Respuestas
RESPUESTA ESQUEMA (application/json)
"success": true,
"message": "Su pago se ha realizado correctamente..",
"bank_detail": {
"account_name": "QUICK Cxxx S.xx.",
"account_type": "Cxxx Cxxx en Soxx",
"country": "Chile",
"currency": "CLP",
"bank_name": Interbancaria,
"DNI": null,
"CBU_CVU": null,
"CUIT": null,
"RUT": null,
"RUC": "2060xxx",
"CCI": "0xx-2xx-00xxx-39"
"min_limit": 50
"max_limit": 1000
},
"billing_descriptor": {
"company": {
"name": "QuikiPay",
"logo":
"https://dev.quikipay.com/payImages/logo.png"
"merchant": {
"company_name": "PRUEBAS",
"logo": "https://dev.quikipay.com/storage/uploads/tVquTuI6IUkR88fTprVbbY6LTTQwPIICExtOuG7Y.png"
}
}
}
ESQUEMA DE RESPUESTA: (application/json)
error
Cuerda
error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
404
message
Cuerda
La identificación del comerciante no es válida.
ESQUEMA DE RESPUESTA: (application/json)
code
Número
500
message
Cuerda
Error en la carga de datos. Inténtalo de nuevo.
SOLICITAR ESQUEMA DEL CUERPO
{
"customer_name" : "John Doe",
"customer_email" : "Johndoe@gmail.com",
"currency_code" : "CLP",
"success_url" : "https://sandbox.quikipay.com/",
"cancel_url" : "https://sandbox.quikipay.com/",
"callback_url" : "https://sandbox.quikipay.com/",
"end_user_ip" : "106.243.245.255",
"order_id" : "15df568r8sdfsdfrg6",
"amount" : "50.025",
"local_usd" : true,
"payment_method_code" : "BT-01",
"country_code" : "cl",
"signature" : "7b2432f49cfa24490203fb731"
}
Muestras de respuesta
RESPUESTA 200
{
"success" : true,
"message" : "Your payment is proceeded successfully.",
"bank_detail" : {
"currency" : "CLP",
"country" : "Chile",
"account_name" : "QUIxxxx Sxxx",
"account_type" : "Cuxxx Coxxxx en Dxxxx",
"account_number" : "2003xxxxxxx",
"bank_name" : "Intxxxxx",
"swift_code" : null,
"bank_address" : null,
"DNI" : null,
"CBU_CVU" : null,
"CUIT" : null,
"RUT" : null,
"RUC" : "2060xxxxx",
"CCI" : "0xx-2xx-003xxxxxxxx",
"min_limit" : 50,
"max_limit" : 1000
},
}
Respuestas de error 404,422,500
{
"code" : Error code,
"message" : "error message."
}
Cargar datos de recibo
Sube el recibo de tu documento para confirmar tu pago.
Puede cargar documentos usando el multipart y usando la codificación base64.
Uso de varias partes
SOLICITAR ESQUEMA DEL CUERPO
merchant_id
requerido
Cuerda
ID del comerciante, ya debería existir.
order_id
requerido
Número
SOLICITAR-ID
customer_email
opcional
Correo electrónico
Correo electrónico del cliente para enviar correos.
receipt_upload
opcional
Archivo de imagen
Matriz o objeto de archivo de datos de varias partes.
(png, jpg, jpeg)
customer_id_upload
opcional
Archivo de imagen
Matriz o objeto de archivo de datos de varias partes.
(png, jpg, jpeg)
Usando codificación 64base
SOLICITAR ESQUEMA DEL CUERPO
merchant_id
requerido
Cuerda
Clave API del comerciante, puede encontrarla en el panel del comerciante => sección CLAVE API.
order_id
requerido
Número
SOLICITAR-ID
customer_email
opcional
Correo electrónico
Correo electrónico del cliente para enviar correos.
receipt_upload
opcional
codificado en base64
El valor del parámetro receive_upload es un flujo de archivo cargado codificado en base64.
La API se puede probar usando cualquier archivo en línea para una herramienta de cadena base64 como
https://www.browserling.com/tools/file-to-base64
customer_id_upload
opcional
codificado en base64
El valor del parámetro customer_id_upload es un flujo de archivo cargado codificado en base64. La API se puede probar usando cualquier archivo en línea para una herramienta de cadena base64 como
https://www.browserling.com/tools/file-to-base64
Respuestas
ESQUEMA DE RESPUESTA(application/json)
Código de éxito
Número
Cargado con éxito.
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Número
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Número
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Número
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Número
Mensaje de error
Esquema del cuerpo de la solicitud
{
"merchant_id" : "bp2igV9ORor9U1BgJVD8xWwF0om",
"receipt_upload" : "124585_5464.jpg",
"customer_id_upload" : "643443464.jpg",
"order_id" : "123322",
"customer_email" : "haideralimughalers@gmail.com",
}
SOLICITAR ESQUEMA DEL CUERPO
{
"merchant_id" : "bp2igV9ORor9U1BgJVD8xWwF0om",
"receipt_upload" : "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAasAAAH2CAYAAADOAaNEAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADs",
"customer_id_upload" : "643443464.jpg",
"order_id" : "X-SS232d990p94",
"customer_email" : "haideralimughalers@gmail.com"
}
Muestras de respuesta
Respuesta 200
{
"code" : "200",
"message" : "successfully uploaded.",
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Pagos en efectivo (SPC-03)
Uno de los métodos de pago locales es el pago en efectivo, que es un bono que los consumidores deben pagar para ir al banco. Por lo general, nuestra API le enviará un código de pago y usted debe pagar dando este código de pago.
Además, Api le enviará el código de la empresa que representará a la empresa.
En pago directo en efectivo el cliente tiene que pagar para ir al banco. Nuestra Api enviará código de empresa y código de pago. Al utilizar el código de empresa y el código de pago, el cliente pagará directamente en efectivo al banco.
Note: Es una opción elegir el banco en un país específico enviando 'bank_id' en los parámetros de solicitud.
La identificación de todos los bancos se puede obtener mediante la API (get banks) como mención abajo
Los siguientes son los parámetros necesarios para el pago en efectivo con información básica del cliente y autenticación (verdadero) como se menciona en .
bank_id
requerido
Número
ID del banco seleccionado. La lista de todos los bancos se puede obtener usando bank_get api como se explica
abajo.
phone_country_code
requerido
Número
Código de teléfono del país 3 dígitos
phone_number
requerido
Número
Número de teléfono 14 dígitos
document_type
opcional
Tipo de Documento
Requerido para Colombia y Brasil y Opcional para Chile, Aparte de eso también opcional Más información
document_no
opcional
Documento núm
Requerido para Colombia y Brasil y Opcional para Chile, Aparte de eso también opcional
city
requerido
Ciudad
Stringn, por ejemplo, Astorga
address
requerido
document-new.adress
Dirección, por ejemplo, Avenida Doutor José S. Azevedo 142
postal_code
requerido
código postal
Código postal, por ejemplo, 86730970
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Su pago se ha realizado correctamente.
location_url
Cuerda
URL de ubicación
location_id
Número
ID de ubicación del banco.
location_name
Cuerda
Nombre del lugar.
payment_instructions
JSON
Detalles del banco.
howto_pay_steps
JSON
Detalles del banco.
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
https://sandbox.quikipay.com/api/pay https://sandbox.quikipay.com/api/v1.1/pay
Esquema del cuerpo de la solicitud
{
"customer_name" : "John Doe",
"customer_email" : "Johndoe@gmail.com",
"currency_code" : "BRL",
"success_url" : "https://sandbox.quikipay.com/",
"cancel_url" : "https://sandbox.quikipay.com/",
"callback_url" : "https://sandbox.quikipay.com/",
"end_user_ip" : "106.243.245.255",
"order_id" : "15df568r8sdfsdfrg6",
"amount" : "50.025",
"payment_method_code" : "SPC-03",
"bank_id" : "8224",
"phone_country_code" : "123",
"phone_number : "123412341234",
"address" : "Avenida Doutor S.Azevedo 142",
"postal_code" : "86730970",
"city : "Astorga",
"signature" : "d506668e384120cfed82076196a98"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"message" : "Your payment is proceeded successfully.",
"payment_locations" : [{
"location_url" : "",
"location_id" : "1005",
"location_name" : "Banco de
Crédito","account" : "11102019-1",
"bank_subsidiary_code" : null,
"payment_instructions" : [{
"name" : "TransactionID"
"value" : "473491"
"display_label" : "Código
de Pag"
}],
"howto_pay_steps" : [{
"step_instruction" : "Acércate al BCP y paga al
servicio SafetyPay dando tu código de pago 473491
por el monto de USD $5.24 ó S/ 21.02."
}]
}]
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Pago en línea (SPB-04)
En el pago directo online, los clientes tienen que pagar para ir al banco. Nuestra Api enviará código de empresa y código de pago. Al usar el código de la empresa y el código de pago, el cliente pagará directamente en línea en efectivo al banco..
Note:Es una opción elegir el banco en un país específico enviando 'bank_id' en los parámetros de solicitud..
La identificación de todos los bancos se puede obtener mediante la API (get banks) como mención abajo
Los siguientes son los parámetros necesarios para el pago en efectivo con información básica del cliente y autenticación (verdadero) como se menciona en .
Los siguientes son los parámetros requeridos para el pago directo en línea..
bank_id
requerido
Número
ID del banco seleccionado. La lista de todos los bancos se puede obtener usando bank_get api como se explica abajo
phone_country_code
requerido
Número
Código telefónico del país 3 dígitos
phone_number
requerido
Número
Número de teléfono de 14 dígitos
document_type
opcional
Tipo de Documento
Requerido para Colombia y Brasil y Opcional para Chile, Aparte de eso también opcional Más información
document_no
opcional
Documento núm
Requerido para Colombia y Brasil y Opcional para Chile, Aparte de eso también opcional
city
requerido
Ciudad
Stringn, por ejemplo, Astorga
address
requerido
document-new.adress
Dirección, por ejemplo, Avenida Doutor José S. Azevedo 142
postal_code
requerido
código postal
Código postal, por ejemplo, 86730970
Respuestas
RESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Su pago se ha realizado correctamente..
location_url
Cuerda
URL de ubicación
location_id
Número
ID de ubicación del banco.
location_name
Cuerda
dasta.location_name.
payment_instructions
JSON
Detalles del banco.
howto_pay_steps
JSON
Detalles del banco.
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
RESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
RESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
https://sandbox.quikipay.com/api/pay https://sandbox.quikipay.com/api/v1.1/pay
Esquema del cuerpo de la solicitud
{
"customer_name" : "John Doe",
"customer_email" : "Johndoe@gmail.com",
"currency_code" : "BRL",
"success_url" : "https://sandbox.quikipay.com/",
"cancel_url" : "https://sandbox.quikipay.com/",
"callback_url" : "https://sandbox.quikipay.com/",
"end_user_ip" : "106.243.245.255",
"order_id" : "15df568r8sdfsdfrg6",
"amount" : "50.025",
"payment_method_code" : "SPB-04",
"bank_id" : "4081",
"phone_country_code" : "009",
"phone_number" : "12345678912312",
"address" : "Avenida José S. Azevedo 142",
"city" : "Astorga",
"postal_code" : "86730970",
"signature" : "d506668e384120cfed82076196a98"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"message" : "Your payment is proceeded successfully.",
"payment_locations" : [{
"location_url" : "",
"location_id" : "1005",
"location_name" : "Banco de
Crédito","account" : "11102019-1",
"bank_subsidiary_code" : null,
"payment_instructions" : [{
"name" : "TransactionID"
"value" : "473491"
"display_label" : "Código de Pag"
}],
"howto_pay_steps" : [{
"step_instruction" : "Conéctate a tu banca por Internet
ViaBCP como lo haces habitualmente."
"step_instruction" : "Ingresa tu clave de 6 dÃgitos."
"step_instruction" : "Selecciona la opción “Pago de
Serviciosâ€, luego “Empresas
Diversas†e ingresa en el buscador
SafetyPay."
"step_instruction" : "Selecciona SafetyPay y luego el tipo
de moneda de tu transacción."
"step_instruction" : "Al seleccionar esta opción te
solicitarán el número de
transacción y el monto que te
proporcionó la tienda."
"step_instruction" : "Confirma la transacción ingresando
tu clave electrónica (Token) y Listo!"
}]
}
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Débito/crédito (KDC-02)
No es más que enviar dinero utilizando una tarjeta Master Débito/Crédito, de forma segura y rápida. Este pago El método está disponible en todo el mundo excepto en Chile y Brasil. Estamos aceptando MASTER CARD de todos los países y tarjetas VISA.
Se mencionan los parámetros necesarios para la tarjeta de débito/crédito.
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Su pago se ha realizado correctamente..
data
URL
URL a la que redirige después de crear el pago y la transacción..
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Lista de mensajes de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
https://sandbox.quikipay.com/api/pay https://sandbox.quikipay.com/api/v1.1/pay
Esquema del cuerpo de la solicitud
{
"payment_method_code" : "KDC-02",
"currrency_code" : "CLP",
"customer_name" : "test",
"customer_email" : "test@gmail.com",
"success_url" : "https://sandbox.quikipay.com/",
"cancel_url" :"https://sandbox.quikipay.com/",
"callback_url" :"https://sandbox.quikipay.com/",
"order_id" : "15df568r8sdfsdfrg6",
"end_user_ip" : "106.243.345",
"amount" : 500000.025,
}
Muestras de respuesta
Respuesta 201 {
"success" : true,
"message": "Su pago se ha realizado correctamente..",
"data" : https://khipu.com/payment/info/54dfsdfds,
}
Respuestas de error 422,500 {
"code": Código de error,
"message": "Mensaje de error."
}
Pago en línea (SPBB-04)
En el pago directo online, los clientes tienen que pagar para ir al banco. Nuestra Api enviará código de empresa y código de pago. Al usar el código de la empresa y el código de pago, el cliente pagará directamente en línea en efectivo al banco.
Los siguientes son los parámetros requeridos para Pago en línea.
Los siguientes son los parámetros requeridos para el pago directo en línea.
Nota: BOLETO está disponible solo para BRASIL, debe usar la identificación bancaria 8366 para BOLETO
bank_id
requerido
Número
El ID del banco permanecerá estático. Utilice este ID de banco 8366
phone_country_code
requerido
Número
Código telefónico del país 3 dígitos
phone_number
requerido
Número
Número de teléfono de 14 dígitos
document_type
opcional
Tipo de Documento
Requerido para Colombia y Brasil y Opcional para Chile, Aparte de eso también opcional Más información
document_no
opcional
Documento núm
Requerido para Colombia y Brasil y Opcional para Chile, Aparte de eso también opcional
city
requerido
Ciudad
Stringn, por ejemplo, Astorga
address
requerido
Dirección
Dirección, por ejemplo, Avenida Doutor José S. Azevedo 142
postal_code
requerido
código postal
Código postal, por ejemplo, 86730970
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Su pago se ha realizado correctamente..
location_url
Cuerda
URL de ubicación
location_id
Número
ID de ubicación del banco.
location_name
Cuerda
Nombre del lugar.
payment_instructions
JSON
Detalles del banco.
howto_pay_steps
JSON
Detalles del banco.
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
https://sandbox.quikipay.com/api/pay https://sandbox.quikipay.com/api/v1.1/pay
Esquema del cuerpo de la solicitud
{
"customer_name" : "John Doe",
"customer_email" : "Johndoe@gmail.com",
"currency_code" : "BRL",
"success_url" : "https://sandbox.quikipay.com/",
"cancel_url" : "https://sandbox.quikipay.com/",
"callback_url" : "https://sandbox.quikipay.com/",
"end_user_ip" : "106.243.245.255",
"order_id" : "15df568r8sdfsdfrg6",
"amount" : "50.025",
"payment_method_code" : "SPBB-04",
"bank_id" : "8366",
"phone_country_code" : "009",
"phone_number" : "12345678912312",
"address" : "Avenida José S. Azevedo 142",
"city" : "Astorga",
"postal_code" : "86730970",
"signature" : "d506668e384120cfed82076196a98"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"message" : "Your payment is proceeded successfully.",
"payment_locations" : [{
"location_url" : "",
"location_id" : "1005",
"location_name" : "Banco de
Crédito","account" : "11102019-1",
"bank_subsidiary_code" : null,
"payment_instructions" : [{
"name" : "TransactionID"
"value" : "473491"
"display_label" : "Código de Pag"
}],
"howto_pay_steps" : [{
"step_instruction" : "Conéctate a tu banca por Internet
ViaBCP como lo haces habitualmente."
"step_instruction" : "Ingresa tu clave de 6 dÃgitos."
"step_instruction" : "Selecciona la opción “Pago de
Serviciosâ€, luego “Empresas
Diversas†e ingresa en el buscador
SafetyPay."
"step_instruction" : "Selecciona SafetyPay y luego el tipo
de moneda de tu transacción."
"step_instruction" : "Al seleccionar esta opción te
solicitarán el número de
transacción y el monto que te
proporcionó la tienda."
"step_instruction" : "Confirma la transacción ingresando
tu clave electrónica (Token) y Listo!"
}]
}
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Pago en línea (SPBP-04)
En el pago directo online, los clientes tienen que pagar para ir al banco. Nuestra Api enviará código de empresa y código de pago. Al usar el código de la empresa y el código de pago, el cliente pagará directamente en línea en efectivo al banco..
Los siguientes son los parámetros requeridos para Pago en línea.
Los siguientes son los parámetros requeridos para el pago directo en línea..
Nota: PIX está disponible solo para BRASIL, debe usar la identificación bancaria 8439 para PIX
bank_id
requerido
Número
El ID del banco permanecerá estático. Utilice este ID de banco 8439
phone_country_code
requerido
Número
Código telefónico del país 3 dígitos
phone_number
requerido
Número
Número de teléfono de 14 dígitos
document_type
opcional
Tipo de Documento
Requerido para Colombia y Brasil y Opcional para Chile, Aparte de eso también opcional Más información
document_no
opcional
Documento núm
Requerido para Colombia y Brasil y Opcional para Chile, Aparte de eso también opcional
city
requerido
Ciudad
Stringn, por ejemplo, Astorga
address
requerido
document-new.adress
Dirección, por ejemplo, Avenida Doutor José S. Azevedo 142
postal_code
requerido
código postal
Código postal, por ejemplo, 86730970
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Su pago se ha realizado correctamente..
location_url
Cuerda
URL de ubicación
location_id
Número
ID de ubicación del banco.
location_name
Cuerda
dasta.location_name.
payment_instructions
JSON
Detalles del banco.
howto_pay_steps
JSON
Detalles del banco.
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
https://sandbox.quikipay.com/api/pay https://sandbox.quikipay.com/api/v1.1/pay
Esquema del cuerpo de la solicitud
{
"customer_name" : "John Doe",
"customer_email" : "Johndoe@gmail.com",
"currency_code" : "BRL",
"success_url" : "https://sandbox.quikipay.com/",
"cancel_url" : "https://sandbox.quikipay.com/",
"callback_url" : "https://sandbox.quikipay.com/",
"end_user_ip" : "106.243.245.255",
"order_id" : "15df568r8sdfsdfrg6",
"amount" : "50.025",
"payment_method_code" : "SPBP-04",
"bank_id" : "8439",
"phone_country_code" : "009",
"phone_number" : "12345678912312",
"address" : "Avenida José S. Azevedo 142",
"city" : "Astorga",
"postal_code" : "86730970",
"signature" : "d506668e384120cfed82076196a98"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"message" : "Your payment is proceeded successfully.",
"payment_locations" : [{
"location_url" : "",
"location_id" : "1005",
"location_name" : "Banco de
Crédito","account" : "11102019-1",
"bank_subsidiary_code" : null,
"payment_instructions" : [{
"name" : "TransactionID"
"value" : "473491"
"display_label" : "Código de Pag"
}],
"howto_pay_steps" : [{
"step_instruction" : "Conéctate a tu banca por Internet
ViaBCP como lo haces habitualmente."
"step_instruction" : "Ingresa tu clave de 6 dÃgitos."
"step_instruction" : "Selecciona la opción “Pago de
Serviciosâ€, luego “Empresas
Diversas†e ingresa en el buscador
SafetyPay."
"step_instruction" : "Selecciona SafetyPay y luego el tipo
de moneda de tu transacción."
"step_instruction" : "Al seleccionar esta opción te
solicitarán el número de
transacción y el monto que te
proporcionó la tienda."
"step_instruction" : "Confirma la transacción ingresando
tu clave electrónica (Token) y Listo!"
}]
}
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Detalles de la transacción con detalles de la agencia (CCX-12)
No es más que enviar dinero mediante Transferencia Bancaria en Línea, de forma segura y rápida. Este método de pago está disponible solo en Venezuela.
Detalles bancarios en línea:
| BANK: | Banco Activo C.A., Banco Universal |
| ACCOUNT NAME: | VENECRIP C.A |
| CELL PHONE NUMBER: | 04123852582 |
| ID: | J500567960 |
Detalles para pago móvil:
| BANK NAME: | 0171 - Banco Activo C.A |
| PHONE NUMBER: | 04123852582 |
| RIF: | J500567960 |
datos de prueba
| Numero de referencia | Telefono no | Salir |
|---|---|---|
| 159753456 | 03154417708 | Generar Aprobada Transacciones |
| 175896486 | 03351548962 | Generar Aprobada Transacciones |
| 325418796 | 03005486756 | Generar Aprobada Transacciones |
Los siguientes son los parámetros requeridos para la transferencia bancaria en línea.
reference
requerido
Cadena Mín. 4 dígitos
Número de referencia del banco al enviar el pago
phone_no
requerido
Cadena de 11 dígitos
Número de teléfono del banco al enviar el pago
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Su pago se ha realizado correctamente.
JSON
Cuerda
Detalles de la transacción.
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"customer_name" : "John Doe",
"customer_email" : "Johndoe@gmail.com",
"currency_code" : "VEF",
"success_url" : "https://sandbox.quikipay.com/",
"cancel_url" : "https://sandbox.quikipay.com/",
"callback_url" : "https://sandbox.quikipay.com/",
"end_user_ip" : "106.243.245.255",
"order_id" : "15df568r8sdfsdfrg6",
"amount" : "50.025",
"payment_method_code" : "CCX-12",
"reference" : "14256874",
"phone_no" : "03854856789",
"signature" : "7b2432f49cfa24490203fb731"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"message" : "Your payment is proceeded successfully.",
"transaction" : {
"id" : 19349,
"order_id" : "X-fDd0FsdfdssdsdddddfdsdsCAA",
"user_id" : 2,
"deposit_id" : "9KVnS2IXIQbm5K7kXvLtY8a8z",
"currency_symbol" : "VEF",
"second_currency" : null,
"quantity" : 70000,
"deposit_at" : "2022-08-02 10:30:53",
"status" : "COMPLETED",
"rejected_reason" : null,
"payment_Type" : "CoinX (Online Transfer)",
"customer_email" : "kaleemjan786@gmail.com",
"customer_name" : "test customer",
"products_data" : null,
"end_user_ip" : "143.54.255.255",
"country_code" : "VE",
"modified_at" : "2022-08-02T14:30:53.995618Z",
"updated_at" : "2022-08-02T14:31:02.000000Z",
"created_at" : "2022-08-02T14:30:53.000000Z",
"paid_amount" : 70000,
"payment_status" : true,
"paid_amount_usd" : 11864.406779661016,
"fx_rate" : "5.9xVEF = 1 USD",
"fees" : 3500,
}
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Depósito en efectivo (BCD-14)
No es más que enviar dinero usando Depósito en Efectivo, de forma segura y rápida. Este método de pago está disponible solo en Argentina y Chile.
Detalles de la agencia:
| Moneda | Nombre | País | Dirección | Momento |
|---|---|---|---|---|
| CLP | Quickex | Chile | Santo Domingo 979 Local 11 | 10:00 AM To 4:00 PM |
| ARS | Quickex | Argentina | Paraguay 616, Microcentro | 10:00 AM To 4:00 PM |
Solo información básica del cliente y autenticación (verdadera) como se menciona en .
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Su pago se ha realizado con éxito. Por favor deposite efectivo en la Agencia dada
JSON
Cuerda
data.transaction_detail_agency.
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"customer_name" : "John Doe",
"customer_email" : "Johndoe@gmail.com",
"currency_code" : "ARS",
"success_url" : "https://sandbox.quikipay.com/",
"cancel_url" : "https://sandbox.quikipay.com/",
"callback_url" : "https://sandbox.quikipay.com/",
"end_user_ip" : "106.243.245.255",
"order_id" : "15df568r8sdfsdfrg6",
"amount" : "50.025",
"payment_method_code" : "BCD-14",
"signature" : "7b2432f49cfa24490203fb731"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"message" : "Your payment is proceeded successfully.
Kindly deposit cash at the given Agency.",
"agency" : {
"country" : "Argentina",
"address" : "Paraguay 616, Microcentro",
"timing" : "10:00 AM To 4:00 PM",
"order_id" : "X-fDd0F5dfsdfdsdsddsCAA",
"email" : "merchant1@gmail.com"
},
"transaction" : {
"order_id" : "X-fDd0F5dfsdfdssddsCAA",
"user_id" : 2,
"deposit_id" : "6j1KwXjb4oluH5eNqhfEROtad",
"pay_amount" : 500,
"pay_currency" : "ARS",
"code" : "BCD-14",
"currency_symbol" : "ARS",
"second_currency" : null,
"quantity" : 500,
"deposit_at" : "2022-08-12 10:33:03",
"status" : "PENDING",
"rejected_reason" : null,
"payment_Type" : "BACS (Cash Deposit)",
"customer_email" : "test_customer@gmail.com",
"customer_name" : "test customer",
"products_data" : null,
"data" : {
"country" : "Argentina",
"address" : "Paraguay 616, Microcentro",
"timing" : "10:00 AM To 4:00 PM"
},
"end_user_ip" : "143.54.255.255",
"country_code" : "BR",
"modified_at" : "2022-08-12T14:33:03.602578Z",
"updated_at" : "2022-08-12T14:33:03.000000Z",
"created_at" : "2022-08-12T14:33:03.000000Z",
"id" : 19378
},
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Transferencia en línea (PIX) (XCPP-15)
No es más que enviar dinero usando Online Transfer (PIX), de forma segura y rápida. Este el método de pago está disponible solo en Brasil.
Este método tiene algunas limitaciones, puede realizar pagos por CPF 30000 BRL/día. El Límite mínimo es 10 BRL y el Límite Máximo es 30000 BRL para el pago.
Los siguientes son los parámetros requeridos para Transferencia en línea (PIX) con base de cliente información y autenticación (verdadera) como se menciona en .
date_of_birth
requerido
Cuerda (Y-m-d)
Fecha de nacimiento
document_no
opcional
Cadena (11 dígitos)
document-new.document_number
Responses
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Su pago se realizó con éxito. Amablemente redirija al cliente a la siguiente URL para continuar.
JSON
Cuerda
Detalles de la transacción.
url
Cuerda
Redirigir url para proceder con el pago.
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"customer_name" : "John Doe",
"customer_email" : "Johndoe@gmail.com",
"currency_code" : "BRL",
"success_url" : "https://sandbox.quikipay.com/",
"cancel_url" : "https://sandbox.quikipay.com/",
"callback_url" : "https://sandbox.quikipay.com/",
"end_user_ip" : "106.243.245.255",
"order_id" : "15df568r8sdfsdfrg6",
"amount" : "50.025",
"payment_method_code" : "XCPP-15",
"date_of_birth" : "1988-12-15",
"document_no" : "70374221007",
"signature" : "7b2432f49cfa24490203fb731"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"message" : "Your payment is proceeded successfully.
Kindly redirect customer to following
url to proceed",
"url" : "http://apitest.p4f.com/1.0/Go/Auth/
7rymO3uTs9mA",
"transaction" : {
"order_id" : "X-fDZgZdsddXCddXHsXsCAA",
"user_id" : 2,
"deposit_id" : "3542a3d080ee2d7a133bc3814c",
"pay_amount" : 400,
"pay_currency" : "BRL",
"code" : "XCPP-15",
"currency_symbol" : "BRL",
"second_currency" : null,
"quantity" : 400,
"deposit_at" : "2022-08-19 09:44:05",
"status" : "PENDING",
"rejected_reason" : null,
"payment_Type" : "XCOOP (Online Transfer (PIX))",
"customer_email" : "kaleemjan786@gmail.com",
"customer_name" : "test customer",
"products_data" : null,
"data" : "{
"paymentLinkUrl" : "http://apitest.p4f.com/1.0
/Go/Auth/7rymO3uTs9mA",
"identificator" : "3542a3d080ee2d7a133bc38146c",
"cpId" : 1047
}",
"end_user_ip" : "143.54.255.255",
"country_code" : "BR",
"modified_at" : "2022-08-19T13:44:05.528322Z",
"updated_at" : "2022-08-19T13:44:05.000000Z",
"created_at" : "2022-08-19T13:44:05.000000Z",
"id" : 19393
},
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Detalles de la transacción con detalles de la agencia (TB-13)
No es más que enviar dinero mediante Transferencia Bancaria en Línea, de forma segura y rápida. Este el método de pago está disponible solo en Chile.
Cuando te aparece un formulario de autenticación puedes pasar RUT 11.111.111-1 y contraseña 123 para las pruebas.
Tarjetas de prueba
| Tipo de tarjeta | Número de tarjeta | Mes/año | Cvv | Salir |
|---|---|---|---|---|
| VISA | 4051 8856 0044 6623 | Cualquier fecha | 123 | Generar Aprobada transacciones |
| AMEX | 3700 0000 0002 032 | Cualquier fecha | 1234 | Generar Aprobada transacciones |
| TARJETA MASTERCARD | 5186 0595 5959 0568 | Cualquier fecha | 123 | Generar Declined transacciones |
| REDCOMPRA | 4051 8842 3993 7763 | Generars Aprobada transactions (for operations that allow debit Redpurchase) | ||
| REDCOMPRA | 4511 3466 6003 7060 | Generars Aprobada transactions (for operations that allow debit Redpurchase) | ||
| REDCOMPRA | 5186 0085 4123 3829 | Generars Rejected transactions (for operations that allow Redpurchase debit) | ||
| VISADO PREPAGO | 4051 8860 0005 6590 | Cualquier fecha | 123 | Generar Aprobada transacciones |
| TARJETA MASTERCARD PREPAGO | 5186 1741 1062 9480 | Cualquier fecha | 123 | Generar Declined transacciones |
Solo parámetros comunes.
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Su pago se realizó con éxito. Amablemente redirija al cliente a la siguiente URL para continuar.
JSON
Cuerda
Detalles de la transacción.
url
Cuerda
Redirigir url para proceder con el pago.
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"customer_name" : "John Doe",
"customer_email" : "Johndoe@gmail.com",
"currency_code" : "CLP",
"success_url" : "https://sandbox.quikipay.com/",
"cancel_url" : "https://sandbox.quikipay.com/",
"callback_url" : "https://sandbox.quikipay.com/",
"end_user_ip" : "106.243.245.255",
"order_id" : "15df568r8sdfsdfrg6",
"amount" : "50.025",
"payment_method_code" : "TB-13",
"signature" : "7b2432f49cfa24490203fb731"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"message" : "Your payment is proceeded successfully.Kindly
redirect customer to following url to proceed",
"url" : "http://localhost/quikipay-dev/public/pay/tb/96ea9d
48-d52d-44b4-8658-0ab8fd5806ce-2-P"
"error_code" : null,
"transaction" : {
"id" : 19003,
"user_id" : 2,
"support_ticket_id" : null,
"order_id" : "X-01SFDfEDddfsddssdsddsfdsg",
"currency_symbol" : "USD",
"second_currency" : null,
"quantity" : "50000.00",
"paid_amount" : "50000.00",
"paid_amount_usd" : "50000.00",
"fees" : "53.19",
"fx_rate" : "940xCLP= 1USD",
"deposit_at" : "2022-03-11 10:33:12",
"status" : "COMPLETED",
"rejected_reason" : null,
"customer_email" : "kaleemjan786@gmail.com",
"created_at" : "2022-03-11T13:33:12.000000Z",
"modified_at" : "2022-03-11 14:18:33",
"updated_at" : "2022-03-11T17:18:38.000000Z",
"payment_Type" : "TransBank (Online Transfer)",
"products_data" : null,
"customer_name" : "test customer",
"end_user_ip" : "1.178.63.255",
}
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Pago con comprobante bancario (BBS-08)
Uno de los métodos de pago locales en Brasil es el comprobante bancario, que es un comprobante que los consumidores necesitan para pagar en una red bancaria.
Por lo general, un comprobante bancario tarda 3 días hasta el vencimiento. Después de la solicitud de pago, el estado es
PENDIENTE.
Los siguientes son los parámetros requeridos para el depósito bancario en efectivo con información básica del cliente y autenticación (verdadero) como se menciona en .
national_id
requerido
Número (11 dígitos)
Identificación nacional del país.
full_street_address
requerido
Cuerda
Dirección completa de la calle
number
requerido
Cuerda
Número del domicilio fiscal
neighborhood
requerido
Cuerda
Barrio de dirección.
region
requerido
Cadena (2 dígitos)
Región de dirección
city
requerido
Cuerda
Nombre de la ciudad.
El nombre de la ciudad debe estar en su región.
zip_code
requerido
Número (8 dígitos)
Código postal de tu zona.
due_date
requerido
Fecha(YYYY-MM-DD)
Note:La fecha debe ser del día siguiente a la fecha actual.
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Su pago se ha realizado correctamente..
data
URL
URL a la que redirige después de crear el pago y la transacción.
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Lista de mensajes de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"customer_name" : "John Doe",
"customer_email" : "Johndoe@gmail.com",
"currency_code" : "BRL",
"success_url" : "https://sandbox.quikipay.com/",
"cancel_url" : "https://sandbox.quikipay.com/",
"callback_url" : "https://sandbox.quikipay.com/",
"end_user_ip" : "106.243.245.255",
"order_id" : "15df568r8sdfsdfrg6",
"amount" : "50.025",
"payment_method_code" : "BBS-08",
"national_id" : "00016476107",
"end_user_ip" : "103.153.15.63",
"due_date" : "2021-07-31",
"full_street_address" : "24 bdhidcon, chicago",
"number" : "2654",
"neighborhood" : "abc",
"region" : "AC",
"city" : "Rio Branco",
"zip_code" : "12345678"
"signature" : "7b2432f49cfa24490203fb731"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"message" : "Your payment is proceeded successfully.",
"data" : https://abc.com/payment/info/54dfsdfds,
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Transferencia Bancaria Electrónica Para Brasil (BET-07)
Los siguientes son los parámetros necesarios para la transferencia bancaria electrónica.
due_date
requerido
Fecha
Fecha de vencimiento YYYY-MM-DD
full_street_address
requerido
Cuerda
Dirección completa de la calle
national_id
requerido
Cuerda
DNI brasileño
number
requerido
Número
Número
neighborhood
requerido
Cuerda
document-new.neighborhood
region
requerido
Cadena (código de 2 dígitos)
El estado/región debe coincidir con la ciudad, por ejemplo, AC=>Acre, AL=>Alagoas
city
requerido
Cuerda
document-new.city
zip_code
requerido
Número (código de 8 dígitos)
Código postal
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Su pago se ha realizado correctamente..
data
Descargar icono SVG desde http://tabler-icons.io/i/chevron-right
JSON
{
"success" : true,
"message": "Su pago se ha realizado correctamente..",
"data":
{
"address": "1FBsR7h6iJA4FJ67ofK7MgCZpG1Lrij7on7",
"amount": "0.5456",
"currency_symbol": "BTC",
"qr_code": "1FBsR7h6iJA4FJ67ofK7MgCZpG1LrvGJq5"
}
}
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
https://sandbox.quikipay.com/api/pay https://sandbox.quikipay.com/api/v1.1/pay
Esquema del cuerpo de la solicitud
{
"customer_name" : "John Doe",
"customer_email" : "Johndoe@gmail.com",
"currency_code" : "BRL",
"success_url" : "https://sandbox.quikipay.com/",
"cancel_url" : "https://sandbox.quikipay.com/",
"callback_url" : "https://sandbox.quikipay.com/",
"end_user_ip" : "106.243.245.255",
"order_id" : "15df568r8sdfsdfrg6",
"amount" : "50.025",
"payment_method_code" : "BET-07",
"due_date" : "21-7-9",
"national_id" : "00016476107",
"full_street_address" : "Rua Agapito Veloso 13122",
"number" : "1-A",
"neighborhood" : "Airport",
"region" : "AC",
"city" : "Acre",
"zip_code" : "70000000"
"signature" : "7b2432f49cfa24490203fb731"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"message" : "Your payment is proceeded successfully.",
"data" : https://abc.com/payment/info/54dfsdfds,
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Forma de Pago en Efectivo (PAGO-46) (PG-11)
El módulo Quikipay Cash Payment es una pasarela manual de terceros "PAGO46".
Los únicos parámetros requeridos son los "parámetros COMUNES" en esta solicitud. Quikipay aceptará la solicitud de transacción y devolverá una URL alojada por un tercero (en este caso, PAGO46), el usuario final debe regresar a la URL alojada y realizar su pago de acuerdo con el escenario. Después de completar el pago, el usuario final se redirigirá automáticamente a la página Quikipay Success/Fail y enviará una notificación de webhook al comerciante "call_back" dirección URL Puede leer más sobre Webhook a continuación. Los siguientes son los parámetros requeridos.
- El código de moneda de Chile será CLP
- El código de moneda de Argentina será ARS
Respuestas
ESQUEMA DE RESPUESTA(application/json)
success
Booleano (Verdadero o Falso)
Verdadero
message
Cuerda
Su pago se realizó con éxito, redirija amablemente a redirect_url para continuar
redirect_url
Hipervínculo
URL de redirección para el procedimiento de pago.
ESQUEMA DE RESPUESTA: (application/json)
error
Cuerda
error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
404
message
Cuerda
La identificación del comerciante no es válida.
ESQUEMA DE RESPUESTA: (application/json)
code
Número
500
message
Cuerda
Error en la carga de datos. Inténtalo de nuevo.
Esquema del cuerpo de la solicitud
{
"customer_name" : "John Doe",
"customer_email" : "Johndoe@gmail.com",
"currency_code" : "CLP",
"success_url" : "https://sandbox.quikipay.com/",
"cancel_url" : "https://sandbox.quikipay.com/",
"callback_url" : "https://sandbox.quikipay.com/",
"end_user_ip" : "106.243.245.255",
"order_id" : "15df568r8sdfsdfrg6",
"amount" : "50.025",
"payment_method_code" : "PG-11",
"signature" : "7b2432f49cfa24490203fb731"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"message" : "Your payment is proceeded successfully.
Kindly redirect on redirect_url to proceed.",
"redirect_url" : "https://novatest.pago46.com/c1184310-a5ff-4bc4-a7f7-ab483d0ea52d",
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Pago con tarjeta de crédito (Brasil) (BC-06)
El flujo de transacciones de crédito con flujo de autorización síncrono:
- Los consumidores eligen pagar con tarjeta de crédito en su caja.
- Su plataforma envía una publicación de solicitud a nuestra API con el parámetro "type: payment_method_code"
- Tu plataforma finaliza la operación y notifica al consumidor.
Los siguientes son los parámetros necesarios para el pago en efectivo con información básica del cliente y autenticación (verdadero) como se menciona en .
national_id
requerido
Número
Identificación nacional. p.ej 00015262197, 00016476107 or 00020298048
Respuestas
ESQUEMA DE RESPUESTA(application/json)
success
Booleano (Verdadero o Falso)
Verdadero
message
Cuerda
Su pago se realizó con éxito, redirija amablemente a redirect_url para continuar.
redirect_url
Hipervínculo
Redirección para el procedimiento de pago
ESQUEMA DE RESPUESTA:(application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA:(application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA:(application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
success
booleano
Falso
message
Cuerda
Lista de mensajes de error.
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"customer_name" : "John Doe",
"customer_email" : "Johndoe@gmail.com",
"currency_code" : "BRL",
"success_url" : "https://sandbox.quikipay.com/",
"cancel_url" : "https://sandbox.quikipay.com/",
"callback_url" : "https://sandbox.quikipay.com/",
"end_user_ip" : "106.243.245.255",
"order_id" : "15df568r8sdfsdfrg6",
"amount" : "50.025",
"payment_method_code" : "BC-06",
"national_id" : "00020298048",
"signature" : "7b2432f49cfa24490203fb731"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"message" : "Your payment is proceeded successfully,
Kindly redirect on redirect_url to proceed.",
"redirect_url" : "https://abc.com/pay/bx
/redirect/X-01FDdXsSD/2",
}
Respuesta de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Pago con tarjeta de débito (Brasil) (BD-05)
El flujo de transacciones de débito con flujo de autorización síncrono:
- Los consumidores eligen pagar con tarjeta de débito en su caja.
- Su plataforma envía una publicación de solicitud a nuestra API con el parámetro "type: payment_method_code"
- Tu plataforma finaliza la operación y notifica al consumidor.
Los siguientes son los parámetros requeridos para el pago con tarjeta de débito.
national_id
requerido
Número
Número de identificación nacional del país.p. ej. 00015262197, 00016476107 or 00020298048
Respuestas
ESQUEMA DE RESPUESTA(application/json)
success
Booleano (Verdadero o Falso)
Verdadero
message
Cuerda
Su pago se realizó con éxito, redirija amablemente a redirect_url para continuar.
redirect_url
Hipervínculo
Redirección para el procedimiento de pago
ESQUEMA DE RESPUESTA:(application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA:(application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA:(application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA:(application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA:(application/json)
success
booleano
Falso
message
Cuerda
List of Mensaje de error.
ESQUEMA DE RESPUESTA:(application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"customer_name" : "John Doe",
"customer_email" : "Johndoe@gmail.com",
"currency_code" : "BRL",
"success_url" : "https://sandbox.quikipay.com/",
"cancel_url" : "https://sandbox.quikipay.com/",
"callback_url" : "https://sandbox.quikipay.com/",
"end_user_ip" : "106.243.245.255",
"order_id" : "15df568r8sdfsdfrg6",
"amount" : "50.025",
"payment_method_code" : "BD-05",
"national_id" : "00020298048",
"signature" : "7b2432f49cfa24490203fb731"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"message" : "Your payment is proceeded successfully,
Kindly redirect on redirect_url to proceed.",
"redirect_url" : "https://abc.com/pay/bx
/redirect/X-01FDdXsSD/2",
}
Respuesta de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Historial De Pagos
Obtener una lista de pagos
Devuelve una lista de pagos filtrados por un rango de datos enviados en la solicitud. La lista está paginada por los límites enviados en la solicitud.
PARÁMETROS SOLICITADOS(application/json)
merchant_id
requerido
Cuerda
CLAVE API (Id del comerciante)
Obtener detalles de pago específicos
Devuelve un pago específico filtrado por el ID enviado en la solicitud. La siguiente tabla muestra los campos específicos para esta operación:
ESQUEMA DEL CUERPO SOLICITADO
merchant_id
requerido
Cuerda
CLAVE API (Id del comerciante)
Status
opcional
Cuerda
1=> COMPLETADO, 0=> PENDIENTE. 2=> RECHAZAR
order_id
opcional
Cuerda
Una identificación de pedido única de su transacción.
Respuestas
ESQUEMA DE RESPUESTA (application/json)
user_id
Número
identificación del usuario
tx_id
Número
identificación de impuestos.
order_id
Número
ID de su pedido.
currency_symbol
Cuerda
Símbolo de moneda
status
Binario (verdadero o falso)
Estado del pedido completado o no.
customer_email
Correo electrónico
ID de correo electrónico del comerciante.
customer_name
Nombre del cliente
Nombre del cliente.
quantity
Cantidad
Cantidad total de pedido.
rejected_reason
Motivo del rechazo
Motivo del pedido rechazado.
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
Code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"merchant" : "1M2Cprnsrvt0iIB5Riem4o5m579GIT5W",
"status" : "1",
"order_id" : "54654",
}
Muestras de respuesta
Respuesta 200
{
"deposit_id" : "SuFWY1CmoBJen4jf80Cile2kt",
"order_id" : "X-21dsdfdddg3shs",
"currency_symbol" : "BTC",
"second_currency" : "BTC",
"quantity" : 0.24160509,
"paid_amount" : 0.24160509,
"paid_amount_usd" : "5000.000",
"fees" : "0.0024160509",
"fx_rate" : "20694.928x USD = 1 BTC",
"deposit_at" : "2023-03-10 15:38:56",
"status" : "COMPLETED",
"rejected_reason" : null,
"updated_at" : "2023-03-20T11:32:15.000000Z",
"payment_Type" : "Cryptocurrency(BTC)",
"customer_name" : "test customer",
"customer_email" : "zain@gmail.com"
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
"amount" : 154351,
"currency" : "USD",
"customer_email" : "example@gmail.com",
"order_id" : 1546315,
"merchant_id" : 1546315,
"success_url" : "https://sandbox.quikipay.com/",
"callback_url" : "https://sandbox.quikipay.com/",
"cancel_url" : "https://sandbox.quikipay.com/",
"products_data" : { "amount" : 154351, "currency" : "USD" } ,
}
Obtener bancos
Note: El bank_id es necesario para enviar los parámetros de solicitud para elegir el banco en el que tienes que pagar.
La lista de bancos se puede obtener mediante la API. Los parámetros solicitados para esta API se dan a continuación:
Códigos de países
- Para Colombia : COL
- Para México : MEX
- Para Panamá : PAN
- Para Brasil : BRA
- para Costa Rica : CRI
- para el salvador : SLV
- Para Ecuador: EDU
PARÁMETROS DE URL (application/json)
country_code
requerido
Cadena (carácter de 3 dígitos)
p.ej COL,BRA,CRI,MEX
limit
opcional
Número
Límite de obtener la lista de bancos
channel
requerido
Número
1=>Pago en línea
2=>Pago Directo en Efectivo
request_datetime
opcional
Fecha
Fecha y hora actual de la solicitud.
Respuestas
ESQUEMA DE RESPUESTA (application/json)
bank_id
document.code
Codigo bancario
bank_name
Cuerda
Nombre del banco.
bank_commercial_name
Cuerda
Nombre Comercial del Banco.
bank_country_code
Cuerda
document-new.country_code_of_bank.
bank_type
Cuerda
Tipo de banco.
show_stand_alone
Booleano (Verdadero o Falso)
Verdadero
business_model
Cuerda
Tipo de negocio
channel
Cuerda
Canal de pago
channel_tag
Cuerda
Etiqueta de canal de pago
bank_show_order
Número
Banco Mostrar pedido.
is_bank_subsidiary
Booleano (Verdadero o Falso)
Verdadero
bank_subsidiary_code
Cuerda
Código de filial bancaria
bank_subsidiary_name
Cuerda
Nombre de la subsidiaria del banco
bank_subsidiary_type
Cuerda
Tipo de sucursal bancaria
bank_subsidiary_rank_order
Cuerda
Orden de clasificación de subsidiaria bancaria
Status
Número
Estado
access_type
Número
Tipo de acceso
language_code
Cadena (2 dígitos)
Código de lenguaje
ESQUEMA DE RESPUESTA: (application/json)
error
Cuerda
error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
404
message
Cuerda
La identificación del comerciante no es válida..
ESQUEMA DE RESPUESTA: (application/json)
code
Número
500
message
Cuerda
Error en la carga de datos. Inténtalo de nuevo..
Muestras de respuesta
Respuesta 200
{
"4081" : "Banco Itau",
"8326" : "Bradesco",
"8183" : "Banco do Brasil",
"8042" : "Santander Brasil",
"1022" : "Banrisul"
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
"amount" : 154351,
"currency" : "USD",
"customer_email" : "example@gmail.com",
"order_id" : 1546315,
"merchant_id" : 1546315,
"success_url" : "https://sandbox.quikipay.com/",
"callback_url" : "https://sandbox.quikipay.com/",
"cancel_url" : "https://sandbox.quikipay.com/",
"products_data" : { "amount" : 154351, "currency" : "USD" } ,
}
Tasa de cambio
El pago puede ser una cantidad fija en moneda extranjera. La respuesta a esta solicitud devolverá la tasa de conversión de fx actual.
PARÁMETROS DE CABECERA
Api-Key
requerido
Cuerda
Api-Key
"bp2igV9ORor9U1BgJVD8xWwF0omsKvNQezSI"
Clave de API de comerciante para autorización
Respuestas
ESQUEMA DE RESPUESTA (application/json)
data
JSON
{
"success": true,
"base_currency":
"USD",
"quotes": {
"CLP":
{
"buy":
"802",
"sell":
"802"
},
"ARS":
{
"buy":
"181",
"sell":
"181"
},
"PEN":
{
"buy":
"4.21",
"sell":
"4.21"
},
"EUR":
{
"buy":
"0.903697",
"sell":
"0.903697"
},
"SOL":
{
"buy":
"4.21",
&"sell":
"4.21"
},
"BTC":
{
"buy":
"49466.4026125",
"sell":
"48486.8698875"
},
"USDT":
{
"buy":
"1.0052213365",
"sell":
"0.9853159635"
},
"BRL":
{
"buy":
"34.6843",
"sell":
"34.6843"
},
"COP":
{
"buy":
"3965.13",
"sell":
"3965.13"
},
"MXN":
{
"buy":
"20.0999",
"sell":
"20.0999"
},
"LTC":
{
"buy":
"185.97303215",
"sell":
"182.29039785"
},
"XRP":
{
"buy": "1.275723728",
"sell":
"1.250461872"
},
"ETH":
{
"buy": "3289.723924",
"sell":
"3224.580876"
}
}
}
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"No Paremeters required"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"base_currency" : "USD",
"quotes" : {
"CLP" : {
"buy" : "865",
"sell" : "865"
},
"ARS" : {
"buy" : "212",
"sell" : "212"
},
"PEN" : {
"buy" : "4.1",
"sell" : "4.2"
},
"EUR" : {
"buy" : "0.903697",
"sell" : "0.903697"
},
"SOL" : {
"buy" : "4.1",
"sell" : "4.2"
},
"PAB" : {
"buy" : "1.00",
"sell" : "1.00"
},
"BTC" : {
"buy" : "58421.5840048",
"sell" : "57264.7209552"
},
"USDT" : {
"buy" : "1.019916382",
"sell" : "0.999820018"
},
"BRL" : {
"buy" : "33.6237",
"sell" : "33.6237"
},
"COP" : {
"buy" : "3935.15",
"sell" : "3935.15"
},
"MXN" : {
"buy" : "20.433098",
"sell" : "20.433098"
},
"LTC" : {
"buy" : "199.42854",
"sell" : "199.42854"
},
"XRP" : {
"buy" : "0.9863054",
"sell" : "0.9863054"
},
"ETH" : {
"buy" : "4373.26869",
"sell" : "4373.26869"
},
"CRC" : {
"buy" : "643.637398",
"sell" : "643.637398"
}
}
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
WebHook
El cliente debe poder manejar las desconexiones y también debe poder admitir nuevos tipos de mensajes originados por el lado del servidor sin ningún impacto.
Quikipay permite a nuestros clientes utilizar un webhook bien generado, su implementación es bastante sencilla.
“El parámetro callback_url” es la URL donde quikipay activó los datos del webhook en la solicitud del método POST.
Webhook facilita la integración con Quikipay al permitirle suscribirse a un conjunto de pedidos. Puede suscribirse al webhook enviando una devolución URL (donde desea obtener datos de webhook) en el parámetro "callback_url" de la API "Creación de pago" .
Webhook contiene parámetros de firma junto con otros, como se describe anteriormente, una firma es la combinación de su solicitud y su clave secreta, la firma se puede usar para la validación de la solicitud en el lado del comerciante. El comerciante debe recibir la solicitud del webhook, excluir la firma y luego crear la firma del parámetro restante, si creó la firma y el webhook. la firma coincide y luego devuelve el estado 200.
Note : El comerciante debe devolver el estado 200 si el webhook se recibió con éxito, es la forma de notificar al servidor de Quikipay que el comerciante recibió el webhook con éxito.
Respuestas
ESQUEMA DE RESPUESTA (application/json)
tx_id
Número
ID de depósito/ID de puerta de enlace
payment_method
Cuerda
Método, por ejemplo debit_credit
order_id
Número
identificador de pedido
currency_symbol
Cuerda
símbolo de moneda del país
quantity
Número
cantidad total
deposit_at
Fecha
Fecha de depósito del pedido
status
Cuerda
Estado de su pedido, por ejemplo, COMPLETADO, PENDIENTE o RECHAZADO.
customer_email
Correo electrónico
Email del cliente.
customer_name
Cuerda
Nombre del cliente
fees
Cuerda
Tarifas deducidas en la moneda del pedido
paid_amount_usd
Cuerda
Monto pagado en USD
paid_amount
Cuerda
Monto pagado en la moneda del pedido
fx_rate
Cuerda
Tasa de cambio
signature
Cuerda
Firma
ESQUEMA DE RESPUESTA: (application/json)
error
Cuerda
Mensaje de error
message
Cuerda
Lista de errores.
Esquema del cuerpo de la solicitud
"callback_url" : "https://sandbox.quikipay.com/api/webhook-received",
}
Muestras de respuesta
Respuesta 200
{
"tx_id" : "5IWjLFfqFlWSMgDpMDk7y6RcG",
"payment_method" : "crypto",
"local_quantity" : "4,000.00",
"local_currency" : "BRL",
"local_paid_amount" : "4,000.00",
"local_fees" : "160.00",
"order_id" : "X-fDZgZdsddsXCddsXHsXsCAA",
"currency_symbol" : "BTC",
"quantity" : "0.02529157",
"fees" : "0.00101166",
"deposit_at" : "2022-09-01 11:13:06",
"status" : "COMPLETED",
"customer_email" : "kaleemjan786@gmail.com",
"paid_amount" : "0.02529157",
"paid_amount_usd" : "766.34",
"fx_rate" : "158155.44572341x BRL = 1 BTC",
"signature" : "7b2432f49cfa24490203fb731"
}
Respuestas de error 422
{
"code" : Error code,
"message" : "error message."
}
Retiro WebHook
El cliente debe poder manejar las desconexiones y también debe poder admitir nuevos tipos de mensajes originados por el lado del servidor sin ningún impacto.
Quikipay permite a nuestros clientes utilizar un webhook bien generado, su implementación es bastante sencilla.
“El parámetro callback_url” es la URL donde quikipay activó los datos del webhook en la solicitud del método POST.
Webhook facilita la integración con Quikipay al permitirle suscribirse a un conjunto de pedidos. Puede suscribirse al webhook enviando una devolución URL (donde desea obtener datos de webhook) en el parámetro "callback_url" de la API "Creación de pago" .
Webhook contiene parámetros de firma junto con otros, como se describe anteriormente, una firma es la combinación de su solicitud y su clave secreta, la firma se puede usar para la validación de la solicitud en el lado del comerciante. El comerciante debe recibir la solicitud del webhook, excluir la firma y luego crear la firma del parámetro restante, si creó la firma y el webhook. la firma coincide y luego devuelve el estado 200.
Note : El comerciante debe devolver el estado 200 si el webhook se recibió con éxito, es la forma de notificar al servidor de Quikipay que el comerciante recibió el webhook con éxito.
Pedido
Esquema del cuerpo de la solicitud
id
Número
id
withdrawal_id
Cuerda
Withdrawal ID
customer_name
Cuerda
Nombre del cliente
customer_email
Cuerda
Email del cliente
status
Cuerda
Status of Withdrawal
source
Cuerda
Source of Withdrawal
amount
Número
Withdrawal Amount
fees
Cuerda
Withdrawal Fee.
type
Cuerda
Withdrawal Type.
description
Cuerda
Withdrawal Description.
In Case Of Withdrawal Source local
country
Cuerda
Country.
bank_name
Cuerda
Bank Name.
account_type
Cuerda
Account Type.
bank_account_number
Cuerda
Bank Account Number.
account_title
Cuerda
Account Title.
email
Cuerda
Email.
In Case Of Withdrawal Source internationl
bank_name
Cuerda
Name of the Bank.
address
Cuerda
Address.
city
Cuerda
City.
country
Cuerda
Country.
iban
Cuerda
IBAN.
swift_code
Cuerda
Swift Code.
account_title
Cuerda
Account Title.
account_number
Cuerda
Account Number.
In Case Of Withdrawal Source crypto
auto
Número
0 or 1 (Crtypto amount transfer auto (1) and manual (0)).
c_type
Cuerda
Crypto withdrawal base on local or crypto currency.
crypto_currency
Cuerda
Crypto Currency.
quantity
Cuerda
Crypto Quantity.
crypto_address
Cuerda
Crypto Address.
tag
Cuerda
Crypto tag (Only required in case of XRP).
proof_signature
Cuerda
Transfer Hash.
signature
Cuerda
Firma
ESQUEMA DEL CUERPO SOLICITADO
{
"id" : 16509,
"withdrawal_id" : "32as1d32hg1x",
"customer_name" : "Test Customer",
"customer_email" : "test_customer@gmail.com",
"status" : "accepted",
"source" : "crypto",
"amount" : 150,
"currency" : "USD",
"fees" : "0",
"type" : "settelment",
"description" : "description",
// In Case source Local
"country" : "Chile",
"bank_name" : "Banco BBVA",
"account_type" : "Cuenta CORRIENTE",
"bank_account_number" : "gvhbjn",
"account_title" : "tyguhj",
"email" : "h@gmail.com"
// In Case source International
"bank_name" : "BANCO BBVA FRANCES",
"address" : "Lahore pakistan",
"city" : "Fortaleza",
"country" : "Afghanistan",
"iban" : "156dsads6",
"swift_code" : "F568-H&J5-G",
"account_title" : "tester",
"account_number" : "005100000201"
// In Case source Crypto
"auto" : 1,
"c_type" : "local",
"crypto_currency" : "USDT",
"quantity" : 150,
"crypto_address" : "afdsfasfxvczxcvzxcvzxcvasdfasfrgwergrvbxcbxcv234214",
"tag" : null,
"proof_signature" : null
"signature" : "7b2432f49cfa24490203fb731"
}
equilibrio
Para tener información sobre el monto disponible en su cuenta para solicitar una transferencia, es necesario conocer el valor exacto y cuáles son las transacciones. parte de esta cantidad. Este servicio se encarga de brindarte toda la información necesaria para realizar una solicitud de transferencia.
Por lo general, un comerciante realiza una llamada a este servicio (/balance-summary) antes de solicitar una transferencia (/transfer).
El saldo de la cuenta es el resultado de los pasos anteriores descontados las transferencias confirmadas.
Se aplican pasos y tarifas adicionales según las condiciones de negociación. Por favor, póngase en contacto con nosotros para dejarlo claro.
Recuperación del resumen del saldo de la cuenta
Devuelve el importe disponible en tu cuenta sin detalle de pagos y transferencias. La siguiente tabla muestra los campos específicos para esta operación:
Devuelve los dos tipos de importe:
- Balance total
- Saldo utilizable
Balance total
Es el saldo disponible en tu cuenta.
Saldo utilizable
Es el saldo utilizable que está disponible para su uso.
PARÁMETROS DE CABECERA
Api-Key
requerido
Cuerda
Api-Key
"bp2igV9ORor9U1BgJVD8xWwF0omsKvNQezSI"
Clave de API de comerciante para autorización
Respuestas
ESQUEMA DE RESPUESTA:(SALDO TOTAL) (application/json)
usd
Número
En formato USD
ars
Número
En formato ARS
sol
Número
En Formato ÚNICO
clp
Número
En formato CLP
btc
Número
En formato BTC
usdt
Número
En formato USDT
is_admin
Binario
Booleanos que representan verdadero o falso
is_merchant
Binario
Booleanos que representan verdadero o falso
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Número
Mensaje de error
Esquema del cuerpo de la solicitud
{
"No Paremeters required"
}
Muestras de respuesta
Respuesta 200
{
"success": true,
"data": {
"total_balance": {
"mxn": 0,
"crc": 0,
"gtq": 0,
"cop": 0,
"usd": 0,
"ars": 0,
"sol": 0,
"pab": 0,
"clp": 0,
"vef": 0,
"brl": 0,
"btc": 0,
"ltc": 0,
"xrp": 0,
"eth": 0,
"usdt": 0,
"tusdt": 0,
"busdt": 0,
"bccoin": 0,
"usdc": 0
},
"usable_balance": {
"useable": {
"mxn": 0,
"crc": 0,
"gtq": 0,
"cop": 0,
"usd": 0,
"ars": 0,
"sol": 0,
"pab": 0,
"clp": 0,
"vef": 0,
"brl": 0,
"btc": 0,
"ltc": 0,
"xrp": 0,
"eth": 0,
"usdt": 0,
"tusdt": 0,
"busdt": 0,
"bccoin": 0,
"usdc": 0
},
"onhold": {
"clp": 0,
"vef": 0,
"ars": 0,
"brl": 0,
"crc": 0,
"gtq": 0,
"cop": 0,
"mxn": 0,
"sol": 0,
"pab": 0,
"usd": 0,
"btc": 0,
"eth": 0,
"tusdt": 0,
"busdt": 0,
"bccoin": 0,
"usdt": 0,
"usdc": 0,
"gleec": 0,
"ltc": 0,
"xrp": 0
},
"rolling": {
"clp": 0,
"vef": 0,
"ars": 0,
"brl": 0,
"crc": 0,
"gtq": 0,
"cop": 0,
"mxn": 0,
"sol": 0,
"pab": 0,
"usd": 0,
"btc": 0,
"eth": 0,
"tusdt": 0,
"busdt": 0,
"bccoin": 0,
"usdt": 0,
"usdc": 0,
"gleec": 0,
"ltc": 0,
"xrp": 0
}
}
}
}
Respuestas de error 422
{
"code" : Error code,
"message" : "error message."
}
Firma
La firma es la forma hash del cuerpo de su solicitud para garantizar que la solicitud se envíe y reciba en su estado original.
Para crear una firma, se deben seguir los siguientes pasos como se dijo.
- Convierta los valores de los parámetros de solicitud en una cadena y concatene en la secuencia a partir de la cual se crea/recibe.
- Agrega tu secreto al final de la cadena
- Aplique el cifrado hash ("sha256", $ you_previous_string) en esa cadena
Déjanos mostrarte un ejemplo
"John Doe"+
"Johndoe@gmail.com"+"BRL"+"50.025"+"15df568r8sdfsdfrg6"+
"www.test.com"+"www.test.com/success"+"106.243.345"+"C-01"+
"Tu clave secreta"
$signature = hash("sha256",$you_previous_Cuerda);
Para comprobar si su firma está preparada correctamente. Puedes crear uno usando la siguiente API.
Nota: Esta API solo tiene fines de verificación y está disponible únicamente en el entorno SANDBOX..
PARÁMETROS DE CABECERA
Api-Key
requerido
Cuerda
Api-Key
"bp2igV9ORor9U1BgJVD8xWwF0omsKvNQezSI"
Clave de API de comerciante para autorización
PARÁMETROS SOLICITADOS (application/json)
request body
requerido
Formación
[Parámetro común excepto los parámetros signature + specific gateway en forma de matriz]
Respuestas
ESQUEMA DE RESPUESTA:(SALDO TOTAL) (application/json)
signature
Cuerda
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Número
Mensaje de error
Esquema del cuerpo de la solicitud
{
"customer_name" : "John Doe",
"customer_email" : "Johndoe@gmail.com",
"currency_code" : "USD",
"success_url" : "https://sandbox.quikipay.com/",
"cancel_url" : "https://sandbox.quikipay.com/",
"callback_url" : "https://sandbox.quikipay.com/",
"end_user_ip" : "106.243.245.255",
"order_id" : "15df568r8sdfsdfrg6",
"amount" : "50.025",
Muestras de respuesta
Respuesta 200
{
"success" : "true",
"message" : "Signature created Successfully.",
"signature" : "7b2432f49cfa244900b2"
}
Respuestas de error 422
{
"code" : Error code,
"message" : "error message."
}
Estado Transacción
Quikipay le brinda la ventaja de cambiar el estado de su transacción haciendo clic en el botón
Si está utilizando nuestro entorno sandbox.
Puede cambiar el estado de su transacción de cuatro maneras diferentes.
Si selecciona "COMPLETED", el estado de su transacción se modificará de Pendiente a "COMPLETED".
Si selecciona "UNDERPAID", el estado de su transacción se modificará de Pendiente a "ONHOLD".
Si selecciona "REJECT", el estado de su transacción se modificará de Pendiente a "REJECT".
Si selecciona "OVERPAID", el estado de su transacción se modificará de Pendiente a "COMPLETED" y QuikPay creará una nueva transacción por el monto pagado en exceso.
Crypto Trading
A través del comercio de criptomonedas, puede cambiar su moneda criptográfica a las siguientes monedas criptográficas.
- LTC to BTC
- ETH to BTC
- LTC to ETH
- BTC to USDC
- LTC to USDC
- ETH to USDT
- BTC to USDT
- LTC to USDT
- ETH to USDC
- LTC to TUSDT
- BTC to TUSDT
- ETH to TUSDT
- USDC to USDT
- USDT to USDC
- USDC to TUSDT
- TUSDT to USDC
Los siguientes son los parámetros requeridos para Crypto Trade..
PARÁMETROS DE CABECERA
Api-Key
requerido
Cuerda
"bp2igV9ORor9U1BgJVD8xWwF0omdKvNQezSI"
Clave de API de comerciante para autorización
x-locale
opcional
Cuerda
"en"
Localización de respuestas api, en para inglés y es para español.
PARÁMETROS SOLICITADOS (application/json)
end_user_ip
requerido
Cuerda
Dirección IP del usuario final, asegúrese de que la IP debe ser del usuario final y no una IP del servidor
from_currency
requerido
Cuerda
Moneda criptográfica desde la que desea comerciar
to_currency
requerido
Cuerda
Criptomoneda con la que desea operar
amount
requerido
Cuerda
La cantidad que desea intercambiar.
signature
requerido
Cuerda
La firma es "Hash" del cuerpo de su solicitud Como crear firma
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
50 USDC a USDT negociados con éxito.
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"end_user_ip" : "103.153.15.63",
"from_currency" : "USDC",
"to_currency" : "USDT",
"amount" : 50,
"signature" : "a59b2cc28a46f45fc3797c2e0d925c4b476"
}
Muestras de respuesta
Respuesta 200
{
"success": true,
"message": "50 USDC to USDT traded successfully"
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Solicitud de Retiro
La solicitud de retiro se puede realizar de tres maneras diferentes que se enumeran a continuación. Se requieren parámetros comunes + parámetros específicos para completar la solicitud.
- Internacional
- Local
- Crypto
Parámetros comunes
La siguiente tabla muestra los parámetros comúnmente requeridos para procesar todos los retiros a través del Banco Local, Banco Internacional, Criptomoneda, etc.
PARÁMETROS DE CABECERA
Api-Key
requerido
Cuerda
Api-Key
"bp2igV9ORor9U1BgJVD8xWwF0omsKvNQezSI"
Clave de API de comerciante para autorización
PARÁMETROS SOLICITADOS (application/json)
type
requerido
Cuerda
Tipo de solicitud, p. liquidación o pago
source
requerido
Cuerda
Fuente de pago, p. local_bank, international_bank or crypto
currency
requerido
Cadena (código de 3 dígitos)
Código de moneda del país
amount
requerido
Número
La cantidad que desea recibir.
end_user_ip
requerido
Cuerda
Dirección IP del usuario final, asegúrese de que la IP sea del usuario final y no de un servidor
signature
requerido
Cuerda
La firma es "Hash" del cuerpo de su solicitud Como crear firma
Esquema del cuerpo de la solicitud
{
"end_user_ip" : "103.153.15.63",
"source" : "crypto",
"type" : "payout",
"currency" : "CLP",
"amount" : 50000,
"signature" : "a59b2cc28a46f45fc3797c2e0d925c4b476"
}
Internacional (Retiro)
A través de Retiro Internacional puedes retirar tu dinero disponible en tu cuenta a nivel internacional.
Los siguientes son los parámetros requeridos para el retiro internacional + parámetros comunes como se menciona en .
PARÁMETROS SOLICITADOS (application/json)
customer_name
opcional
Cuerda
Nombre del cliente
customer_email
opcional
Cuerda
Email del cliente
withdrawal_id
opcional
Cuerda
Se sugiere enviar una identificación única aquí para identificar el retiro.
callback_url
opcional
Cuerda
URL de notificación para webhook sobre cambio de estado. Más información
country
requerido
Cuerda
País Nombre de ese banco local
bank_name
requerido
Cuerda
nombre del banco
address
requerido
Cuerda
Dirección del banco
bank_account_number
requerido
Cuerda
Número de cuenta
account_title
requerido
Cuerda
Título de la cuenta bancaria
city
requerido
Cuerda
Ciudad bancaria
iban
requerido
Cuerda
IBAN Número
swift_code
requerido
Cuerda
Código Swift de Banco
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
500 USD se retiran a withdrawal de crypo de BTC con direccion 0x763b2f9fe2cadc3a1b5b76197619.
JSON
Cuerda
Detalles de la transacción
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"end_user_ip" : "103.153.15.63",
"source" : "international_bank",
"type" : "settlement",
"currency" : "CLP",
"amount" : 5000,
"country" : "USA",
"bank_name" : "BANCO BBVA FRANCES",
"account_number" : "005100000201",
"account_title" : "tester",
"address" : "New York USA",
"city" : "New York",
"iban" : "156dsads6",
"swift_code" : "F568-H&J5-G",
"signature" : "7b2432f49cfa24490203fb731"
}
Muestras de respuesta
Respuesta 200
{
"success": true,
"message": "5000.00 CLP is requested for withdrawal
from the local bank Banco BBVA with
account number 23135435464354 of the
account type CURRENT Account"
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Local (Retiro)
A través de Retiro local, puede retirar su dinero disponible en su cuenta en los siguientes países.
- Chile
- Panamá
- Perú
- Venezuela
- Argentina
Los siguientes son los parámetros requeridos para el retiro local + parámetros comunes como se menciona en .
PARÁMETROS SOLICITADOS (application/json)
customer_name
opcional
Cuerda
Nombre del cliente
customer_email
opcional
Cuerda
Email del cliente
withdrawal_id
opcional
Cuerda
Se sugiere enviar una identificación única aquí para identificar el retiro.
callback_url
opcional
Cuerda
URL de notificación para webhook sobre cambio de estado. Más información
country
requerido
Cuerda
País Nombre de ese banco local
bank_name
requerido
Cuerda
Nombre del banco (Debe pertenecer al país seleccionado)
account_type
requerido
Cuerda
Tipo de cuenta, p. Cuenta corriente, cuenta de ahorro, etc.
bank_account_number
requerido
Cuerda
Número de cuenta
account_title
requerido
Cuerda
Título de la cuenta bancaria
contact
requerido
Cuerda
Número de contacto
email
requerido
Cuerda
Dirección de correo electrónico
Responses
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
500 USD se retiran a withdrawal de crypo de BTC con direccion 0x763b2f9fe2cadc3a1b5b76197619.
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"end_user_ip" : "103.153.15.63",
"source" : "local_bank",
"type" : "settlement",
"currency" : "CLP",
"amount" : "5000.00",
"country" : "Chile",
"bank_name" : "Banco BBVA",
"account_type" : "Cuenta CORRIENTE",
"bank_account_number" : "23135435464354",
"account_title" : "John Doe",
"contact" : "573216521368",
"email" : "johndoe@gmail.com",
"signature" : "7b2432f49cfa24490203fb731"
}
Muestras de respuesta
Respuesta 200
{
"success": true,
"message": "5000.00 CLP is requested for withdrawal
from the local bank Banco BBVA with
account number 23135435464354 of the
account type CURRENT Account"
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Cripto (Retiro)
Puede retirar su moneda local a las siguientes monedas criptográficas en la dirección criptográfica almacenada en su dirección criptográfica en el tablero.
- BTC
- USDT
- TUSDT
- BUSDT
- BCCOIN
- USDC
- LTC
- ETH
Los siguientes son los parámetros requeridos para el retiro de Crypto + parámetros comunes como se menciona en .
PARÁMETROS SOLICITADOS (application/json)
crypto_currency
requerido
Cuerda
Código de moneda criptográfica, p. BTC, USDT, LTC, ETH
tag
opcional
Cuerda
Obligatoria en caso de XRP más opcional
crypto_address
requerido
Cuerda
dirección criptográfica del receptor, debe ser validado o incluido en la lista blanca
customer_name
opcional
Cuerda
Nombre del cliente
customer_email
opcional
Cuerda
Email del cliente
withdrawal_id
opcional
Cuerda
Se sugiere enviar una identificación única aquí para identificar el retiro.
callback_url
opcional
Cuerda
URL de notificación para webhook sobre cambio de estado. Más información
description
opcional
Cuerda
Tu descripción
meta_data
opcional
Cuerda
Puede enviar datos para su referencia..
auto
requerido
Número
Esto permanecería estáticamente 0.
NOTA: Para aceptar automáticamente la solicitud de retiro, debe estar habilitada por el administrador
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
500 USD se retiran a withdrawal de crypo de BTC con direccion 0x763b2f9fe2cadc3a1b5b76197619.
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"end_user_ip" : "103.153.15.63",
"source" : "crypto",
"type" : "settlement",
"currency" : "USD",
"amount" : 500,
"auto" : 0,
"crypto_currency" : "BTC",
"tag" : "asdjaskjd",
"crypto_address" : "0x763b2f9fe2cadc3a1b5b76197619",
"customer_name" : "Test Customer",
"withdrawal_id" : "1x-45sdd6565-4",
"customer_email" : "test_customer@gmail.com",
"description" : "description",
"meta_data" : "{\"tex_type\":\"csrd_load\"}",
"signature" : "7b2432f49cfa24490203fb731"
}
Muestras de respuesta
Respuesta 200
{
"success": true,
"message": "5000.00 CLP is requested for withdrawal
from the local bank Banco BBVA with
account number 23135435464354 of the
account type CURRENT Account"
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Cripto a cripto (retiro)
You can withdrawal your crypto amounts based on USD or following crypto currencies.
- BTC
- USDT
- USDC
- TUSDT
- BUSDT
- BCCOIN
- XRP
- LTC
- ETH
Los siguientes son los parámetros requeridos para el retiro de Crypto a Crypto.
PARÁMETROS SOLICITADOS (application/json)
crypto_currency
requerido
Cuerda
Código de moneda criptográfica, p. BTC, USDT, LTC, ETH
is_local
requerido
Cuerda
Será '1' si desea enviar USD, de lo contrario será '0' si desea criptografía a criptografía
tag
opcional
Cuerda
Obligatoria en caso de XRP más opcional
crypto_address
requerido
Cuerda
dirección criptográfica del receptor, debe ser validado o incluido en la lista blanca
customer_name
opcional
Cuerda
Nombre del cliente
customer_email
opcional
Cuerda
Email del cliente
withdrawal_id
opcional
Cuerda
Se sugiere enviar una identificación única aquí para identificar el retiro.
callback_url
opcional
Cuerda
URL de notificación para webhook sobre cambio de estado. Más información
sub_wallet_id
opcional
Cuerda
UUID de subbilletera. Solo es necesario cuando el comerciante tiene permiso para crear subcarteras y el comerciante desea realizar retiros de la subcartera.
description
opcional
Cuerda
Tu descripción
meta_data
opcional
Cuerda
Puede enviar datos para su referencia..
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
500 USD se retiran a withdrawal de crypo de BTC con direccion 0x763b2f9fe2cadc3a1b5b76197619.
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
ESQUEMA DE RESPUESTA: (application/json)
code
Número
Código de error
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"end_user_ip" : "103.153.15.63",
"source" : "crypto",
"type" : "settlement",
"is_local" : 1,
"currency" : "USD",
"amount" : 500,
"crypto_currency" : "BTC",
"tag" : "asdjaskjd",
"crypto_address" : "0x763b2f9fe2cadc3a1b5b76197619",
"customer_name" : "Test Customer",
"withdrawal_id" : "1x-45sdd6565-4",
"customer_email" : "test_customer@gmail.com",
"description" : "description",
"meta_data" : "{\"tex_type\":\"csrd_load\"}",
"signature" : "7b2432f49cfa24490203fb731"
}
Muestras de respuesta
Respuesta 200
{
"success": true,
"message": "500 USD se retiran a withdrawal de
crypo de BTC con direccion 0x763b2f9fe2cadc3a1b5b76197619"
}
Respuestas de error 400,401,403,404,422,500
{
"code" : Error code,
"message" : "error message."
}
Crear subbilletera
Merchants can generate new sub wallets for the following currencies.
- BTC
- USDT
- USDC
- TUSDT
- BUSDT
- BCCOIN
- XRP
- LTC
- ETH
PARÁMETROS SOLICITADOS (application/json)
currency_symbols
requerido
Array
Código de moneda criptográfica, p. BTC, USDT, LTC, ETH
sub_user_id
requerido
Cuerda
ID de subusuario
signature
requerido
Cuerda
La firma es "Hash" del cuerpo de su solicitud Como crear firma
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Subbilletera creada con éxito.
Dirección
Object
Data
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"currency_symbols" : ["TUSDT"],
"sub_user_id" : "98y89h8y",
"signature" : "{{signature}}"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"type" : "success",
"message" : "Sub Wallet Created Successfully",
"address" : [
{
"uuid" : "9b192b24-1d24-433a-bcec-f2274af877f7",
"currency_symbol" : "TUSDT",
"address" : "tusdte08S7lWTDTgEWGgzH16H8Lv",
"tag" : null,
"chain" : "TRC20",
"created_at" : "2024-01-15T13:06:42.000000Z",
"updated_at" : "2024-01-15T13:06:42.000000Z"
}
]
}
Respuestas de error 422
{
"code" : Error code,
"message" : "error message."
}
Obtener subbilletera
The merchant can retrieve a list of sub wallets they have already generated.
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Subbilletera recuperada exitosamente.
data
Object
Data
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"uuid" : "9b1d015d-c5ee-4714-8779-22ad93oi34",
"sub_user_id" : "98y89h8y"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"message" : "Sub Wallet fetched successfully",
"type" : "success",
"data" : [
{
"uuid" : "9b193426-c2ad-474c-bce5-a342af79b494",
"currency_symbol" : "LTC",
"address" : "ltc1fV10gpLNYsPcp2ylpaYrO",
"tag" : null,
"chain" : "Litecoin",
"balance" : 0.00
},
{
"uuid" : "9b192b24-685d-4509-9064-4d4c570c22ff",
"currency_symbol" : "BTC",
"address" : "btcqtcnvtcXlrqTuYxJG8MaYp",
"tag" : null,
"chain" : "Bitcoin",
"balance" : 0.023598
},
{
"uuid" : "9b192b24-1d24-433a-bcec-f2274af877f7",
"currency_symbol" : "TUSDT",
"address" : "tusdte8S7lWTDTgEWGgzH16H8Lv",
"tag" : null,
"chain" : "TRC20",
"balance" : 5.2359
}
]
}
Respuestas de error 422
{
"code" : Error code,
"message" : "error message."
}
Create User
El comerciante puede crear nuevos usuarios si Quikipay lo permite.
PARÁMETROS SOLICITADOS (application/json)
name
requerido
Cuerda
Nombre de usuario
email
requerido
Cuerda
Correo electrónico del usuario
password
requerido
Cuerda
Contraseña de usuario
password_confirmation
requerido
Cuerda
confirmar Contraseña
company_name
requerido
Cuerda
Nombre de la empresa usuaria
contact
requerido
Number
Número de contacto del usuario
address
requerido
Cuerda
Dirección de usuario
signature
requerido
Cuerda
La firma es "Hash" del cuerpo de su solicitud Como crear firma
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Usuario creada con éxito.
Dirección
Object
Data
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"name" : "new user 558",
"email" : "lms78s@gmail.com",
"password" : "asdf1234",
"password_confirmation" : "asdf1234",
"company_name" : "ch_adm",
"contact" : "031524879685",
"address" : "ch_adm",
"signature" : "{{signature}}"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"message" : "User created sucessfully",
"data" : {
"id" : 170,
"name" : "new user 558",
"email" : "lmss78s@gmail.com",
"password" : "TeuF3CqwgAQP9ivu",
"merchant_key" : "g7oUpccyGTHVeV2N3TjReQoA1hxfhWXoL2EvsDzQ",
"secret_key" : "7W9ZcG6isbnoApFFhETSEtMJ5"
}
}
Respuestas de error 422
{
"code" : Error code,
"message" : "error message."
}
Get Users
El comerciante puede recuperar una lista de usuarios que ha creado.
PARÁMETROS SOLICITADOS (application/json)
merchant_id
opcional
Cuerda
Identificación del comerciante
secret
opcional
Cuerda
Secreto de usuario
name
opcional
Cuerda
Nombre de usuario
id
opcional
Cuerda
Identificación de usuario
email
opcional
Cuerda
Email usuario
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Usuario recuperado exitosamente.
data
Object
Data
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"merchant_id" : 167,
"secret" : "Vt9FMSOnQ3BracecfSiq7J1n6",
"name" : "new user",
"id" : 170,
"email" : "lmss78s@gmail.com"
}
Muestras de respuesta
Respuesta 200
{
"success": true,
"message": "Users fetched successfully",
"data": {
"current_page": 1,
"data": [
{
"id" : 170,
"kyc" : 0,
"name" : "new user 558",
"email" : "lmss78s@gmail.com",
"secret" : "7W9ZcG6isbnoApFFhETSEtMJ5",
"merchant_id" : "g7oUpccyGTHVeV2N3TjReQoA1hxfhWXoL2EvsDzQ",
"wallet" : {
"id" : 154,
"user_id" : 170,
"usd" : 0,
"ars" : 0,
"clp" : 0,
"vef" : 0,
"sol" : 0,
"pab" : 0,
"btc" : 500,
"usdt" : 4000000,
"tusdt" : 6000000,
"busdt" : 80000,
"usdc" : 5000000,
"ltc" : 7000000,
"xrp" : 50000,
"eth" : 5000,
"lth" : 0,
"mxn" : 0,
"cop" : 0,
"brl" : 0,
"crc" : 0,
"gtq" : 0,
"created_at": "2024-03-06T07:00:35.000000Z",
"updated_at": "2024-03-06T07:00:35.000000Z"
}
}
],
"first_page_url": "http://localhost/quikipay-dev/public/api/v1.1/user/get?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost/quikipay-dev/public/api/v1.1/user/get?page=1",
"links": [
{
"url": null,
"label": "« Previa",
"active": false
},
{
"url": "http://localhost/quikipay-dev/public/api/v1.1/user/get?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Próxima »",
"active": false
}
],
"next_page_url": null,
"path": "http://localhost/quikipay-dev/public/api/v1.1/user/get",
"per_page": 10,
"prev_page_url": null,
"to": 1,
"total": 1
}
}
Respuestas de error 422
{
"code" : Error code,
"message" : "error message."
}
Get User Wallet
El comerciante puede recuperar una lista de billeteras de usuarios.
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Cartera recuperada correctamente.
data
Object
Data
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"No Paremeters required"
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"message" : "Wallet fetched successfully",
"data" : {
"id" : 150,
"user_id" : 166,
"usd" : 0,
"ars" : 0,
"clp" : 0,
"vef" : 0,
"sol" : 0,
"pab" : 0,
"btc" : 0,
"usdt" : 0,
"tusdt" : 0,
"busdt" : 0,
"bccoin" : 0,
"usdc" : 0,
"ltc" : 0,
"xrp" : 0,
"eth" : 0,
"lth" : 0,
"mxn" : 0,
"cop" : 0,
"brl" : 0,
"crc" : 0,
"gtq" : 0,
"created_at": "2024-03-05T07:13:29.000000Z",
"updated_at": "2024-03-05T07:13:29.000000Z",
"usds" : {
"usd" : "0.000",
"ars" : "0.000",
"clp" : "0.000",
"vef" : "0.000",
"sol" : "0.000",
"pab" : "0.000",
"btc" : "0.000",
"usdt" : "0.000",
"tusdt" : "0.000",
"busdt" : "0.000",
"bccoin": "0.000",
"usdc" : "0.000",
"ltc" : "0.000",
"xrp" : "0.000",
"eth" : "0.000",
"mxn" : "0.000",
"cop" : "0.000",
"brl" : "0.000",
"crc" : "0.000",
"gtq" : "0.000"
}
},
"trade" : false
}
Respuestas de error 422
{
"code" : Error code,
"message" : "error message."
}
Get Transaction
El comerciante puede recuperar una lista de transacciones que ya ha creado.
PARÁMETROS SOLICITADOS (application/json)
id
opcional
Cuerda
ID de Transacción
user_id
opcional
Cuerda
Identificación de usuario
deposit_id
opcional
Cuerda
ID de transacción / depósito
pay_amount
opcional
Cuerda
Monto del pago
pay_currency
opcional
Cuerda
Moneda de pago
currency_symbol
opcional
Cuerda
Símbolo de moneda
quantity
opcional
Cuerda
Cantidad
paid_amount
opcional
Cuerda
Monto de pago
status
opcional
Cuerda
Estado
customer_name
opcional
Cuerda
Nombre del cliente
customer_email
opcional
Cuerda
Correo electrónico del cliente
crypto_address
opcional
Cuerda
Dirección de cifrado
code
opcional
Cuerda
Código de moneda criptográfica.
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Transacciones recuperadas exitosamente.
data
Object
Data
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"id" : 20693,
"user_id" : "169",
"deposit_id" : "bs1fa567546a357sebd99dde1scecs564dcffb527efb5",
"pay_amount" : 500,
"pay_currency" : "USD"
"currency_symbol" : "USDT"
"quantity" : 0.01169133
"paid_amount" : 0.01169133
"status" : "COMPLETED"
"customer_name" : "test customer"
"customer_email" : "test@gmail.com"
"code" : "C-01"
"crypto_address" : "0xusdtjoUFW1LRfZRFDvEsI42TNk97O2fSG0FRMtykcXx"
}
Muestras de respuesta
Respuesta 200
{
"success": true,
"message": "Transactions fetched successfully",
"data": {
"current_page": 1,
"data": [
{
"id" : 32115,
"user_id" : 603,
"deposit_id" : "v3iGAFnoBF6HKemdw3r0ZaiJW",
"pay_amount" : 1500,
"pay_currency" : "USD",
"currency_symbol" : "USDT",
"quantity" : 1500,
"paid_amount" : 0,
"status" : "PENDING",
"code" : "C-01",
"customer_name" : "test customer",
"customer_email" : "htx_user@gmail.com",
"rejected_reason" : null,
"data" : "{\"tag\": null, \"chain\": \"ERC20\", \"amount\": \"1500.00\", \"expiry\": \"45 Minutos a partir de ahora.\",
\"address\": \"0xusdtjoUFW1LRfZRFDvEsI42TNk97O2fSG0FRMtykcXx\", \"qr_code\": \"<img class="img-float font" height="auto" width="200"
src="https://chart.googleapis.com/chart?chs=300x300&cht=qr&chl=usdt:0xusdtjoUFW1LRfZRFDvEsI42TNk97O2fSG0FRMtykcXx?amount=1500.00&choe=UTF-8/>\",
\"currency_symbol\": \"USDT\"}"
}
],
"first_page_url": "http://localhost/quikipay-dev/public/api/v1.1/transactions/index?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost/quikipay-dev/public/api/v1.1/transactions/index?page=1",
"links": [
{
"url": null,
"label": "« Previa",
"active": false
},
{
"url": "http://localhost/quikipay-dev/public/api/v1.1/transactions/index?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Próxima »",
"active": false
}
],
"next_page_url": null,
"path": "http://localhost/quikipay-dev/public/api/v1.1/transactions/index",
"per_page": 10,
"prev_page_url": null,
"to": 1,
"total": 1
}
Respuestas de error 422
{
"code" : Error code,
"message" : "error message."
}
Agregar billetera de pagos criptográficos
Para las siguientes monedas, el comerciante puede agregar billeteras criptográficas a sus billeteras externas de quikipay que ya están incluidas en la lista blanca en la zona de pruebas, pero en producción están incluidas en la lista blanca por parte del administrador.
- BTC
- USDT
- USDC
- TUSDT
- BUSDT
- BCCOIN
- XRP
- LTC
- ETH
PARÁMETROS SOLICITADOS (application/json)
name
requerido
String
Nombre de la billetera criptográfica
crypto_currency
requerido
String
Código de moneda criptográfica, p. BTC, USDT, LTC, ETH
crypto_address
requerido
Cuerda
Dirección criptográfica
crypto_tag
opcional
Cuerda
Etiqueta criptográfica (XRP)
signature
requerido
Cuerda
La firma es "Hash" del cuerpo de su solicitud Como crear firma
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Dirección de lista blanca creada correctamente.
Dirección
Object
Data
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"name" : "XRP new address",
"crypto_currency" : "XRP",
"crypto_address" : "xrptesdfg9awq608S7lWTDTgE3WGgzH16H8Lvw",
"crypto_tag" : "1213218",
"signature" : "{{signature}}"
}
Muestras de respuesta
Respuesta 200
{
"success": true,
"type": "success",
"message": "White List Address Added successfully.",
"data": {
"name": "XRP new address",
"currency_symbol": "XRP",
"address": "xrptesdfg9awq608S7lWTDTgE3WGgzH16H8Lvw",
"tag": "1213218",
"updated_at": "2024-02-02T10:39:59.000000Z",
"created_at": "2024-02-02T10:39:59.000000Z"
}
}
Respuestas de error 422
{
"code" : Error code,
"message" : "error message."
}
Obtenga una billetera de pagos criptográficos
El comerciante puede recuperar una lista de billeteras de pagos criptográficos que ya han agregado en las billeteras externas de quikipay.
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
data
Object
Data
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"No Paremeters required"
}
Muestras de respuesta
Respuesta 200
{
"success": true,
"addresses": [
{
"id" : 42,
"name" : null,
"currency_symbol" : "BTC",
"address" : "ddfdsdaDFGHDSADAFFGDSFGDGDFGHDFGH",
"tag" : null,
"created_at" : "2022-07-21T08:09:39.000000Z",
"whitelist" : 0,
"description" : null
},
{
"id" : 48,
"name" : null,
"currency_symbol" : "USDT",
"address" : "assdfadfasdfad",
"tag" : null,
"created_at" : "2023-01-05T10:34:57.000000Z",
"whitelist" : 0,
"description" : null
}
]
}
Respuestas de error 422
{
"code" : Error code,
"message" : "error message."
}
Eliminar billetera de pagos criptográficos
El comerciante puede eliminar las billeteras de pagos criptográficos que ya haya agregado en las billeteras externas de quikipay.
PARÁMETROS SOLICITADOS (url)
id
requerido
String
id
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Dirección eliminada correctamente..
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"id" : 45
}
Muestras de respuesta
Respuesta 200
{
"success" : true,
"type" : "success",
"message" : "Address deleted successfully."
}
Respuestas de error 422
{
"code" : Error code,
"message" : "error message."
}
document-new.create_sub_wallet_transfer
Merchants can make sub wallet Transfer in the following currencies.
- BTC
- USDT
- USDC
- TUSDT
- BUSDT
- BCCOIN
- XRP
- LTC
- ETH
PARÁMETROS SOLICITADOS (application/json)
currency_symbol
requerido
Cuerda
Código de moneda criptográfica, p. BTC, USDT, LTC, ETH
amount
requerido
Número
La cantidad que desea transferir.
sub_wallets
requerido
Array
Sub Wallet details for transfer Limit is 70
signature
requerido
Cuerda
La firma es "Hash" del cuerpo de su solicitud Como crear firma
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Subbilletera creada con éxito.
Dirección
Object
Data
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"currency_symbol" : "ETH",
"sub_total" : "0.5",
"sub_wallets" : [
{
"amount" : "0.25",
"uuid" : "9b2717ac-da37-4a53-a592-7fd0ee56d2ea"
},
{
"amount" : "0.25",
"uuid" : "9b274ae1-413e-4e60-93da-c13a6abf9aa2"
}
],
"signature" : "{{signature}}"
}
Muestras de respuesta
Respuesta 200
{
"success": true,
"type": "success",
"message": "0.5 ETH transferred successfully to Sub Wallets",
"data": {
"chain": "ERC20",
"exchange": "HTX",
"transfer_id": "9b2f751b-37be-473b-8f4f-cf5abb7e5a8a",
"currency_symbol": "ETH",
"amount": "0.5",
"status": "COMPLETED",
"updated_at": "2024-01-26T15:01:44.000000Z",
"created_at": "2024-01-26T15:01:44.000000Z"
}
}
Respuestas de error 422
{
"code" : Error code,
"message" : "error message."
}
Obtenga transferencias de subbilletera
The merchant can retrieve a list of sub wallets transfers they have already generated.
Respuestas
ESQUEMA DE RESPUESTA (application/json)
success
Booleano (Verdadero o Falso)
Verdadero.
message
Cuerda
Subbilletera recuperada exitosamente.
data
Object
Data
ESQUEMA DE RESPUESTA: (application/json)
success
Booleano (Verdadero o Falso)
Falso
message
Cuerda
Mensaje de error
Esquema del cuerpo de la solicitud
{
"transfer_id" : "9b1d015d-c5ee-4714-8779-22ad93oi34",
}
Muestras de respuesta
Respuesta 200
{
"success": true,
"message": "Sub Wallet fetched successfully",
"type": "success",
"data": {
"current_page": 1,
"data": [
{
"transfer_id" : "9b2f751b-37be-473b-8f4f-cf5abb7e5a8a",
"currency_symbol" : "ETH",
"payload" : "{\"currency_symbol\":\"ETH\",\"sub_total\":\"0.5\",
\"sub_wallets\":[{\"amount\":\"0.25\",\"uuid\":\"9b2717ac-da37-4a53-a592-7fd0ee56d2ea\"},
{\"amount\":\"0.25\",\"uuid\":\"9b274ae1-413e-4e60-93da-c13a6abf9aa2\"}],
\"signature\":\"484526c7347380785491ce0f75d9eb41c8313bfbffd9b147716acdc6ddd93c2d\"}",
"amount": "0.5",
"status": "COMPLETED",
"created_at": "2024-01-26T15:01:44.000000Z"
},
{
"transfer_id" : "9b2f7502-e8a5-44bd-aad8-c826245b94a5",
"currency_symbol" : "ETH",
"payload" : "{\"currency_symbol\":\"ETH\",\"sub_total\":\"0.5\",
\"sub_wallets\":[{\"amount\":\"0.25\",\"uuid\":\"9b2717ac-da37-4a53-a592-7fd0ee56d2ea\"},
{\"amount\":\"0.25\",\"uuid\":\"9b274ae1-413e-4e60-93da-c13a6abf9aa2\"}],
\"signature\":\"484526c7347380785491ce0f75d9eb41c8313bfbffd9b147716acdc6ddd93c2d\"}",
"amount" : "0.5",
"status" : "COMPLETED",
"created_at" : "2024-01-26T15:01:28.000000Z"
},
{
"transfer_id" : "9b2f74da-b0c0-418c-8eac-c2ff432b1fc9",
"currency_symbol" : "ETH",
"payload" : "{\"currency_symbol\":\"ETH\",\"sub_total\":\"0.5\",
\"sub_wallets\":[{\"amount\":\"0.25\",\"uuid\":\"9b2717ac-da37-4a53-a592-7fd0ee56d2ea\"},
{\"amount\":\"0.25\",\"uuid\":\"9b274ae1-413e-4e60-93da-c13a6abf9aa2\"}],
\"signature\":\"484526c7347380785491ce0f75d9eb41c8313bfbffd9b147716acdc6ddd93c2d\"}",
"amount" : "0.5",
"status" : "COMPLETED",
"created_at" : "2024-01-26T15:01:02.000000Z"
},
{
"transfer_id" : "9b2f6a86-9f5e-4406-9273-43b9b3dd16a5",
"currency_symbol" : "ETH",
"payload" : "{\"currency_symbol\":\"ETH\",\"sub_total\":\"0.5\",
\"sub_wallets\":[{\"amount\":\"0.25\",\"uuid\":\"9b2717ac-da37-4a53-a592-7fd0ee56d2ea\"},
{\"amount\":\"0.25\",\"uuid\":\"9b274ae1-413e-4e60-93da-c13a6abf9aa2\"}],
\"signature\":\"484526c7347380785491ce0f75d9eb41c8313bfbffd9b147716acdc6ddd93c2d\"}",
"amount" : "0.5",
"status" : "COMPLETED",
"created_at" : "2024-01-26T14:32:09.000000Z"
}
],
"first_page_url": "http://localhost/quikipay-dev/public/api/v1.1/sub-wallet/transfers/index?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost/quikipay-dev/public/api/v1.1/sub-wallet/transfers/index?page=1",
"links": [
{
"url": null,
"label": "« Previa",
"active": false
},
{
"url": "http://localhost/quikipay-dev/public/api/v1.1/sub-wallet/transfers/index?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Próxima »",
"active": false
}
],
"next_page_url": null,
"path": "http://localhost/quikipay-dev/public/api/v1.1/sub-wallet/transfers/index",
"per_page": 10,
"prev_page_url": null,
"to": 4,
"total": 4
}
}
Respuestas de error 422
{
"code" : Error code,
"message" : "error message."
}
Integración con WordPress
Cómo empezar
1) El primer paso para instalar Woo Quikipay Payment es instalar el complemento Woocommerce, luego hacer clic en agregar nuevo complemento y cargar el archivo zip para Woo Quikipay Payment.
2) Active este complemento después de instalar Woo Quikipay Payment.
3) Después de activar el pago Woo Quikipay, vaya a la configuración de WooCommerce.
4) Asegúrese de que quikipay esté habilitado y guarde los cambios.
5) Haga clic en Quikipay y configure su clave API.