Operación única

Consultar operación única

GET https:/api.payvalida.com/cashout/v1/operation/{merchant}/{operation}

URL Sandbox: https://api-test.payvalida.com/cashout/v1/operation/{merchant}/{operation} Permite obtener información de una operación de cashout, indicando los datos relevantes de la misma

Path Parameters

NameTypeDescription

merchant*

string

Comercio que realiza la operación (30 caracteres)

operation*

string

Identificador de la operación generada por el comercio (40 caracteres)

Query Parameters

NameTypeDescription

checksum*

string

Cadena de comprobación, calculada con SHA512(merchant + operation + document + FIXED_HASH) (512 caracteres)

document*

number

Número de documento de identidad o referencia asociada a la operación (20 caracteres)

aditional_info

string

Opcional para obtener información adicional según el valor enviado

{  
   "code":"0000",
   "text":"OK",
   "data":{
      "amount":"45000.0",
      "transactionCost":"2000.0",
      "currency":"COP",
      "description":"Retiro dividendos",
      "document":"986157352",
      "sms":"false",
      "cellphone":"3015555555",
      "operation":"15249",
      "expire":"01122019",
      "update":"01122019",
      "status":"APROBADA"
   }
}

code: es el código del resultado, "0000" indica resultado sin error, otro valor indica el código del error.

text: es el mensaje referente al código (code) enviado.

data: contiene los datos de la transacción (vacío si hay error).

  • amount: monto de la operación

  • transactionCost: es el costo que asume el usuario por realizar la operación.

  • currency: moneda de la operación.

  • description: descripción de la operación.

  • document: número de documento de identidad del usuario.

  • sms: si se solicita el envío del OTP por SMS al usuario final.

  • cellphone: número de celular para envío del OTP.

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

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

  • update: fecha de actualización de la operación.

  • status: estado de la operación.

  • additional_info: objeto con información adicional

Opciones para additional_info

  • DANE_CODE: Obtiene el código dane almacenado en la base de datos o código de localización dentro de dane_code

  • LOCATION_CODE: Obtiene el código de localización almacenado del campo location_code

Estados posibles

  • Aprobada: se procesó el cashout satisfactoriamente.

  • Vencida: el cashout no procesó antes de la fecha de expiración.

  • Cancelada: la operación fue cancelada por el comercio.

  • Anulada: la operación fue anulada por Payvalida.

  • Pendiente: la operación se encuentra a la espera de completar el cashout.

Last updated