Registrar

Permite registrar una transacción en PSE

post
Registrar

https://api.payvalida.com/pse/transactions
URL Sandbox: https://api-test.payvalida.com/pse/transactions Al crear una transacción, se envían los datos necesarios para completar el pago, y se obtienen el URL del banco y el ticketid. Para completar la transacción se debe redireccionar al cliente al URL del banco para que éste complete la operación, y con el ticketid se consulta el resultado de la operación. Es prudente esperar de 5 a 10 minutos entre la creación de la transacción y la consulta, tiempo suficiente para que el cliente complete la operación con su entidad bancaria.
Request
Response
Request
Body Parameters
merchant
required
string
Identificación del comercio en Payvalida. Máx. 50 caracteres
serviceCode
required
string
Código de servicio del comercio en PSE. Máx. 80 caracteres
checksum
required
string
Cadena de comprobación con SHA512(reference + amount + di + bank + FIXED_HASH)
bank
required
string
Código del banco en PSE. 4 caracteres
amount
required
string
Monto de la orden de compra.
reference
required
string
Numero de referencia en Payvalida. Máx. 16 caracteres.
di
required
string
Número de documento del comprador. Máx. 20 caracteres
typeDI
required
string
Tipo de documento de identidad del comprador. Máx. 3 caracteres
urlReturn
required
string
URL de retorno después de finalizada transacción en PSE. Máx. 300 caracteres
name
required
string
Nombre y apellido del comprador. Máx. 50 caracteres
personType
required
string
Tipo de persona que realiza la compra. "N" natural o "J" jurídica
ip
required
string
IP del comprador. Máx. 300 caracteres
reference1
optional
string
Número de referencia en PSE. Máx. 25 caracteres
reference2
optional
string
Número de referencia en PSE. Máx. 25 caracteres
reference3
optional
string
Número de referencia en PSE. Máx. 25 caracteres
Response
200: OK
La ejecución retorna un JSON estructurado de la siguiente manera:
{
"CODE":"0000",
"DESC":"Consulta Exitosa",
"DATA":[
{
"URL_BANK":"desarrollo.bancolombia.com",
"TICKET_ID":"00946981"
}
]
}

Detalles

  • serviceCode: código de servicio de Payvalida o del comercio en PSE.

  • bank: se consigue de la lista de bancos.

  • reference: se genera utilizando el API de recaudos.

  • amount: monto de la operación. El monto de la orden en Payvalida debe de coincidir con este.

  • urlReturn: esta url es donde va a redireccionar el cliente cuando termine su operación en PSE.

  • name: nombre del cliente en el documento de identidad (no acepta caracteres especiales ni acentos).

  • typeDI: los valores válidos son "CC", "CE", "NIT", "TI", "PP", "IDC", "CEL", "RC", "DE"

  • personType: se permite tanto personas naturales como jurídicas.

  • ip: ip desde donde se conecta el comprador.

  • reference1/2/3: es un dato cualquiera que le permite a PSE tener trazabilidad de la compra y evitar fraudes. Recomendable datos que ayuden a identificar quién realizó la transacción.

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. El servicecode y el entitycode son entregados luego de configurar el comercio para utilizar PSE.

Para registrar una nueva transacción en PSE sobre la misma referencia se debe de esperar que el estado de la transacción pase de PENDIENTE a FALLIDA o RECHAZADA.