Registrar operación

post
Registrar Operación

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
Response
Request
Body Parameters
merchant
required
string
Identificación del comercio que realiza la operación, (30 caracteres).
checksum
required
string
SHA512(merchant+operation+amount+currency+ document+FIXED_HASH) (512 caracteres).
operation
required
string
Identificador de la operación generada por el comercio. Debe ser identificador único, (40 caracteres).
amount
required
number
Valor de la operación, (20 caracteres)
currency
required
string
Código ISO de la divisa de la operación, (3 caracteres)
description
required
string
Descripción de la operación, (50 caracteres)
document
required
string
Número del documento de identidad del usuario final que realiza la operación, (20 caracteres)
otpLength
optional
number
Longitud de la clave OTP (default 4, 4 <= otpLength <=12) (entre 4 a 12 caracteres)
expire
optional
string
Fecha de expiración de la operación (YYYY-MM-DD) default 30 días, (8 caracteres).
transactionCost
optional
number
Monto que el comercio cobrará al cliente por la operación (default 0) (10 caracteres).
Response
200: OK
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,
}
}

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 admite sólo los valores USD y moneda local (correspondiente al país de registro del comercio). Si se recibe USD, el sistema hará la conversión a la moneda local.

Toda operación registrada, queda en estado PENDIENTE.