Registrar operación

Registrar Operación

POST https://api.payvalida.com/cashout/v1/operation

URL Sandbox: https://api-test.payvalida.com/cashout/v1/operation Registra una operación de cashout que permite la entrega de dinero al solicitante

Request Body

Name	Type	Description
merchant*	string	Identificación del comercio que realiza la operación, (30 caracteres).
checksum*	string	SHA512(merchant+operation+amount+currency+ document+FIXED_HASH) (512 caracteres).
operation*	string	Identificador de la operación generada por el comercio. Debe ser identificador único, (40 caracteres).
amount*	number	Valor de la operación, (20 caracteres) *En Perú solo debe contener un digito decimal.
currency*	string	Código ISO de la divisa de la operación, (3 caracteres)
description*	string	Descripción de la operación, (50 caracteres)
document*	string	Número del documento de identidad del usuario final que realiza la operación, (20 caracteres)
otpLength	number	Longitud de la clave OTP (default 4, 4 <= otpLength <=12) (entre 4 a 12 caracteres)
expire	string	Fecha de expiración de la operación (YYYY-MM-DD) default 30 días, (8 caracteres).
transactionCost	number	Monto que el comercio cobrará al cliente por la operación (default 0) (10 caracteres).
beneficiaryName	String	Nombre de la persona que recibirá el dinero *Obligatorio para retiros en Guatemala y Perú.
beneficiaryLastName	String	Apellido de la persona que recibirá el dinero *Obligatorio para retiros en Peru.
beneficiaryDocumentType	String	Tipo de documento en Perú (DNI,RUC,CE) *Obligatorio para retiros en Perú.
email	String	Email de usuario. *Obligatorio para retiros en Perú.
cellphone	String	Numero de celular de usuario. *Obligatorio para retiros en Perú.

200 Retorna un json con esta estructura

{  
   "code":"0000",
   “text”:”OK”,
   "data":{  
      "amount":"150000.0",
      “transactionCost”:”2000.0”,
      "currency":"COP”,
      "description":"Retiro de intereses al 15092019",
      "document":"1001007878",
      "otp":"*********",
      “operation”:”1452782”,
      “expire”:”2019-12-31”
      “payvalidaCode”:1234567890,
      “balance”:900234900,
   }
}

Ejemplo Request Perú

{
    "merchant": "kuanto_pe",
    "beneficiaryName": "jhon",
    "beneficiaryLastName": "doe",
    "beneficiaryDocumentType": "RUC",
    "operation": "test-globokas-105",
    "amount": 13.3,
    "currency": "PEN",
    "description": "description test globokas 105",
    "document": "48764951234",
    "cellphone": "987654321",
    "email": "[e-mail]",
    "expire": "2024-04-28",
    "checksum": "2ad8a93af77184a42c735143db57fb443eaa2656d29e88d293e9448c75142b5442d91aed293c42ca6aa241ad65c1fd293ca1cb38c344c0f6e89580be07be4d5d"
}

Información de la respuesta

code: indica el código del resultado, “0000” indica resultado sin error, otro valor indica el código del error

text: contiene el mensaje referente al code enviado.

data: contiene los datos de la transacción (para resultados sin error)

• amount: valor de la transacción

• transactionCost: indica el costo que asume el usuario por realizar la transacción

• currency: moneda en la que está registrada la operación de cashout

• description: descripción de la operación

• document: número de documento de identidad

• otp: OTP generada para la operación (si se indica true, en el parámetro SMS, este valor no se proporciona)

• operation: identificador de la operación, generado por el comercio

• expire: fecha de expiración de la operación

• payvalidaCode: identificador de la operación en Payvalida

• balance: monto disponible en la bolsa

NOTA: el parámetro CURRENCY solo admite moneda local (correspondiente al país de registro del comercio). Si se recibe un currency diferente retornara un error.

Toda operación registrada, queda en estado PENDIENTE.

El campo "expire" indica la fecha en la cual no se podrán realizar los retiros, es decir que para esa fecha las Redes de Desembolso no entregarán el dinero.