API CashOut
API CashOut
API CashOut
API CashOut
Introducción
Consultar
Movimientos en bolsa
Operación única
Operaciones múltiples
Saldo en bolsa
Registrar
Registrar operación
Recarga bolsa
Eliminar
Eliminar operación
Mensajes de error
Excepciones
Notificación
Notificación
Accionado por GitBook

Operaciones múltiples

get
Consultar operaciones múltiples

https://api.payvalida.com/cashout/v1/operation/{merchant}
URL Sandbox: https://api-test.payvalida.com/cashout/v1/operation/{merchant} Permite obtener información de las operaciones de cashout, dando flexibilidad de filtrar por estado, documento y fecha de actualización.
Request
Response
Request
Path Parameters
merchant
required
string
Comercio que realiza la operación (30 caracteres)
Query Parameters
checksum
required
string
Cadena de comprobación SHA512(merchant+start+end+FIXED_HASH)(512 caracteres)
status
optional
string
Estado de la transacción (default = 0)(12 caracteres)
document
optional
number
Filtrado por documento (default TODOS) (20 caracteres)
start
required
number
Fecha inicial de búsqueda (formato YYYY-MM-DD, default HOY) (8 caracteres)
end
required
number
Fecha final de búsqueda (formato YYYY-MM-DD, default HOY) (8 caracteres)
page
optional
number
Número de la página (default >0) (4 caracteres)
limit
optional
number
Cantidad de registros de respuesta (default 23, 10 <= limit <=100) (4 caracteres)
Response
200: OK
Retorna un json con la respuesta
{
  "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",
},
{
      "amount": "35000.0",
      "transactionCost": "1500.0",
      "currency": "COP",
      "description": "Retiro dividendos",
      "document": "5488352",
      "sms": "false",
      "cellphone": "3015555555",
      "operation": "BFT409",
      "expire": "01122019",
      "update": "01122019",
      "status": "PENDIENTE",
    }
  ]
}

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.

first: contiene la información para obtener los registros de la primera página

previous: contiene la información para obtener los registros de la página anterior

next: contiene la información para obtener los registros de la página siguiente

end: contiene la información para obtener los registros de la última página

data: contiene una arreglo con los datos de las transacciones (vacío si hay error o si no hay datos en el rango de fecha indicado)

  • amount: monto 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

  • sms: indica si se solicitó envío el OTP por SMS al usuario final

  • cellphone: número de celular para envío de 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

Estados posibles

APROBADA: se procesó el cashout satisfactoriamente

VENCIDA: el cashout no fue procesado 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

Consultar - Anterior
Operación única
Próximo - Consultar
Saldo en bolsa
Última actualización 12 months ago