| Payload |
| Code Block |
|---|
| language | js |
|---|
| title | JSON Schema |
|---|
| collapse | true |
|---|
| {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"external": {
"type": "object",
"properties": {
"orderId": {
"description": "Identificador externo del pago",
"type": "string"
},
"collectionOrderId": {
"description": "Identificador externo del pago por tarjeta",
"type": "string"
},
"consolidatorOrderId": {
"description": "Identificador externo del agrupador, unificador de empresas",
"type": "string"
},
},
"requiredconsolidatorValue": [
"orderId",
"orderConsolidatorId"
]
},
"paymentDate": {
{
"description": "FechaValor total ende la compra por quecada seuna realizade ellas pagoempresas",
"type": "string"number,
"formatexclusiveMinimum": 0
"date-time" }, "parentGuardian": {
},
"totalValue": {
"description": "Valor total de la compra, si es multi-sello o 2 tarjetas, aquí va el valor de toda la compra",
"type": number,
"exclusiveMinimum": 0
},
"orderCount": {
"description": "Es la cantidad de pedidos que conforman la compra",
"type": number,
"exclusiveMinimum": 0
"example": 2
}
},
"required": [
"orderId",
"consolidatorOrderId",
"totalValue",
"orderCount"
]
},
"paymentDate": {
"description": "Fecha en la que se realiza el pago",
"type": "string",
"format": "date-time"
},
"parentGuardian": {
"type": "object",
"properties": {
"refId": {
"description": "Id en BDC de la persona que está realizando el pago",
"type": "string",
"format": "uuid",
"maxLength": 36,
"minLength": 36
},
"document": {
"description": "Documento de identificación de la persona que está realizando el pago (CPF)",
"type": "string"
}
},
"required": [
"refId",
"document"
]
},
"paymentMethod": {
"description": "Identificador del método de pago, es el campo parametro en la tabla forma_pago",
"type": "string",
"minLength": 0,
"maxLength": 10
},
"conciliationAccount": {
"description": "Identificador del concentrador de pago, es el campo parametro en la tabla concentra_pago",
"type": "string",
"minLength": 0,
"maxLength": 6
},
"price": {
"description": "Precio final a pagar, después de markup, descuentos, impuestos y cargos",
"type": "number",
"exclusiveMinimum": 0
},
"originalPrice": {
"description": "Precio inicial a pagar, antes de markup, descuentos, impuestos y cargos",
"type": "number",
"exclusiveMinimum": 0
},
"discounts": {
"description": "Descuentos aplicados en la compra",
"type": "object",
"properties": {
"discountOne": {
"description": "Concentra el valor acumulado de los descuentos que no sean de tipo PARC",
"type": "object",
"properties": {
"amount": {
"description": "Es el valor acumulado de los descuentos que no sean de tipo PARC",
"type": "number",
"minimum": 0
}
},
"required": [
"amount"
]
},
"discountTwo": {
"description": "Concentra el valor del descuento de tipo PARC",
"type": "object",
"properties": {
"amount": {
"description": "Es el valor correspondiente al descuento de tipo PARC",
"type": "number",
"minimum": 0
}
},
"required": [
"amount"
]
}
]
},
"taxes": {
"description": "Valor total de los impuestos aplicados, correspondiente al porcentaje total de impuestos",
"type": "number",
"minimum": 0
},
"taxRate": {
"description": "Porcentaje total de impuestos aplicados",
"type": "number",
"minimum": 0
},
"itemList": {
"description": "Lista de paquetes vendidos",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": [
{
"type": "object",
"properties": {
"articleRefId": {
"description": "Id en BDC del artículo/paquete",
"type": "string",
"format": "uuid",
"maxLength": 36,
"minLength": 36
},
"student": {
"type": "object",
"properties": {
"refId": {
"description": "Id en BDC del alumno",
"type": "string",
"format": "uuid",
"maxLength": 36,
"minLength": 36
},
"personRefId": {
"description": "Id en BDC de la persona asociada al alumno",
"type": "string",
"format": "uuid",
"maxLength": 36,
"minLength": 36
}
},
"required": [
"refId",
"personRefId"
]
},
"totalItem": {
"description": "Cantidad vendida del artículo/paquete",
"type": "integer",
"exclusiveMinimum": 0
},
"price": {
"description": "Precio final del artículo/paquete, después de markup, descuentos, impuestos y cargos",
"type": "number",
"exclusiveMinimum": 0
},
"originalPrice": {
"description": "Precio inicial del artículo/paquete, antes de markup, descuentos, impuestos y cargos",
"type": "number",
"exclusiveMinimum": 0
},
"discountList": {
"description": "Lista de descuentos aplicados al artículo/paquete, si hay un descuento comercial este debe ser informado siempre primero, es decir, en la primera posición del array, si hay más de 3 descuentos aplicados estos se acumulan en el tercer/último descuento",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"maxItems": 3,
"items": [
{
"type": "object",
"properties": {
"rate": {
"description": "Indica el porcentaje del descuento",
"type": "number",
"exclusiveMinimum": 0
},
"reason": {
"description": "Identificador de la razón del descuento, es el campo parametro en la tabla razon",
"type": "string",
"minLength": 0,
"maxLength": 16
},
"amount": {
"description": "Indica el valor correspondiente al porcentaje del descuento",
"type": "number",
"exclusiveMinimum": 0
}
},
"required": [
"rate",
"reason",
"amount"
]
}
]
},
"taxes": {
"description": "Valor de los impuestos aplicados al artículo/paquete, correspondiente al porcentaje de impuestos",
"type": "integer",
"minimum": 0
},
"taxRate": {
"description": "Porcentaje de impuestos aplicados al artículo/paquete",
"type": "integer",
"minimum": 0
},
"salesType": {
"description": "Identificador del tipo de venta, es el campo parametro en la tabla tipo_venta",
"type": "string",
"minLength": 0,
"maxLength": 14
},
"salesChannel": {
"description": "Identificador del canal de venta, es el campo parametro en la tabla canal_venta",
"type": "string",
"minLength": 0,
"maxLength": 10
},
"salesOption": {
"description": "Identificador de la opción de venta, es el campo parametro en la tabla opcion_venta",
"type": "string",
"minLength": 0,
"maxLength": 3
},
"componentList": {
"description": "Lista de los artículos/componentes que forman parte del artículo/paquete vendidos, este atributo solo debe estar presente cuando es un pago de una venta fraccionada o cuando la empresa requiere desglose de componentes para la integración con el ERP, por ejemplo: Compartilha y TDL",
"type": "array",
"items": [
{
"type": "object",
"properties": {
"refIdarticleRefId": {
"description": "Id en BDC de la persona que está realizando el pagodel artículo/componente",
"type": "string",
"format": "uuid",
"maxLength": 36,
"minLength": 36
36
},
"documenttotalItem": {
"description": "DocumentoCantidad devendida identificación de la persona que está realizando el pago (CPF)del artículo/paquete",
"type": "stringinteger",
}
},
"requiredexclusiveMinimum": [
0
"refId"},
"document"
]
},
"paymentMethodprice": {
"description": "IdentificadorPrecio final del artículo/componente, métododespués de pagomarkup, esdescuentos, elimpuestos campo parametro en la tabla forma_pagoy cargos",
"type": "stringnumber",
"minLengthexclusiveMinimum": 0,
"maxLength": 10
},
"conciliationAccountoriginalPrice": {
"description": "IdentificadorPrecio inicial del concentradorartículo/componente, antes de pagomarkup, esdescuentos, elimpuestos campo parametro en la tabla concentra_pagoy cargos",
"type": "stringnumber",
"minLength "exclusiveMinimum": 0
},
"maxLength": 6
},
"pricemarkupRate": {
"description": "Precio final a pagar, después de markup, descuentos, impuestos y cargos",
"type": "number",
"exclusiveMinimum "minimum": 0
},
"originalPricepriceWithMarkup": {
"description": "PrecioValor del precio inicial adel pagararticulo/componente, antesdespués dedel markup, descuentos, impuestos y cargos",
"type": "number",
"exclusiveMinimumminimum": 0
},
"discountListtaxes": {
"description": "ListaValor de descuentoslos impuestos aplicados al total de la compraartículo/componente, sicorrespondiente hayal másporcentaje de 2 descuentos aplicados estos se acumulan en el segundo/último descuentoimpuestos",
"type": "arraynumber",
"uniqueItems": true,
"minItemsminimum": 1,0
"maxItems": 2,
"items": [
{ },
"type": "object",
"propertiestaxRate": {
"rate": {
"description": "IndicaPorcentaje de elimpuestos porcentajeaplicados delal descuentoartículo/componente",
"type": "number",
"exclusiveMinimumminimum": 0
},
"amountdiscountList": {
"description": "IndicaLista elde valordescuentos correspondienteaplicados al porcentaje del descuento artículo/componente, solo puede indicarse el tipo de descuento por venta fraccionada",
"type": "numberarray",
"exclusiveMinimumuniqueItems": 0
true,
}
"minItems": 1,
},
"requiredmaxItems": [ 1,
"rate",
"amountitems": [
]
}
]{
},
"itemList": {
"description": "Lista de paquetes vendidos",
"type": "arrayobject",
"uniqueItems": true,
"minItems": 1,
"itemsproperties": [{
{
"type": "object",
"propertiesrate": {
"articleRefId": {
"description": "IdIndica enel BDCporcentaje del artículo/paquetedescuento",
"type": "stringnumber",
"format": "uuid",
"maxLengthexclusiveMinimum": 36,0
"minLength": 36
},
"student": {
"type": "object",
"propertiesreason": {
"refId": {
"description": "Id en BDC del alumno",
Identificador de la razón del descuento, es el campo parametro en la tabla razon, para venta fraccionada solo se acepta el valor VEFR y si es venta por paquete solo se acepta el valor COM",
"type": "string",
"format": "uuid",
"maxLength": 364,
"minLength": 36
4
},
"personRefIdamount": {
"description": "IdIndica enel BDCvalor decorrespondiente laal personaporcentaje asociadadel al alumnodescuento",
"type": "stringnumber",
"formatexclusiveMinimum": "uuid",0
"maxLength": 36 }
},
"minLengthrequired": 36[
}
}"rate",
"required": [
"refIdreason",
"personRefIdamount"
]
},]
"totalItem": {
"description": "Cantidad vendida del artículo/paquete",
}
"type": "integer",
]
"exclusiveMinimum": 0
},
"pricesalesTerms": {
"description": "Precio final del artículo/paquete, después de markup, descuentos, impuestos y cargos",
"type": "numberobject",
"exclusiveMinimumproperties": 0{
},
"originalPricefamilyCode": {
"description": "Precio inicial del artículo/paquete, antes de markup, descuentos, impuestos y cargos",
Código da Família do Produto | Lista na plataforma | Código da categoria",
"type": "numberstring",
"exclusiveMinimumexample": 0
"idiomas"
},
"discountListcode": {
"description": "ListaEl indicador del tipo de descuentos aplicados al artículo/paquete, si hay más de 3 descuentos aplicados estos se acumulan en el tercer/último descuento",
"type": "array", artículo/componente, puede tener solo 3 valores posibles: 1 cuando el tipo articulo es LIB, 2 cuando el tipo de articulo es LIBD y 3 cuanto el tipo de articulo sea SERV",
"uniqueItems": true,
"minItemstype": 1"number",
"maxItems": 3,
"itemsexample": [ 1
{
},
"type": "object",
"propertiesgroup": {
"rate": {
"description": "Indica el porcentaje del descuento",
"description": "1-Avulso, 2-Agrupado",
"type": "number",
"exclusiveMinimumexample": 01
},
"reasondigitalCode": {
"description": "IdentificadorCódigo deERP lado razónproduto deldigital descuento,| esCaso elo campogroup parametro en la tabla razon== 2",
"type": "string",
"minLengthexample": 0,
"maxLength": 16
"22006077"
},
"amountisExclusive": {
"description": "Indica el valor correspondiente al porcentaje del descuentoItem exclusivo: false - Não exclusivo, true - exclusivo",
"type": "numberboolean",
"exclusiveMinimumexample": 0true
}
},
"required": [
"ratefamilyCode",
"reasoncode",
"amountgroup",
]
"digitalCode",
}
"isExclusive"
]
}
},
"taxesrequired": {[
"descriptionarticleRefId": "Valor de los impuestos aplicados al artículo/paquete, correspondiente al porcentaje de impuestos,
"totalItem",
"type": "integer "price",
"minimumoriginalPrice": 0,
},
"taxRatemarkupRate": {
,
"description": "Porcentaje de impuestos aplicados al artículo/paquete",
priceWithMarkup",
"type": "integer "taxes",
"minimumtaxRate": 0,
},
"salesTypediscountList": {
,
"descriptionsalesTerms": "Identificador del tipo de venta, es el campo parametro en la tabla tipo_venta",
"type": "string",
]
"minLength": 0,}
"maxLength": 14]
},
"salesChannel": {
},
"descriptionrequired": "Identificador del canal de venta, es el campo parametro en la tabla canal_venta",
[
"type": "string"articleRefId",
"minLengthstudent": 0,
"maxLengthtotalItem": 10,
}"price",
"salesOptionoriginalPrice": {,
"description": "Identificador de la opción de venta, es el campo parametro en la tabla opcion_ventataxes",
"taxRate",
"typesalesType": "string,
"salesChannel",
"minLengthsalesOption": 0,
"maxLengthcomponentList":
3
]
},
]
},
"componentListfreight": {
"descriptiontype": "Lista de los artículos/componentes que forman parte del artículo/paquete vendidos, este atributo solo debe estar presente cuando es un pago de una venta fraccionada",
"object",
"properties": {
"transportName": {
"type": "arraystring",
},
"itemstransportPhone": [{
"type": "string"
{},
"transportCode": {
"type": "objectstring",
},
"propertiesorderNote": {
"type": "string"
},
"articleRefIdorderFreightValue": {
"type": "number"
},
"descriptionorderDeliveryForecast": {
"Id en BDC del artículo/componente",
"type": "string"
},
"orderEstablishment": {
"type": "string",
}
},
"formatrequired": "uuid[
"transportName",
"transportPhone",
"transportCode",
"maxLengthorderNote": 36,
"orderFreightValue",
"minLengthorderDeliveryForecast": 36,
"orderEstablishment"
]
},
"totalItemaddressList": {
"description": "Cantidad vendida del artículo/paquete",
Lista de domicilios asociados a la persona que realiza el pago",
"type": "integerarray",
"exclusiveMinimumuniqueItems": 0true,
}"minItems": 2,
"maxItems": 3,
"priceitems": {[
{
"descriptiontype": "Precio final del artículo/componente, después de markup, descuentos, impuestos y cargosobject",
"properties": {
"typeaddress": "number",
{
"exclusiveMinimumtype": 0"object",
},
"properties": {
"originalPriceaddressType": {
"description": "PrecioIndicador del inicialtipo delde artículo/paquetedomicilio, antes de markup, descuentos, impuestos y cargos",
solo puede tener 3 valores (Physical, Mailing, Shipping)",
"type": "string",
"typemaxLength": "number"7,
"exclusiveMinimumminLength": 08
},
"markupRatestreet": {
"descriptiontype": "string"
},
"outdoorNumber": {
"type": "numberstring",
},
"minimuminteriorNumber": 0
{
"type": "string"
},
"taxesneighborhood": {
"descriptiontype": "string"Valor de los impuestos aplicados al artículo/componente, correspondiente al porcentaje de impuestos",
},
"typecity": "number",
{
"minimumtype": 0"string"
},
"taxRatepostalCode": {
"descriptiontype": "string"Porcentaje de impuestos aplicados al artículo/componente",
},
"county": {
"type": "numberobject",
"minimumproperties": 0{
},
"refId": {
"discountListtype": {"string",
"description": "Lista de descuentos aplicados al artículo/componente, solo puede indicarse el tipo de descuento por venta fraccionadaformat": "uuid",
"typemaxLength": "array"36,
"uniqueItemsminLength": true,36
"minItems": 1},
"maxItemscountyCode": 1,{
"itemstype": [
"string"
}
{
},
"typerequired": "object[
"refId",
"countyCode"
"properties": {
]
},
"ratecontact": {
"type": "string"
"description": "Indica el porcentaje del descuento" },
"phone": {
"type": "numberstring",
},
"exclusiveMinimumphone2": 0{
"type": "string"
},
"position": {
"reasontype": {"string"
},
"descriptionofficeHours": "Identificador de la razón del descuento, es el campo parametro en la tabla razon, al ser venta fraccionada solo se acepta el valor VEFR",{
"type": "string",
},
"maxLengthemail": 4,{
"minLength"type": 4
"string",
"format": "email"
},
},
"amounttimeZone": {
"descriptiontype": "Indica el valor correspondiente al porcentaje del descuentoobject",
"typeproperties": "number",{
"exclusiveMinimumrefId": 0{
}"type": "string",
}"format": "uuid",
"requiredmaxLength": [36,
"rateminLength",: 36
}
"reason",
},
"amountrequired": [
"refId"
]
]
}
},
]"language": {
}"type": "object",
},
"properties": {
"requiredrefId": [{
"type": "articleRefIdstring",
"totalItemformat": "uuid",
"pricemaxLength": 36,
"originalPriceminLength",: 36
"markupRate",}
"taxes"},
"taxRaterequired",: [
"discountListrefId"
]
},
]
"active": {
"type": "boolean"
}
},
"required": [
"articleRefIdaddressType",
"studentstreet",
"totalItemoutdoorNumber",
"priceinteriorNumber",
"originalPriceneighborhood",
"taxescity",
"taxRatepostalCode",
"salesTypecounty",
"salesChannelcontact",
"salesOptionphone",
"componentListphone2",
]
"position",
}
]
},
"freightofficeHours":,
{
"type": "object",
"propertiesemail": {,
"transportName": {
"type": "string"timeZone",
},
"transportPhonelanguage": {
,
"typeactive":
"string"
},
"transportCode": {
]
"type": "string"
}
},
"orderNoterequired": {[
"typeaddress": "string"
]
},
]
"orderFreightValue},
"invoiceData": {
"type": "numberobject",
},
"properties": {
"orderDeliveryForecastname": {
"type": "string"
},
"orderEstablishment": {
"lastName": {
"type": "string"
}
},
"requireddocument": [
{
"transportNametype",: "transportPhonestring",
"transportCode",
"orderNote",
"orderFreightValue",
"orderDeliveryForecast",
"orderEstablishment"
]
},
"addressList": {
"descriptionisLegalPerson": "Lista{
de domicilios asociados a la persona que realiza el pago" "type": "array",boolean"
"uniqueItems": true,
"minItems": 2,
"maxItems": 3,
"items}
},
"required": [
{
"type": "object",
name",
"properties": {
"address": {
"type": "object",
"properties": {
"addressTypedocument",
"isLegalPerson"
]
},
"transactions": {
"description": "IndicadorLista delde tipoformas de domicilio, solo puede tener 3 valores (Physical, Mailing, Shipping)",
pago utilizadas en la compra. Ejemplo, si se realiza un pago con 2 tarjetas, se cada elemento tendrá la información relacionada a la compra realizada de cada tarjeta."
"type": "string",
"maxLength": 7,
array",
"minLengthitems": 8[
{
}"type": "object",
"streetproperties": {
"typeorderId": "string"
},
{
"outdoorNumberdescription": {
"Identificador de la compra del lado del integrador (Venda Bem Pago)",
"type": "string"
},
"interiorNumbertransactionId": {
"typedescription": "string"
},
"neighborhood": {
Identificador de la transacción del lado del integrador (Transaçao Bem Pago)",
"type": "string"
},
"cityestablishmentCode": {
"type": "stringinteger"
},
"postalCodepaymentMethodCode": {
"type": "stringinteger"
},
"countyvalue": {
"type": "objectinteger",
"properties": {
},
"refIdvalueDiscount": {
"type": "stringinteger",
"format": "uuid"},
"maxLengthinstallments": 36,
{
"minLengthtype": 36
"integer"
},
"countyCodestatus": {
"type": "string"
}
integer"
},
"requiredauthorization": [{
"refId",
"type": "string"
},
"countyCodeoperatorTransactionCode": {
]
"type": "string"
},
"contactoperatorApprovalDate": {
"type": "string"
},
"phonereceipt": {
"type": "string"
},
"phone2nsu": {
"type": "string"
},
"positionmessage": {
"type": "string"
},
"officeHourscard": {
"description": "Datos de la tarjeta, este campo solo es obligatorio cuando el pago es con tarjeta",
"type": "stringobject",
},"properties": {
"emailcardHolder": {
"typedescription": "stringNombre del titular de la tarjeta",
"formattype": "emailstring"
},
"timeZonecardNumber": {
"typedescription": "objectNúmero de la tarjeta utilizada, tal cual la devuelve el integrador, con una mascara que solo muestra los primeros 6 dígitos, seguidos de 7 asteríscos y los últimos 4 dígitos",
"propertiesexamples": {
"refId": {
["123456*******7890"],
"type": "string",
},
"formatdocument": "uuid",
{
"maxLengthdescription": 36,
"Documento de identificación de la persona titular de la tarjeta (CPF)",
"minLengthtype": 36
"string"
}
},
"required": [
"cardHolder",
"refIdcardNumber",
"document"
]
},
"paymentUrl": {
"language": {
"description": "Este campo es obligatorio cuando es un pago fraccionado",
"type": "objectstring",
"properties": {
},
"refIdpaymentValue": {
"type": "stringinteger",
},
"formatinterest": "uuid",{
"maxLengthdescription": 36,
"Es la diferencia entre paymentValue menos value",
"minLengthtype": 36
"integer"
}
},
"required": [
"refId"
]
}orderId",
"activetransactionId": {
,
"type": "boolean"establishmentCode",
}"paymentMethodCode",
}"value",
"requiredvalueDiscount": [,
"addressTypeinstallments",
"streetstatus",
"outdoorNumberauthorization",
"interiorNumberoperatorTransactionCode",
"neighborhoodoperatorApprovalDate",
"cityreceipt",
"postalCodensu",
"countypaymentUrl",
]
"contact",
"phone}
]
},
"splitPayment": {
"description": "Indicador de que la información es parte de un pago realizado con 2 tarjetas",
"type": boolean,
"phone2example",: true
},
"mixedBundling": {
"position"description": "Indicador de que el pago es fraccionado",
"officeHourstype": boolean,
"example": true
},
"emailmultipleBusinesses",: {
"timeZone",
"description": "Indicador de que el pago es parte de una compra multi-sello",
"languagetype": boolean,
"activeexample"
]
: false
}
},
"required": [
"external",
"paymentDate",
"addressparentGuardian",
"paymentMethod",
]"price",
"originalPrice",
"taxes",
}"taxRate",
]"itemList",
"freight",
}"addressList",
"transactioninvoiceData": {,
"typetransaction":,
"objectsplitPayment",
"propertiesmixedBundling": {,
"multipleBusinesses"
]
"transactionId} |
| Code Block |
|---|
| language | js |
|---|
| title | Ejemplo - Pago por paquete |
|---|
| collapse | true |
|---|
| {
"external": {
"orderId": "type"9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
"collectionOrderId": "integer"9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
}"consolidatorOrderId": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
"establishmentCode"totalValue": {1118.5200,
"orderCount": 1
},
"typepaymentDate": "integer"
},
"paymentMethodCode2023-06-07T16:21:38+00:00",
"parentGuardian": {
"refId": "type"00000000-0000-1000-0000-000012282310",
"document": "integer"
03915826588"
},
"value": {
"type": "integer"
},
"valueDiscount": {
"type": "integer"
},
"installments": {
"type": "integer"
},
"status": {
"type": "integer"
},
"authorization": {
"type": "string"
},
"operatorTransactionCode": {
"type": "string"
},
"operatorApprovalDate": {
"type": "string"
},
"receipt": {
"type": "string"
},
"nsu": {
"type": "string"
},
"message": {
"type": "string"
},
"card": {
"type": "string"
},
"paymentUrl": {
"type": "string"
},
"paymentValue": {
"type": "integer"
},
"interest": {
"description": "Es la diferencia entre paymentValue menos value"
"type": "integer"
}
},
"required": [
"transactionId",
"establishmentCode",
"paymentMethodCode",
"value",
"valueDiscount",
"installments",
"status",
"authorization",
"operatorTransactionCode",
"operatorApprovalDate",
"receipt",
"nsu",
"message",
"card",
"paymentUrl",
"paymentValue",
"interest"
]
}
},
"required": [
"external",
"paymentDate",
"parentGuardian",
"paymentMethod",
"price",
"originalPrice",
"itemList",
"freight",
"addressList",
"transaction"
]
} | | Code Block |
|---|
| language | js |
|---|
| title | Ejemplo - Pago por paquete |
|---|
| collapse | true |
|---|
| {
"external": {
"orderId": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
"collectionOrderId": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
"consolidatorOrderId": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5"
},
"paymentDate": "2023-06-07T16:21:38+00:00",
"parentGuardian": {
"paymentMethod": "TCV",
"conciliationAccount": "YAPY",
"price": 1118.5200,
"originalPrice": 4406.8000,
"discountList": [
{
"rate": 74.6183,
"amount": 3288.2800
}
],
"itemList": [
{
"articleRefId": "00000000-0000-1000-0000-000000118094",
"student": {
"refId": "00000000-0000-1000-0000-000020096053",
"personRefId": "00000000-0000-1000-0000-000012271661"
},
"totalItem": 1,
"price": 559.2617,
"originalPrice": 2203.3980,
"discountList": [
{
"rate": 23.7097,
"reason": "COM",
"amount": 522.4191
},
{
"rate": 36.7300,
"reason": "FFS",
"amount": 1121.7172
},
{
"rate": 25.0000,
"reason": "IT",
"amount": 1121.7172
}
],
"taxes": 0.0000,
"taxRate": 0.0000,
"salesType": "VENTA",
"salesChannel": "ALU",
"installments": 1
},
{
"articleRefId": "00000000-0000-1000-0000-000000118095",
"student": {
"refId": "00000000-0000-1000-0000-000020096149",
"personRefId": "00000000-0000-1000-0000-000012271845"
},
"totalItem": 1,
"price": 559.2617,
"originalPrice": 2203.398,
"discountList": [
{
"rate": 23.7097,
"reason": "COM",
"amount": 522.4191
},
{
"rate": 66.7300,
"reason": "HP",
"amount": 1121.7172
}
],
"taxes": 0.0000,
"taxRate": 0.0000,
"salesType": "VENTA",
"salesChannel": "ALU",
"installments": 1
}
],
"freight": {
"transportName": "",
"transportPhone": "",
"transportCode": "",
"orderNote": "",
"orderFreightValue": 0,
"orderDeliveryForecast": "dd/mm/yyyy",
"orderEstablishment": ""
},
"addressList": [
{
"address": {
"addressType": "Physical",
"street": "Rua Gavião Peixoto",
"outdoorNumber": "313",
"interiorNumber": "",
"neighborhood": "Icaraí",
"city": "RIO DE JANEIRO",
"postalCode": "24230092",
"county": {
"refId": "00000000-0000-1000-0000-000012282310000000020226",
"documentcountyCode": "03915826588BE402DF"
},
"paymentMethodcontact": "TCVAlfredo Pai",
"conciliationAccountphone": "YAPY",
"pricephone2": 1118.5200,
"originalPrice": 4406.8000,
"discountList": [
{
"12345678901",
"position": "Contacto Principal",
"rateofficeHours": 74.6183"",
"amountemail": 3288.2800"test@test.com",
}
],
"itemListtimeZone": [{
{
"articleRefIdrefId": "00000000-0000-1000-0000-000000118094"000000000028"
},
"studentlanguage": {
"refId": "00000000-0000-1000-0000-000020096053"000000000017"
},
"personRefIdactive": "00000000-0000-1000-0000-000012271661"
true
}
},
{
"totalItemaddress": 1,{
"priceaddressType": 559.2617"Mailing",
"originalPricestreet": 2203.398 "Rua Gavião Peixoto",
"discountListoutdoorNumber": [
{
"313",
"rateinteriorNumber": 23.7097"",
"reasonneighborhood": "COMIcaraí",
"amountcity": 522.4191
} "RIO DE JANEIRO",
{
"postalCode": "24230092",
"ratecounty": 66.73,{
"reasonrefId": "FFS00000000-0000-1000-0000-000000020226",
"amountcountyCode": 1121.7172"BE402DF"
},
]"contact": "Alfredo Pai",
"taxesphone": 0.0000"",
"taxRatephone2": 0.0000"12345678901",
"salesTypeposition": "VENTAContacto Principal",
"salesChannelofficeHours": "ALU",
"installmentsemail": 1"test@test.com",
}, "timeZone": {
{
"articleRefIdrefId": "00000000-0000-1000-0000-000000118095"000000000028"
},
"studentlanguage": {
"refId": "00000000-0000-1000-0000-000020096149"000000000017"
},
"personRefId"active": true
}
}
],
"invoiceData": {
"name": "Alfredo",
"lastName": "00000000-0000-1000-0000-000012271845"
Bernal",
"document": "07319150972",
"isLegalPerson": false
},
"transaction": {
"totalItemorderId": 13511,
"pricetransactionId": 559.2617,20027340,
"originalPriceestablishmentCode": 2203.398,
1627652346504,
"discountListpaymentMethodCode": 190,
[
{
"rate "value": 23.7097,
"reason198055,
"valueDiscount": "COM",
"amount": 522.4191
},
{
"rate": 66.7300,
"reason": "HP",
"amount": 1121.7172
}
],
"taxes": 0.0000,
"taxRate": 0.0000,
"salesType": "VENTA",
"salesChannel": "ALU",
"installments": 1
}
],
"freight": {
"transportName": "",
"transportPhone": "",
"transportCode": "",
"orderNote": "",
"orderFreightValue": 0,
"orderDeliveryForecast": "dd/mm/yyyy",
"orderEstablishment": ""
},
"addressList": [
{
"address": {
"addressType": "Physical",
"street": "Rua Gavião Peixoto",
"outdoorNumber": "313",
"interiorNumber": "",
"neighborhood": "Icaraí",
"city": "RIO DE JANEIRO",
"postalCode": "24230092",
"county": {
0,
"installments": 2,
"status": 1,
"authorization": "263461",
"operatorTransactionCode": "00",
"operatorApprovalDate": "2023-07-19 11:26:35",
"receipt": "10462307190818157291",
"nsu": "11409373",
"message": "Sucesso.",
"card": {
"cardHolder": "Alfredo Bernal",
"cardNumber": "123456*******7890",
"document": "07319150972"
},
"paymentUrl": "https://api.bempaggo.io/proxy/yapay/checkout/api/v3/transacao/1627652346504/20027340",
"paymentValue": 198055,
"interest": 0
},
"mixedBundling": false,
"splitPayment": false
} |
| Code Block |
|---|
| language | js |
|---|
| title | Ejemplo - Pago fraccionado |
|---|
| collapse | true |
|---|
| {
"external": {
"orderId": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
"collectionOrderId": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
"consolidatorOrderId": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
"totalValue": 1118.5200,
"orderCount": 1
},
"paymentDate": "2023-06-07T16:21:38+00:00",
"parentGuardian": {
"refId": "00000000-0000-1000-0000-000000020226000012431581",
"countyCodedocument": "BE402DF27288324800"
},
"contactpaymentMethod": "Alfredo Pai",
"phone": "",
"phone2": "12345678901PWM",
"positionconciliationAccount": "Contacto Principal",
"officeHoursprice": ""760.73,
"emailoriginalPrice": "test@test760.com"73,
"timeZoneitemList": {[
{
"refIdarticleRefId": "00000000-0000-1000-0000-000000000028"
}000000118090",
"languagestudent": {
"refId": "00000000-0000-1000-0000-000000000017"
}000020700764",
"activepersonRefId": true"00000000-0000-1000-0000-000012147907"
},
},
{"totalItem": 1,
"addressprice": {741.12,
"addressTypeoriginalPrice": "Mailing"741.12,
"streettaxes": "Rua Gavião Peixoto"0.0000,
"outdoorNumbertaxRate": "313"0.0000,
"interiorNumbersalesType": "VENTA",
"neighborhoodsalesChannel": "IcaraíALU",
"citysalesOption": "RIO DE JANEIROOB",
"postalCodeinstallments": "24230092"1,
"countycomponentList": [
{
"refIdarticleRefId": "00000000-0000-1000-0000-000000020226000000094355",
"countyCodetotalItem": "BE402DF"1,
},
"contactprice": "Alfredo Pai"143.2523,
"phoneoriginalPrice": ""219,
"phone2markupRate": "12345678901"20.0000,
"positionpriceWithMarkup": "Contacto Principal"0.0000,
"officeHourstaxes": ""0.0000,
"emailtaxRate": "test@test0.com"0000,
"timeZonediscountList": {[
"refId": "00000000-0000-1000-0000-000000000028"
{
},
"languagerate": {
45.4900,
"refIdreason": "00000000-0000-1000-0000-000000000017"
VEFR",
},
"activeamount": true
119.5477
}
}
],
"transactionsalesTerms": {
"transactionIdfamilyCode": 20027340"idiomas",
"establishmentCodecode": 16276523465041,
"paymentMethodCodegroup": 1902,
"valuedigitalCode": 198055"22006077",
"valueDiscountisExclusive": 0,
"installments": 2,
"statusfalse
}
},
{
"articleRefId": "00000000-0000-1000-0000-00000094584",
"totalItem": 1,
"authorizationprice": "263461",
"operatorTransactionCode66.7202,
"originalPrice": "00"102,
"operatorApprovalDatemarkupRate": "2023-07-19 11:26:35",
"receipt": "10462307190818157291",
"nsu": "11409373",
"message": "Sucesso.",
"cards": "123456*******7890",
"paymentUrl": "https://api.bempaggo.io/proxy/yapay/checkout/api/v3/transacao/1627652346504/20027340",
"paymentValue": 198055,
"interest": 0
}
} | | Code Block |
|---|
| language | js |
|---|
| title | Ejemplo - Pago fraccionado |
|---|
| collapse | true |
|---|
| {
"external": {
"orderId": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
"collectionOrderId": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
"consolidatorOrderId": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5"
},
"paymentDate": "2023-06-07T16:21:38+00:00",
"parentGuardian": {
"refId20.0000,
"priceWithMarkup": 0.0000,
"taxes": 0.0000,
"taxRate": 0.0000,
"discountList": [
{
"rate": 45.4900,
"reason": "VEFR",
"amount": 55.6798
}
],
"salesTerms": {
"familyCode": "idiomas",
"code": 1,
"group": 2,
"digitalCode": "22006077",
"isExclusive": false
}
},
{
"articleRefId": "00000000-0000-1000-0000-000012431581000000094294",
"documenttotalItem": "27288324800"
},
"paymentMethod": "PWM",
"conciliationAccount": "",
"price": 760.73,
"originalPrice": 760.73,
"itemList": [
{
"articleRefId": "00000000-0000-1000-0000-000000118090",
"student": {
"refId": "00000000-0000-1000-0000-000020700764",
"personRefId": "00000000-0000-1000-0000-000012147907"
},
"totalItem": 1,
"price": 741.12,
"originalPrice": 741.12,
"taxes": 0.0000,
"taxRate": 0.0000,
"salesType": "VENTA",
"salesChannel": "ALU",
"salesOption": "OB",
"installments": 1,
"componentList": [1,
"price": 138.6734,
"originalPrice": 212,
"priceWithMarkup": 0.0000,
"markupRate": 20.0000,
"taxes": 0.0000,
"taxRate": 0.0000,
"discountList": [
{
"rate": 45.4900,
"reason": "VEFR",
"amount": 115.7266
}
],
"salesTerms": {
"familyCode": "idiomas",
"code": 1,
"group": 2,
"digitalCode": "22006077",
"isExclusive": false
}
},
{
"articleRefId": "00000000-0000-1000-0000-000000094355000000094344",
"totalItem": 1,
"priceprice": 138.6734,
"originalPrice": 143.2523212,
"originalPricepriceWithMarkup": 2190.0000,
"markupRate": 20.0000,
"taxes": 0.0000,
"taxRate": 0.0000,
"discountList": [
{
"rate": 45.4900,
"reason": "VEFR",
"amount": 119115.54777266
}
],
"salesTerms": {
"familyCode": "idiomas",
"code": 1,
"group": 2,
"digitalCode": "22006077",
"isExclusive": false
}
},
{
"articleRefId": "00000000-0000-1000-0000-00000094584000000094291",
"totalItem": 1,
"price": 66.7202138.6734,
"originalPrice": 212,
"originalPricemarkupRate": 10220.0000,
"markupRatepriceWithMarkup": 200.0000,
"taxes": 0.0000,
"taxRate": 0.0000,
"discountList": [
{
"rate": 45.4900,
"reason": "VEFR",
"amount": 55115.67987266
}
]
},
{
"articleRefIdsalesTerms": "00000000-0000-1000-0000-000000094294",{
"totalItem": 1,
"price": 138.6734,
"originalPrice": 212,
"markupRate": 20.0000,
"taxes": 0.0000,
"taxRate": 0.0000,
"discountList": [ "familyCode": "idiomas",
{
"code": 1,
"rategroup": 45.49002,
"reasondigitalCode": "VEFR22006077",
"amountisExclusive": 115.7266false
}
]
},
{
"articleRefId": "00000000-0000-1000-0000-000000094344000000094604",
"totalItem": 1,
"price": 138115.67341251,
"originalPrice": 212176,
"markupRate": 20,
"priceWithMarkup": 0.0000,
"taxes": 0.0000,
"taxRate": 0.0000,
"discountList": [
{
"rate": 45.490049,
"reason": "VEFR",
"amount": 11596.72660749
}
]
},
{
"articleRefIdsalesTerms": "00000000-0000-1000-0000-000000094291",
"totalItem": 1,
{
"price": 138.6734,
"originalPricefamilyCode": 212"idiomas",
"markupRatecode": 20.00001,
"taxesgroup": 0.00002,
"taxRatedigitalCode": 0.0000"22006077",
"discountListisExclusive": [false
}
{}
]
}
],
"ratefreight": 45.4900,{
"transportName": "",
"transportPhone": "",
"reasontransportCode": "VEFR",
"orderNote": "",
"amountorderFreightValue": 11519.726661,
}
]
"orderDeliveryForecast": "2023-06-07T16:21:38+00:00",
"orderEstablishment": ""
},
"addressList": [
{
"articleRefIdaddress": "00000000-0000-1000-0000-000000094604",
{
"totalItemaddressType": 1"Physical",
"pricestreet": 115.1251 "Rua Gavião Peixoto",
"originalPriceoutdoorNumber": 176"313",
"markupRateinteriorNumber": 20"",
"taxesneighborhood": 0"Icaraí",
"taxRatecity": 0 "RIO DE JANEIRO",
"discountListpostalCode": [
"24230092",
{
"rate"county": 45.49,{
"reasonrefId": "VEFR00000000-0000-1000-0000-000000020226",
"amountcountyCode": 96.0749
"BE402DF"
},
]"contact": "Alfredo Pai",
}
"phone": "",
]"phone2": "12345678901",
}
],
"freightposition": {
"Contacto Principal",
"transportNameofficeHours": "",
"transportPhoneemail": "test@test.com",
"transportCodetimeZone": "",
{
"orderNoterefId": "00000000-0000-1000-0000-000000000028"
},
"orderFreightValuelanguage": 19.61,
{
"orderDeliveryForecastrefId": "2023-06-07T16:21:38+00:00",
"orderEstablishment": ""
},
"addressList": [00000000-0000-1000-0000-000000000017"
},
"active": true
}
},
{
"address": {
"addressType": "PhysicalMailing",
"street": "Rua Gavião Peixoto",
"outdoorNumber": "313",
"interiorNumber": "",
"neighborhood": "Icaraí",
"city": "RIO DE JANEIRO",
"postalCode": "24230092",
"county": {
"refId": "00000000-0000-1000-0000-000000020226",
"countyCode": "BE402DF"
},
"contact": "Alfredo Pai",
"phone": "",
"phone2": "12345678901",
"position": "Contacto Principal",
"officeHours": "",
"email": "test@test.com",
"timeZone": {
"refId": "00000000-0000-1000-0000-000000000028"
},
"language": {
"refId": "00000000-0000-1000-0000-000000000017"
},
"active": true
}
}
],
{
"address": {
"addressType"invoiceData": {
"name": "Alfredo",
"lastName": "Bernal",
"document": "Mailing07319150972",
"isLegalPerson": false
},
"streettransactions": "Rua Gavião Peixoto",
[
{
"orderId": 3511,
"outdoorNumbertransactionId": "313"20027340,
"establishmentCode": 1627652346504,
"interiorNumberpaymentMethodCode": ""190,
"neighborhoodvalue": "Icaraí"198055,
"cityvalueDiscount": "RIO DE JANEIRO"0,
"postalCodeinstallments": "24230092"2,
"countystatus": {1,
"refIdauthorization": "00000000-0000-1000-0000-000000020226263461",
"countyCodeoperatorTransactionCode": "BE402DF"
}00",
"contactoperatorApprovalDate": "Alfredo Pai2023-07-19 11:26:35",
"phonereceipt": "10462307190818157291",
"phone2nsu": "1234567890111409373",
"positionmessage": "Contacto PrincipalSucesso.",
"officeHourscard": "",{
"emailcardHolder": "test@test.comAlfredo Bernal",
"timeZone": {
"cardNumber": "123456*******7890",
"refIddocument": "00000000-0000-1000-0000-00000000002807319150972"
},
"languagepaymentUrl": {
"https://api.bempaggo.io/proxy/yapay/checkout/api/v3/transacao/1627652346504/20027340",
"refIdpaymentValue": "00000000-0000-1000-0000-000000000017"
}198055,
"activeinterest": true0
},
}{
],
"transactionorderId": {3511,
"transactionId": 2002734020027341,
"establishmentCode": 1627652346504,
"paymentMethodCode": 190,
"value": 198055,
"valueDiscount": 0,
0,
"installments": 2,
"status": 1,
"authorization": "263461263462",
"operatorTransactionCode": "00",
"operatorApprovalDate": "2023-07-19 11:26:35",
"receipt": "1046230719081815729110462307190818157292",
"nsu": "1140937311409374",
"message": "Sucesso.",
"card": {
"cardHolder": "Alfredo Bernal",
"cardcardNumber": "123456*******7890",
"document": "07319150972"
},
"paymentUrl": "https://api.bempaggo.io/proxy/yapay/checkout/api/v3/transacao/1627652346504/20027340",
"paymentValue": 198055,
"interest": 0
}
],
"mixedBundling": false,
"splitPayment": false
} |
|
|---|