REST services

Overview
Documentation and client for all REST API services

Version information
Version : 1.0

License information
License : liverpool
Terms of service : Terms of service

URI scheme
Host : https://segurosfbcdes.liverpool.com.mx
BasePath : /bcLivViajes

Tags
• viajes-controller : Viajes Controller

Paths
Cancellation operation.

POST /bcServiceViajes/v2/cancelacionViaje

Parameters

Type Name Description Schema

X-Api-Key
Header X-Api-Key string
required

cancelacion AgViajeCancellRequ
Body cancelacion
required estDTO

Responses

1
HTTP
Description Schema
Code

ResumenTransacc
200 OK
ionDTO

ResumenTransacc
202 Found - Operation applied successfully
ionDTO

400 Bad Request - Validate input ErrorDTO

ResumenTransacc
404 Not found - Trackid founded
ionDTO

Consumes

• application/json

Produces

• */*

Tags

• LiverpoolViajes

Operation to buy travels.

POST /bcServiceViajes/v2/compraViaje

Parameters

Type Name Description Schema

X-Api-Key
Header X-Api-Key string
required

requestDto
Body requestDto AgViajeRequestDTO
required

Responses

HTTP
Description Schema
Code

ResumenTransacc
200 OK
ionDTO

ResumenTransacc
201 Created - Operation applied successfully
ionDTO

2
HTTP
Description Schema
Code

400 Bad Request - Validate input ErrorDTO

ResumenTransacc
409 Card Error - Error charging card
ionDTO

ResumenTransacc
412 Config Error - Error in api config
ionDTO

ResumenTransacc
424 Bridgecore Error - Error in bridgecore service
ionDTO

INTERNAL SERVER ERROR - Reporting error used the RFC 7807

500 ErrorDTO
standard

Consumes

• application/json

Produces

• */*

Tags

• LiverpoolViajes

Operation for search by name, card, amount and date .

POST /bcServiceViajes/v2/consultaCoincidenciasViaje

Parameters

Type Name Description Schema

X-Api-Key
Header X-Api-Key string
required

consulta
Body consulta ViajeConsultDTO
required

Responses

HTTP
Description Schema
Code

ResumenTransacc
200 OK
ionDTO

3
HTTP
Description Schema
Code

ResumenTransacc
202 Found - Operation applied successfully
ionDTO

400 Bad Request - Validate input ErrorDTO

ResumenTransacc
404 Not found - Trackid founded
ionDTO

Consumes

• application/json

Produces

• */*

Tags

• LiverpoolViajes

Query operation by trackId.

POST /bcServiceViajes/v2/consultaTrackViajes

Parameters

Type Name Description Schema

X-Api-Key
Header X-Api-Key string
required

track
Body track ConsultaViajeDTO
required

Responses

HTTP
Description Schema
Code

ResumenTransacc
200 OK
ionDTO

ResumenTransacc
202 Found - Operation applied successfully
ionDTO

400 Bad Request - Validate input ErrorDTO

4
HTTP
Description Schema
Code

ResumenTransacc
404 Not found - Trackid founded
ionDTO

Consumes

• application/json

Produces

• */*

Tags

• LiverpoolViajes

Operation to refund travels.

POST /bcServiceViajes/v2/devolucionViaje

Parameters

Type Name Description Schema

X-Api-Key
Header X-Api-Key string
required

requestDto
Body requestDto AgViajeRequestDTO
required

Responses

HTTP
Description Schema
Code

ResumenTransacc
200 OK
ionDTO

ResumenTransacc
201 Refund Succes - Operation applied successfully
ionDTO

400 Bad Request - Validate input ErrorDTO

ResumenTransacc
409 Card Error - Error charging card
ionDTO

ResumenTransacc
412 Config Error - Error in api config
ionDTO

5
HTTP
Description Schema
Code

ResumenTransacc
424 Bridgecore Error - Error in bridgecore service
ionDTO

INTERNAL SERVER ERROR - Reporting error used the RFC 7807

500 ErrorDTO
standard

Consumes

• application/json

Produces

• */*

Tags

• LiverpoolViajes

Definitions
AgViajeCancellRequestDTO
Name Description Schema

barcode travel barcode

string
required Example : "2301090039324022500091943"

idServCobrad
id of the service that is going to be cancelled
o string
Example : "39151209023521"
optional

importe travel´s amount

number (double)
required Example : 2953.26

informacionF
InformacionFormaD
ormaDePago
ePagoDTO
optional

items
< ItemDTO > array
optional

noServicio id of the service that is going to be cancelled

string
optional Example : "39151209023521"

noTienda store number

string
required Example : "39"

6
Name Description Schema

nombreClient
client’s name
e string
Example : "Liver pruebas Digital"
required

origen travel operation origin

string
required Example : "BDY"

referencia travel operation id

string
required Example : "123456789012345678"

seguimientoT
unique operation´s identifier
ransaccion string
Example : "fb6e21e3-b735-4dc1-81dc-df962e54762e"
optional

servicio service number

string
required Example : "0760"

terminalVAD store number

string
required Example : "322"

tipoArticulo store number

string
required Example : "AV"

total store number

number (double)
required Example : 2953.26

totalOriginal store number

number (double)
required Example : 2953.26

AgViajeRequestDTO
Name Description Schema

barcode travel barcode

string
required Example : "2301090039324022500091943"

idServCobrad
id of the service that is going to be cancelled
o string
Example : "39151209023521"
optional

importe travel´s amount

number (double)
required Example : 2953.26

informacionF
InformacionFormaD
ormaDePago
ePagoDTO
optional

items
< ItemDTO > array
optional

noTienda store number

string
required Example : "39"

7
Name Description Schema

nombreClient
client’s name
e string
Example : "Liver pruebas Digital"
required

origen travel operation origin

string
required Example : "BDY"

referencia travel operation id

string
required Example : "123456789012345678"

seguimientoT
unique operation´s identifier
ransaccion string
Example : "fb6e21e3-b735-4dc1-81dc-df962e54762e"
optional

servicio service number

string
required Example : "0760"

terminalVAD store number

string
required Example : "322"

tipoArticulo store number

string
required Example : "AV"

total store number

number (double)
required Example : 2953.26

totalOriginal store number

number (double)
required Example : 2953.26

ConsultaViajeDTO
Name Description Schema

seguimientoT
unique identifier to be searched
ransaccion string
Example : "fb6e21e3-b735-4dc1-81dc-df962e54762e"
optional

ErrorDTO
Type : object

InformacionFormaDePagoDTO
Name Description Schema

fecExp card´s expiration date in MMdd format

string
required Example : "9812"

noTarjeta card number to be charged

string
required Example : "1300002000109001"

8
Name Description Schema

plan credit plan to be used for the purchase

string
required Example : "20001"

sc card´s nip number

string
required Example : "956"

tipoTarjeta card´s type

string
required Example : "1"

ItemDTO
Name Description Schema

cantidad number of items to be bought

integer (int32)
required Example : 1

idSku sku number to be bought

string
required Example : "1019218691"

importe item price per unit

number (double)
required Example : 20.0

ResumenTransaccionDTO
Name Description Schema

anularTransa
return if the transaction is going to me nullified
ccion boolean
Example : true
optional

barcode bar codes

string
required Example : "2301090039324022500091943"

boleta ticket number from bridgecore

string
optional Example : "0764"

certificado
string
optional

codigoError api return code that matches whit the BD

string
optional Example : "5"

codigoErrorB
bridgecore error
C integer (int32)
Example : 11093
optional

codigoRetorn
api return code that matches whit the BD
o string
Example : "01"
optional

9
Name Description Schema

estadoTransa
true if transation is fullfilled
ccion boolean
Example : true
optional

importeTotal
number (double)
optional

items
list of items bought < ItemDTO > array
optional

message that explains result of operation

mensaje
Example : "No fue posible realizar el cargo a la cuenta string
optional
Dígito verificador inválido intente mas tarde."
noAutorizacio
authorization number
n string
Example : "00392212290742"
optional

noPedido transaction number

string
required Example : "00392212290742"

numeroSkus number of skus bought

integer (int32)
optional Example : 1

seguimientoT
transaction code for following
ransaccion string
Example : "38c6d6db-9b30-4e9c-bde9-ef5c27466667"
optional

ViajeConsultDTO
Name Description Schema

fecha date to be searched dd/MM/yyyy

string
optional Example : "02/01/2023"

monto ammount to be searched

number (double)
optional Example : 30.0

nombreClient
client’s name
e string
Example : "Liver pruebas Digital"
optional

tarjeta card number to be searched

string
optional Example : "1300002000109001"

10