Servicio de listado de datos de sucursales
Detalles de la llamada para recarga de tipo normal#
- Recurso:
/v3/rechargebranches - Método HTTP:
GET - Formato de solicitud:
query string - Formato de respuesta:
JSON
Detalles de la llamada para conocer el tipo de recarga de others#
- Recurso:
/ v3 / rechargebranches / {nit} - Método HTTP:
PUT - Formato de solicitud:
JSON - Formato de respuesta:
JSON
Detalles de la llamada para recarga de tipo invoice#
- Recurso:
/ v3 / rechargebranches / {nit} - Método HTTP:
PUT - Formato de solicitud:
JSON - Formato de respuesta:
JSON - Parámetros de encabezado:
| Parámetro | Descripción | Formato | Obligatorio |
|---|---|---|---|
Content-Type | Debe enviarse con el valor application/json. | = 15 AN | SI |
Authorization | Firma de autenticidad en formatoBearer {assinatura}. [Más información.] (autenticacao-assinatura.md)Ejemplo: Bearer hh39458f73hf45324765ft349h5f73t4h95f34.Este campo es obligatorio si la transacción se creó mediante el proceso de firma. | < 2000 AN | COND. |
Ejemplos#
A continuación, se muestran ejemplos de llamadas al servicio de listado de datos de afiliados utilizando la herramienta cURL.
Listado de datos de sucursales de recarga tipo normal#
Solicitud:
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
Respuesta:
Lista de datos de sucursales de recarga de tipo others#
Solicitud:
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
Respuesta:
Lista de datos de la sucursal de recarga invoice#
Solicitud:
Para usar este ejemplo, no olvide definir la variable {{url}} con el valor
esitef-homologacao.softwareexpress.com.br
Respuesta:
Solicitar parámetros para recarga de tipo normal#
En la siguiente tabla, hay una descripción de los parámetros de solicitud del servicio de listado de datos de sucursales para recargas de tipo normal:
| Parámetro | Descripción | Formato | Obligatorio |
|---|---|---|---|
nit | Identificación de la transacción de recarga en Pago Online | = 64 AN | SI |
ddd | Código de área de teléfono | = 2 N | SI |
dealercode | Código de concesionaria / operador | < 3 N | SI |
generalhash | Código de identificación de la versión de la tabla con datos relacionados con recargas (operadores, sucursales, rangos de valor, vigencia de crédito, entre otros). Si la tienda no ha realizado previamente una recarga o no tiene Después de guardar un valor generalhash recibido previamente de Pago Online, el valor: 0000000000000000 se puede pasar a Pago Online. Este campo permite al comerciante saber si ha habido un cambio en los datos de recarga. Esto se debe a que si hubo algún cambio en la tabla, el generalhash devuelto será diferente del generalhashque tiene el comerciante. En este caso, es recomendable que el dueño de la tienda realice las consultas y actualice los valores de los operadores de recarga en su aplicación. | = 16 AN | NO |
Solicitar parámetros para recarga de tipo otros#
En la siguiente tabla, hay una descripción de los parámetros de solicitud del servicio de listado de datos de afiliados para la recarga de tipo "otros":
| Parámetro | Descripción | Formato | Obligatorio | |||
|---|---|---|---|---|---|---|
nit | Identificación de la transacción de recarga en Pago Online. Atención: Este campo va en la URL de la solicitud y no en el cuerpo. | = 64 AN | SI | |||
ddd | Código de área del teléfono | = 2 N | NÃO | |||
general_hash | Tabla de código de identificación con datos relacionados con recargas (operadores, sucursales, rangos de valor, validez crediticia, entre otros). | = 16 AN | NO | |||
| dealer | Información del distribuidor / operador. Esta información se devuelve en la llamada de lista de distribuidores. | |||||
code | Código de distribuidor / operador | < 3 N | SI | |||
type_code | Código de tipo de distribuidor / operador | < 3 N | SI | |||
| dealer.branch | Información de la sucursal del concesionario | |||||
code | Código de sucursal del concesionario / operador | < 11 N | SI | |||
| answers[] | Este campo agrega una lista de respuestas. Envío obligatorio si se han recibido consultas sobre la lista de concesionarios. | |||||
code | Código de la pregunta a responder (preguntas.id de la respuesta de la lista de distribuidores) | < 20 AN | COND. | |||
description | Pregunta respuesta | < 200 AN | COND. | |||
Solicitar parámetros para recarga de tipo invoice#
En la siguiente tabla, hay una descripción de los parámetros de solicitud del servicio de listado de datos de afiliados para el tipo de recarga invoice:
| Parámetro | Descripción | Formato | Obligatorio | |||
|---|---|---|---|---|---|---|
nit | Identificación de la transacción de recarga en Pago Online. Atención: Este campo va en la URL de la solicitud y no en el cuerpo. | = 64 AN | SI | |||
general_hash | Tabla de código de identificación con datos relacionados con recargas (operadores, sucursales, rangos de valor, validez crediticia, entre otros). | = 16 AN | NO | |||
| dealer | Información del concesionaria / operadora. Esta información se devuelve en la llamada de lista de concesionarias. | |||||
code | Código de concesionaria / operadora | < 3 N | SI | |||
| dealer.branch | Información de la sucursal de la concesionaria | |||||
code | Código de sucursal del concesionario / operador | < 11 N | SI | |||
| answers[] | Este campo agrega una lista de respuestas. Envío obligatorio si se han recibido consultas sobre la lista de concesionarios. | |||||
code | Código de la pregunta a responder (preguntas.id de la respuesta de la lista de distribuidores) | < 20 AN | COND. | |||
description | Respuesta a la pregunta | < 200 AN | COND. | |||
Parámetros de respuesta#
Si tiene éxito, el código de respuesta HTTP será "200". Cualquier otro código debe interpretarse como un error. En la siguiente tabla se muestra una descripción de los parámetros de respuesta del servicio de listado de datos de la sucursal:
| Parámetro | Descripción | Formato | ||||
|---|---|---|---|---|---|---|
status | Estado de la transacción de recarga en Pago Online. [Más información.] (Api-codes.md # e-sitef-transaction-status) | = 3 AN | ||||
invoice_holder_name | Nombre del titular de la factura | < 70 AN | ||||
echo | Campo a reenviar para recargas de tipo invoice | < 128 AN | ||||
resubmit_transaction | Indica que esta transacción debe reenviarse con el código de suscripción de TV seleccionado. | < 5 AN | ||||
| esitef | ||||||
code | Código de respuesta de pago en línea. Cualquier código que no sea 0 (cero) significa falla. Más información. | < 4 N | ||||
message | Mensaje de respuesta de Pago Online. | < 500 AN | ||||
| sitef | ||||||
code | Código de respuesta devuelto por el autorizador | < 4 AN | ||||
| hashes | ||||||
general | Tabla de código de identificación con datos relacionados con recargas (operadores, sucursales, rangos de valor, validez crediticia, entre otros). | = 16 AN | ||||
| questions[] | Este campo agrega una lista de preguntas para confirmación positiva. Las preguntas devueltas deben, necesariamente, ser respondidas por el usuario y enviar sus respuestas a Pago Online en el siguiente paso (listado de datos de la sucursal). | |||||
id | Código de identificación de la pregunta | < 20 AN | ||||
display | Texto de la pregunta que se presentará | < 180 AN | ||||
rule | Indica dónde se deben recopilar los datos. [Más información.] (recarga-rest-listDealers.md#retorno-do-campo-questionsrule) | < 2 AN | ||||
min | Indica el tamaño mínimo de respuesta | < 4 N | ||||
max | Indica el tamaño máximo de la respuesta | < 5 N | ||||
type | Indica el tipo de datos de respuesta que se recopilarán. [Más información.] (recarga-rest-listDealers.md#retorno-do-campo-questionstype) | < 3 AN | ||||
min_value | Indica el valor mínimo de respuesta | < 3 N | ||||
max_value | Indica el valor máximo de la respuesta | < 3 N | ||||
| general | Este campo agrega una lista de características generales entre las ramas. | |||||
message | Mensaje general. | < 101 AN | ||||
| categories | Este campo agrega una lista de categorías. | |||||
code | Código de categoría | < 5 AN | ||||
description | Texto descriptivo de la categoría | < 100 AN | ||||
| categories.amount_ranges | Este campo agrega una lista de rangos de valores. | |||||
message | Mensaje de información de recarga | < 100 AN | ||||
amount_key | Tecla de valor de recarga (a enviar al recargar). | < 5 AN | ||||
bonus_in_percentage | Bono de recarga en porcentaje del valor nominal (con 2 decimales: por ejemplo, 1% = 100). | < 5 N | ||||
bonus | Bono de recarga. | < 12 N | ||||
payment_amount | Costo de recarga. | < 12 N | ||||
bonus_category | Categoría de bonificación (debe ser uno de los valores en category.code). | < 5 AN | ||||
expiry_date | Periodo de validez (en días). | < 4 N | bonus_expiry_date | Período de validez de la bonificación (en días). | < 4 N | |
min_amount | Valor mínimo del rango, en centavos de real. | < 12 N | ||||
max_amount | Valor máximo del rango, en centavos de real. | < 12 N | ||||
| categories.fixed_amounts | Este campo agrega una lista de valores fijos. | |||||
message | Mensaje de información de recarga | < 100 AN | ||||
amount_key | Tecla de valor de recarga (a enviar al recargar). | < 5 AN | ||||
bonus_in_percentage | Bono de recarga en porcentaje del valor nominal (con 2 decimales: por ejemplo, 1% = 100). | < 5 N | ||||
bonus | Bono de recarga. | < 12 N | ||||
payment_amount | Costo de recarga. | < 12 N | ||||
bonus_category | Categoría de bonificación (debe ser uno de los valores en category.code). | < 5 AN | ||||
expiry_date | Periodo de validez (en días). | < 4 N | ||||
bonus_expiry_date | Período de validez de la bonificación (en días). | < 4 N | ||||
amount | Valor nominal de la recarga, en céntimos del real. | < 12 N | ||||
| payment_methods | ||||||
max | Número máximo de métodos de pago | < 2 N | ||||
available | Este campo agrega una lista de métodos de pago disponibles y sus detalles. [Más información.] (#retorno-do-campo-payment_methodsavailable) | < 200 AN | ||||
| host | ||||||
message | Nombre de la institución | < 16 AN | ||||
code | Código de respuesta de la institución | < 12 AN | ||||
| acquirer | ||||||
merchant_code | Código del establecimiento | < 15 N | ||||
| authorization | ||||||
number | Número autorización | < 6 AN | ||||
sitef_usn | Nsu del Sitef | < 6 N | ||||
host_usn | Nsu del hot | < 12 N | ||||
authorizer_time | Tiempo de respuesta del autorizador HHMMSS | = 6 N | ||||
authorizer_date | Fecha de respuesta del autorizador «MMDD» | = 4 N | ||||
| invoices | Este objeto contiene campos devueltos para pago sin factura (tipo de recarga invoice). | |||||
expiry_date | Fecha de vencimiento de la factura elegida en formato "AAAAMMDD" | = 8 N | ||||
consumption_reference | Fecha de referencia en la factura elegida en formato "MMYYY" | = 6 N | ||||
bar_code | Código de barras de la factura elegida | = 48 N | ||||
amount | Valor de la factura elegida | < 12 N | ||||
message | Mensaje general | < 64 AN |
Devolución del campo payment_methods.available#
El campo payment_methods.available puede contener uno o más datos para leer. Cada lectura de datos tiene el siguiente formato:
TipoN:IDColetaN1-IDColetaN2-IDColetaN3-...-IDColetaNn
Donde:
TipoN: indica la forma de pago permitida.
| Tipo | Descrição |
|---|---|
00 | Dinero |
01 | Cheque |
02 | TEF Débito |
03 | TEF Crédito |
10 | Ticket Electrónico |
11 | Ticket Papel |
12 | Billetera Digital |
13 | PIX |
50 | TEF Tarjeta |
99 | Otras Formas |
Observaciones:
- Si no hay campos para recopilar, solo se devolverá el campo
TipoN. - En el futuro, se pueden agregar nuevos métodos de pago a esta tabla. Si el PDV no conoce alguno de estos nuevos formularios, debe estar preparado para "saltear" solo este formulario, sin afectar su procesamiento.
- El método de pago "TEF Tarjeta " (tipo
50) se utiliza para agrupar, en un solo tipo, todas las formas de pago que involucran tarjetas (tipos02y03).
IDColetaNn: indica el ID del campo que el PDV debe recolectar y enviar a SiTef.
| ID | Descripción | Significado y formato |
|---|---|---|
01 | Verifique el tipo de entrada del Cheque | 0: lectura deCMC-71: digitação da primeira linha do cheque2: digitação do CMC-7 |
02 | Informaciones del Cheque | - CMC-7 leído o digitado, o - digitado en la primera línea del cheque, con el siguiente formato: Compensación (3), Banco (3), Ageencia (4), C1 (1), Cuenta corriente (10), C2 (1), Número de cheque (6) y C3 (1), en ese orden. |
03 | Red de destino | Identificación del autorizador de la transacción TEF (según la tabla de Red de Destino de la especificación SiTef). |
04 | Transacción TEF SiTef NSU | Identificación de la transacción TEF en SiTef. |
05 | Fecha del SiTef de la transacción TEF (No se utiliza actualmente) | Fecha de la transacción TEF en SiTef, en formato DDMMYYY. |
06 | Código de la empresa de transacción de TEF | Código SiTef de la Compañía utilizada en la transacción TEF. |
07 | NSU del Hot de la transacción de TEF. | |
08 | Fecha del host de la transacción TEF | Fecha de la transacción del host TEF, en formato "DDMMYYY". |
09 | Código de origen de la transacción TEF | Código de establecimiento de la transacción TEF. |
10 | Datos de confirmación de la transacción TEF. | El campo 9 se devolvió al realizar la transacción TEF. |
11 | Código de autorización de transacción TEF | Código de autorización de host para la transacción TEF. |
12 | Valor del Cheque | Valor total del cheque. Se puede usar un solo cheque para pagar más de una cuenta. |
13 | Red de destino - Complemento | Complemento de ID 03 |
14 | Banner de tarjeta | Marca de la tarjeta utilizada en la transacción EFT. |
15 | Tipo de pago | 00 - a la vista 01 - Fecha anterior 02 - Pago a plazos por parte del establecimiento 03 - Pago a plazos por parte del administrador |
Comentarios:
El campo de ID 13, a diferencia de los demás, no indica un campo que deba recopilarse. Este campo solo funciona como complemento del campo ID 03, enviando la lista de redes de destino permitidas, en el siguiente formato:
13(Rede1,Rede2,...,RedeN)
O sea , si solo está presente el campo ID 03, se debe recopilar la red de destino, sin restricciones en cuanto a qué redes pueden pagar por una determinada transacción (Ejemplo: recarga). Sin embargo, si los campos deID 03 e 13 están presentes, el primero indica que se debe recopilar la red de destino, mientras que el segundo indica qué redes de destino pueden pagar la recarga.
Además, como la colección fue indicada por el ID 03, el TPV debe enviar la red de destino a SiTef también a través de este ID (y no por el ID 13).
En el futuro, se pueden agregar nuevos campos a esta tabla. Si el PVD no conoce alguno de estos nuevos campos, debe estar preparado para "saltear" solo este campo, sin afectar su procesamiento.