Recarga bolsa

Este API permite a los comercios solicitar un URL para efectuar un pago que recargue su bolsa CashOut.

post
Recargar

https://api.payvalida.com/cashout/v1/rechargecashout
URL Sandbox: https://api-test.payvalida.com/cashout/v1/rechargecashout Este API registra una orden de pago y retorna el parámetro checkout, el cual indica la URL en la cual el comercio deberá completar el pago. Una vez el comercio realice el pago y este sea aprobado, llegará una notificación por correo electrónico indicando la recarga de la bolsa. El correo deberá ser enviado a Payvalida para su configuración.
Request
Response
Request
Body Parameters
merchant
required
string
Identificación de comercio Payvalida. Max 50 carecteres
email
required
string
Correo electrónico del pagador. Máx 100 caracteres
country
required
number
Código de país. Máx 3 caracteres. Actualmente solo está habilitado 343.
order
required
string
Identificación única del comercio para la orden generada. Máx 100 caracteres
money
required
string
Código ISO de la moneda de la orden. Máx 3 caracteres, actualmente solo está habilitado "COP"
amount
required
number
Monto de la orden. Solo acepta números enteros
description
required
string
Descripción de la orden. Máx 250 caracteres
language
optional
string
Lenguaje del mensaje. Máx 2 caracteres
checksum
required
string
Cadena de comprobación SHA512 (email+country+order+money+amount+FIXED_HASH)
user_di
required
string
Número de documento de identificación del pagador. Máx 15 caracteres
user_type_di
required
string
Tipo documento del comprador. Max 3 caracteres.
user_name
required
string
Nombre del comprador. Max 25 caracteres.
Response
200: OK
La ejecución retorna un JSON estructurado con los siguientes campos:
{
"CODE": "0000",
"DESC": "OK",
"DATA":{
"OrdenID":"comercioExterno_9892",
"Monto":"500000",
"PVordenID":"98555221",
"Referencia":"8766554",
"Operacion":"CREADA",
"checkout":"checkout.payvalida.com/?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJNRVJDSEFOVF9DRUwiOiIzMTc2ODI3MzQxIiwiT1JERVJfTUVUSE9EIjoiZWZlY3R5IiwiTUVSQ0hBTlRfQ09ERSI6MjU0LCJNRVJDSEFOVF9FTUFJTCI6ImhyZXN0cmVwb0BwYXl2YWxpZGEuY29tIiwiaXNzIjoiYXV0aDAiLCJNRVJDSEFOVF9MT0dPIjoiaHR0cHM6Ly9zMy5hbWF6b25hd3MuY29tL3ZhbGlkZGF3ZWIvZXZlbnRvcy9mZW5hbGNvYnJhLnBuZyIsIk1FUkNIQU5UX1VSTF9SRVRVUk4iOiJ3d3cucGludmFsaWRkYS5jb20uY28iLCJNRVJDSEFOVF9OQU1FIjoiSGVybmFuIFJwbyAoQ09MKSIsIk9SREVSX0JSSUVGIjoiVGVzdCBSRVNUZnVsbCBQdXJjaGFzZSBPcmRlciBQT1NUIiwiTUVSQ0hBTlRfVEVMIjoiMjg4MDUzOSIsIk9SREVSX0NVUlJFTkNZIjoiQ09QIiwiT1JERVJfQU1PVVQiOiIxMCwwMDAuMDAiLCJleHAiOjE1MzA0MDE1MzgsIk9SREVSX1JFRkVSRU5DRSI6IjQyMzEzIn0.QVsZwm-2BIkK-5RgrAX2NuwGqmHSNHD_zw91i1hcSc8”
}
}

Tener en cuenta que actualmente el país y la modena habilitado es Colombia (343) y Pesos ("COP") respectivamente.

El listado de excepciones de esta funcionalidad se encuentran en la documentación de Recaudos.

La identificación del comercio (merchant) y FIXED_HASH, es generada al momento de crear una cuenta en nuestra plataforma y se envía por correo electrónico.