| 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",
"consolidatorOrderId"
]
},
"paymentDate": {
{
"description": "FechaValor total ende la compra quepor cada seuna realizade ellas pagoempresas",
"type": "string"number,
"formatexclusiveMinimum": "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 0
},
"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": "IdentificadorEs della concentradorcantidad de pago, es el campo parametro en la tabla concentra_pago",
pedidos que conforman la compra",
"type": "string"number,
"minLengthexclusiveMinimum": 0,
"maxLengthexample": 6
2
}
},
"pricerequired": {[
"descriptionorderId": "Precio final a pagar, después de markup, descuentos, impuestos y cargos",
"type": "number",
"exclusiveMinimum": 0,
"consolidatorOrderId",
"totalValue",
"orderCount"
]
},
"originalPricepaymentDate": {
"description": "PrecioFecha inicialen ala pagar,que antesse derealiza markup, descuentos, impuestos y cargosel pago",
"type": "numberstring",
"exclusiveMinimumformat": 0"date-time"
},
"discountListparentGuardian": {
"type": "object",
"descriptionproperties": {
"Lista de descuentos aplicados al total "refId": {
"description": "Id en BDC de la compra,persona sique hayestá másrealizando de 2 descuentos aplicados estos se acumulan en el segundo/último descuentoel pago",
"type": "arraystring",
"uniqueItemsformat": true"uuid",
"minItemsmaxLength": 136,
"maxItems": 2,
"itemsminLength": [ 36
{ },
"typedocument": "object",{
"propertiesdescription": {
"rate": {
"description": "Indica el porcentaje del descuento",
"Documento de identificación de la persona que está realizando el pago (CPF)",
"type": "numberstring",
}
},
"exclusiveMinimumrequired": 0[
"refId",
},
"document"
]
},
"amountpaymentMethod": {
"description": "IndicaIdentificador del método de pago, es el valorcampo correspondienteparametro alen porcentajela deltabla descuentoforma_pago",
"type": "numberstring",
"exclusiveMinimumminLength": 0,
}
"maxLength": 10
},
"requiredconciliationAccount": [ {
"ratedescription",:
"amount"
]
}
]
},
"itemList": {"Identificador del concentrador de pago, es el campo parametro en la tabla concentra_pago",
"descriptiontype": "Lista de paquetes vendidosstring",
"typeminLength": "array"0,
"uniqueItemsmaxLength": 6
true },
"minItemsprice": 1,{
"itemsdescription": [
{
"Precio final a pagar, después de markup, descuentos, impuestos y cargos",
"type": "objectnumber",
"propertiesexclusiveMinimum": {0
},
"articleRefIdoriginalPrice": {
"description": "Id en BDC del artículo/paquete",
Precio inicial a pagar, antes de markup, descuentos, impuestos y cargos",
"type": "stringnumber",
"formatexclusiveMinimum": "uuid",0
},
"maxLengthdiscounts": 36,{
"minLengthdescription": "Descuentos aplicados 36
},
"student": {
en la compra",
"type": "object",
"properties": {
"refIddiscountOne": {
"description": "Id en BDC del alumno",
Concentra el valor acumulado de los descuentos que no sean de tipo PARC",
"type": "stringobject",
"formatproperties": "uuid",
"maxLength": 36,
{
"minLengthamount": 36
},
"personRefId": {
{
"description": "IdEs el envalor BDCacumulado de la persona asociada al alumno los descuentos que no sean de tipo PARC",
"type": "stringnumber",
"formatminimum": 0 "uuid",
"maxLength": 36,
}
},
"minLengthrequired": [ 36
"amount"
}
]
},
"requireddiscountTwo": [{
"refId",
"personRefId"
]
},
"totalItem": {
"description": "Cantidad vendida del artículo/paquete",
"description": "Concentra el valor del descuento de tipo PARC",
"type": "integerobject",
"exclusiveMinimumproperties": 0
},{
"priceamount": {
"description": "PrecioEs el finalvalor del artículo/paquete, despuéscorrespondiente al descuento de markup, descuentos, impuestos y cargostipo PARC",
"type": "number",
"exclusiveMinimumminimum": 0
},
"originalPrice": {},
"required": [
"amount"
]
}
]
},
"taxes": {
"description": "Precio inicial del artículo/paquete, antes de markup, descuentos, impuestos y cargosValor total de los impuestos aplicados, correspondiente al porcentaje total de impuestos",
"type": "number",
"exclusiveMinimumminimum": 0
},
"discountListtaxRate": {
"description": "ListaPorcentaje total de descuentosimpuestos 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": "number",
"minimum": 0
},
"itemList": {
"description": "Lista de paquetes vendidos",
"type": "array",
"uniqueItems": true,
"minItems": 1,
"maxItems": 3,
"items": [
{
"type": "object",
"properties": {
"ratearticleRefId": {
"description": "IndicaId elen porcentajeBDC del descuentoartículo/paquete",
"type": "numberstring",
"exclusiveMinimumformat": 0 "uuid",
},
"maxLength": 36,
"reasonminLength": { 36
},
"descriptionstudent": "Identificador de la razón del descuento, es el campo parametro en la tabla razon",
{
"type": "stringobject",
"minLengthproperties": 0,{
"maxLengthrefId": 16 {
},
"description": "Id en BDC del alumno",
"amounttype": {
"string",
"descriptionformat": "Indica el valor correspondiente al porcentaje del descuentouuid",
"typemaxLength": "number"36,
"exclusiveMinimumminLength": 0 36
} ,
}, "personRefId": {
"requireddescription": [ "Id en BDC de la persona asociada al alumno",
"rate"type": "string",
"reason"format": "uuid",
"amountmaxLength": 36,
]"minLength": 36
}
] },
},
"taxesrequired": {[
"description": "Valor de los impuestos aplicados al artículo/paquete, correspondiente al porcentaje de impuestos",
refId",
"typepersonRefId":
"integer",
"minimum": 0]
},
"taxRatetotalItem": {
"description": "PorcentajeCantidad devendida impuestosdel aplicados al artículo/paquete",
"type": "integer",
"minimumexclusiveMinimum": 0
},
"salesTypeprice": {
"description": "IdentificadorPrecio final del tipoartículo/paquete, después de ventamarkup, esdescuentos, elimpuestos campo parametro en la tabla tipo_ventay cargos",
"type": "stringnumber",
"minLengthexclusiveMinimum": 0,
"maxLength": 14
},
"salesChanneloriginalPrice": {
"description": "IdentificadorPrecio inicial del canalartículo/paquete, antes de ventamarkup, esdescuentos, elimpuestos campo parametro en la tabla canal_ventay cargos",
"type": "stringnumber",
"minLengthexclusiveMinimum": 0,
"maxLength": 10
},
"salesOptiondiscountList": {
"description": "IdentificadorLista de ladescuentos opciónaplicados deal ventaartículo/paquete, si eshay elun campodescuento parametrocomercial eneste ladebe tabla opcion_venta",
"type": "string",
"minLength": 0,
"maxLength": 3
},
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",
"componentListuniqueItems": true, {
"descriptionminItems": "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",
1,
"typemaxItems": "array"3,
"items": [
{
"type": "object",
"properties": {
"articleRefIdrate": {
"description": "IdIndica enel BDCporcentaje del artículo/componentedescuento",
"type": "stringnumber",
"formatexclusiveMinimum": 0 "uuid",
"maxLength": 36,
},
"minLengthreason": { 36
},
"totalItem": {"description": "Identificador de la razón del descuento, es el campo parametro en la tabla razon",
"descriptiontype": "Cantidad vendida del artículo/paquetestring",
"typeminLength": "integer"0,
"exclusiveMinimummaxLength": 16 0
},
"priceamount": {
"description": "PrecioIndica finalel del artículo/componente, después de markup, descuentos, impuestos y cargos",
valor correspondiente al porcentaje del descuento",
"type": "number",
"exclusiveMinimum": 0
},
"originalPrice": {
},
"descriptionrequired": "Precio inicial del artículo/paquete, antes de markup, descuentos, impuestos y cargos",
[
"typerate":, "number",
"exclusiveMinimumreason":, 0
},
"markupRate": {"amount"
"description": "",]
"type": "number",}
"minimum": 0
]
},
"taxes": {
"description": "Valor de los impuestos aplicados al artículo/componentepaquete, correspondiente al porcentaje de impuestos",
"type": "numberinteger",
"minimum": 0
},
"taxRate": {
"description": "Porcentaje de impuestos aplicados al artículo/componentepaquete",
"type": "numberinteger",
"minimum": 0
},
"discountListsalesType": {
"description": "ListaIdentificador dedel descuentostipo aplicados al artículo/componentede venta, soloes puedeel indicarsecampo elparametro tipoen dela descuentotabla por tipo_venta fraccionada",
"type": "arraystring",
"uniqueItemsminLength": true0,
"minItemsmaxLength": 1,14
},
"maxItemssalesChannel": 1,
{
"itemsdescription": "Identificador [
{del canal de venta, es el campo parametro en la tabla canal_venta",
"type": "objectstring",
"minLength": 0,
"propertiesmaxLength": {10
},
"ratesalesOption": {
"description": "Indica el porcentaje del descuento",
Identificador de la opción de venta, es el campo parametro en la tabla opcion_venta",
"type": "numberstring",
"exclusiveMinimumminLength": 0,
"maxLength": 3
},
"reason""componentList": {
"description": "IdentificadorLista de la razón del descuento, es el campo parametro en la tabla razon, al ser venta fraccionada solo se acepta el valor VEFR 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",
"typeitems": "string",
[
{
"maxLengthtype": 4"object",
"minLength"properties": 4{
},
"amount"articleRefId": {
"description": "IndicaId el valor correspondiente al porcentajeen BDC del descuentoartículo/componente",
"type": "numberstring",
"exclusiveMinimumformat": 0"uuid",
"maxLength": 36,
}
"minLength": 36
},
"requiredtotalItem": [{
"rate"description": "Cantidad vendida del artículo/paquete",
"reason"type": "integer",
"amountexclusiveMinimum": 0
]},
}"price": {
]
},
"description": "Precio final del artículo/componente, después de markup, descuentos, impuestos y cargos",
"salesTermstype": {"number",
"typeexclusiveMinimum": "object",0
"properties": {
},
"familyCodeoriginalPrice": {
"description": "CódigoPrecio dainicial Família do Produto | Lista na plataforma | Código da categoria",
del artículo/componente, antes de markup, descuentos, impuestos y cargos",
"type": "stringnumber",
"exampleexclusiveMinimum": "idiomas"0
},
"codemarkupRate": {
"description": "El indicador del tipo de 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",
"type": "number",
"exampleminimum": 10
},
"grouppriceWithMarkup": {
"description": "1-Avulso, 2-AgrupadoValor del precio inicial del articulo/componente, después del markup",
""type": "number",
"exampleminimum": 10
},
"digitalCodetaxes": {
"description": "CódigoValor de ERPlos doimpuestos produtoaplicados digital | Caso o group == 2al artículo/componente, correspondiente al porcentaje de impuestos",
"type": "stringnumber",
"exampleminimum": "22006077"0
},
"isExclusivetaxRate": {
"description": "ItemPorcentaje exclusivo:de falseimpuestos -aplicados Não exclusivo, true - exclusivoal artículo/componente",
"type": "booleannumber",
"exampleminimum": true0
}
},
"requireddiscountList": [{
"description"familyCode",
: "Lista de descuentos aplicados al artículo/componente, solo puede indicarse el tipo de descuento por venta fraccionada",
"code "type": "array",
"groupuniqueItems": true,
"digitalCodeminItems": 1,
"isExclusivemaxItems": 1,
]"items": [
}
{
},
"requiredtype": [
"object",
"articleRefIdproperties",: {
"totalItem",
"rate": {
"price",
"originalPrice"description": "Indica el porcentaje del descuento",
"markupRate",
"taxes",
"taxRate",
"type": "number",
"discountList",
"salesTermsexclusiveMinimum": 0
]
},
]
}
},
"requiredreason": [{
"articleRefId",
"student",
"totalItemdescription",
"price",
"originalPrice",
"taxes",
"taxRate",
: "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",
"salesType",
"salesChanneltype": "string",
"salesOption",
"componentListmaxLength": 4,
]
}
]
},
"freightminLength": {4
"type": "object",
"properties": {
"transportName": {
"type": "string"
},
},
"transportPhone": {
"typeamount": "string"{
},
"transportCode": {
"typedescription": "string"
Indica el valor correspondiente al porcentaje del descuento",
},
"orderNote": {
"type": "stringnumber",
},
"orderFreightValueexclusiveMinimum": {0
"type": "number"
},
"orderDeliveryForecast": {
"type": "string"
},
"orderEstablishmentrequired": {[
"type": "string" "rate",
}
},
"required": [
"transportNamereason",
"transportPhone",
"amount"
"transportCode",
]
"orderNote",
"orderFreightValue",}
"orderDeliveryForecast",
"orderEstablishment"
]
},
"addressListsalesTerms": {
"description "type": "Lista de domicilios asociados a la persona que realiza el pagoobject",
"type "properties": "array",
{
"uniqueItems": true,
"minItems": 2,
"maxItemsfamilyCode": 3,{
"items": [
{
"typedescription": "objectCódigo da Família do Produto | Lista na plataforma | Código da categoria",
"propertiestype": {"string",
"address": {
"typeexample": "objectidiomas",
"properties": {
},
"addressTypecode": {
"description": "IndicadorEl indicador del tipo de domicilioartículo/componente, solo puede tener solo 3 valores (Physical, Mailing, Shipping)",
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",
"type": "stringnumber",
"maxLengthexample": 7,1
"minLength": 8
},
},
"streetgroup": {
"typedescription": "string"
1-Avulso, 2-Agrupado",
},
"outdoorNumbertype": {
"number",
"typeexample": "string"1
},
"interiorNumberdigitalCode": {
"typedescription": "string"Código ERP do produto digital | Caso o group == 2",
},
"neighborhoodtype": {
"string",
"typeexample": "string22006077"
},
"cityisExclusive": {
"typedescription": "string"Item exclusivo: false - Não exclusivo, true - exclusivo",
},
"postalCodetype": {
"boolean",
"typeexample": "string"
true
},
"county": {
},
"typerequired": "object",[
"propertiesfamilyCode":,
{
"refIdcode":,
{
"typegroup": "string",
"format": "uuiddigitalCode",
"maxLengthisExclusive": 36,
"minLength": 36]
},
"countyCode": {
},
"typerequired": "string"[
}"articleRefId",
}"totalItem",
"requiredprice": [,
"refIdoriginalPrice",
"countyCodemarkupRate",
]
"priceWithMarkup",
}"taxes",
"contacttaxRate":,
{
"type": "string"discountList",
},
"phone": {"salesTerms"
"type": "string"]
},
"phone2": {]
"type": "string"
}
},
"positionrequired": {[
"type": "string"articleRefId",
}"student",
"officeHourstotalItem": {
,
"type": "string"price",
}"originalPrice",
"emailtaxes": {
,
"type": "stringtaxRate",
"format": "email"salesType",
}"salesChannel",
"salesOption",
"timeZone": {
componentList"
]
}
]
},
"freight": {
"type": "object",
"properties": {
"refIdtransportName": {
"type": "string",
},
"transportPhone": {
"formattype": "uuidstring",
},
"maxLengthtransportCode": 36,
{
"minLengthtype": 36"string"
},
}"orderNote": {
"type": "string"
},
"requiredorderFreightValue": [{
"refId"
"type": "number"
]
},
"languageorderDeliveryForecast": {
"type": "objectstring",
"properties": {
},
"refIdorderEstablishment": {
"type": "string",
}
},
"formatrequired": "uuid",[
"transportName",
"maxLengthtransportPhone": 36,
"transportCode",
"minLengthorderNote": 36,
"orderFreightValue",
}"orderDeliveryForecast",
"orderEstablishment"
]
},
"addressList": {
"description": "Lista de domicilios asociados a la persona que realiza el pago",
"requiredtype": ["array",
"uniqueItems": true,
"refIdminItems": 2,
]
},
"maxItems": 3,
"activeitems": {[
{
"type": "booleanobject",
}"properties": {
},"address": {
"requiredtype": ["object",
"addressTypeproperties",: {
"streetaddressType",: {
"outdoorNumber "description": "Indicador del tipo de domicilio, solo puede tener 3 valores (Physical, Mailing, Shipping)",
"interiorNumber "type": "string",
"neighborhoodmaxLength": 7,
"cityminLength",: 8
"postalCode"},
"countystreet",: {
"contact", "type": "string"
"phone"},
"phone2outdoorNumber",: {
"type": "positionstring",
"officeHours"},
"emailinteriorNumber",: {
"type": "timeZonestring",
"language"},
"activeneighborhood": {
]
}
"type": "string"
},
"requiredcity": [{
"address "type": "string"
]
},
]
},
"invoiceDatapostalCode": {
"type": "object"string"
},
"propertiescounty": {
"nametype": {
"object",
"typeproperties": "string"
},
{
"lastNamerefId": {
"type": "string"
},
"document": {
,
"typeformat": "stringuuid"
},
,
"isLegalPersonmaxLength": {
36,
"typeminLength": "boolean"
}
},
"required": [
"name",
"document",
"isLegalPerson"
]
},
"transaction": {
36
},
"countyCode": {
"type": "objectstring",
"properties": {
"transactionId": {
"type": "integer"
},
"establishmentCode": {
}
},
"required": [
"refId",
"countyCode"
]
},
"contact": {
"type": "integerstring"
},
"paymentMethodCode },
"phone": {
"type": "integerstring"
},
"value"phone2": {
"type": "integerstring"
},
"valueDiscount"position": {
"type": "type": "integer"
},
"installments": {
"string"
},
"officeHours": {
"type": "integerstring"
},
"status "email": {
"type": "integerstring",
},
"authorization": {
"type": "string"
},
"operatorTransactionCode"format": "email"
},
"timeZone": {
"type": "stringobject",
},
"operatorApprovalDateproperties": {
"typerefId": "string"{
},
"receipt": {
"type": "string",
},
"nsu": {
"type": "string"
},
"message": {
"type": "string"
},
"card": {
"format": "uuid",
"maxLength": 36,
"minLength": 36
}
},
"required": [
"refId"
]
},
"language": {
"descriptiontype": "object"Datos de la tarjeta, este campo solo es obligatorio cuando el pago es con tarjeta",
,
"properties": {
"refId": {
"type": "objectstring",
"propertiesformat": {
"uuid",
"cardHolder": {
"descriptionmaxLength": "Nombre del titular de la tarjeta",
36,
"typeminLength": "string"
36
}
},
"required": [
"refId"
]
},
"cardNumberactive": {
"descriptiontype": "boolean"Nú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",
}
},
"required": [
"addressType",
"street",
"outdoorNumber",
"interiorNumber",
"neighborhood",
"city",
"postalCode",
"county",
"contact",
"phone",
"phone2",
"position",
"officeHours",
"email",
"timeZone",
"language",
"active"
]
}
},
"required": [
"address"
]
}
]
},
"invoiceData": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"lastName": {
"type": "string"
},
"document": {
"type": "string"
},
"isLegalPerson": {
"type": "boolean"
}
},
"required": [
"name",
"document",
"isLegalPerson"
]
},
"transactions": {
"description": "Lista de formas de 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": "array",
"items": [
{
"type": "object",
"properties": {
"orderId": {
"description": "Identificador de la compra del lado del integrador (Venda Bem Pago)",
"type": "string"
},
"transactionId": {
"description": "Identificador de la transacción del lado del integrador (Transaçao Bem Pago)",
"type": "string"
},
"establishmentCode": {
"type": "integer"
},
"paymentMethodCode": {
"type": "integer"
},
"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": {
"description": "Datos de la tarjeta, este campo solo es obligatorio cuando el pago es con tarjeta",
"type": "object",
"properties": {
"cardHolder": {
"description": "Nombre del titular de la tarjeta",
"type": "string"
},
"cardNumber": {
"description": "Nú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",
"examples": ["123456*******7890"],
"type": "string"
},
"document": {
"description": "Documento de identificación de la persona titular de la tarjeta (CPF)",
"type":"string"
}
},
"required": [
"cardHolder",
"cardNumber",
"document"
]
},
"paymentUrl": {
"description": "Este campo es obligatorio cuando es un pago fraccionado",
"type": "string"
},
"paymentValue": {
"type": "integer"
},
"interest": {
"examplesdescription": ["123456*******7890"],
"Es la diferencia entre paymentValue menos value",
"type": "stringinteger"
}
},
"required": [
"orderId",
"transactionId",
"establishmentCode",
"paymentMethodCode",
"value",
"documentvalueDiscount":,
{
"descriptioninstallments": "Documento de identificación de la persona titular de la tarjeta (CPF)",
,
"status",
"typeauthorization": "string"
}
},
,
"operatorTransactionCode",
"operatorApprovalDate",
"requiredreceipt": [
,
"cardHoldernsu",
"cardNumberpaymentUrl",
"document"
]
}
]
},
"paymentUrlsplitPayment": {
"description": "EsteIndicador campode esque obligatoriola cuandoinformación es parte de un pago fraccionado",realizado con 2 tarjetas",
"type": boolean,
"example": true
},
"mixedBundling": {
"typedescription": "string"
"Indicador de que el pago }es fraccionado",
"paymentValuetype": {boolean,
"typeexample": "integer"true
},
"interestmultipleBusinesses": {
"description": "Es la diferencia entre paymentValue menos value",
Indicador de que el pago es parte de una compra multi-sello",
"type": boolean,
"integerexample": false
}
},
"required": [
"external",
"paymentDate",
"parentGuardian",
"paymentMethod",
}"price",
"originalPrice",
"taxes",
"taxRate",
"requireditemList": [
,
"freight",
"transactionIdaddressList",
"establishmentCodeinvoiceData",
"paymentMethodCodetransaction",
"valuesplitPayment",
"valueDiscountmixedBundling",
"multipleBusinesses"
]
} |
| Code Block |
|---|
| language | js |
|---|
| title | Ejemplo - Pago por paquete |
|---|
| collapse | true |
|---|
| {
"external": {
"orderId": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
"installmentscollectionOrderId",
: "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
"status",
"authorization",
"operatorTransactionCode",
"operatorApprovalDate",
"receipt",
"nsu",
"paymentUrl"
]
},
"splitPayment": {
"description": "Indicador de que la información es parte de un pago realizado con 2 tarjetas",
"type": boolean,
"example": true
},
"mixedBundling": {
"description": "Indicador de que el pago es fraccionado",
"type": boolean,
"example": true
},
},
"requiredconsolidatorOrderId": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
"totalValue": 1118.5200,
"orderCount": 1
},
"paymentDate": "2023-06-07T16:21:38+00:00",
"parentGuardian": {
"refId": "00000000-0000-1000-0000-000012282310",
"document": "03915826588"
},
"paymentMethod": "TCV",
"conciliationAccount": "YAPY",
"price": 1118.5200,
"originalPrice": 4406.8000,
"discountList": [
{
"rate": 74.6183,
"amount": 3288.2800
}
],
"itemList": [
"external",{
"paymentDatearticleRefId",: "parentGuardian"00000000-0000-1000-0000-000000118094",
"paymentMethodstudent",: {
"pricerefId",: "originalPrice"00000000-0000-1000-0000-000020096053",
"itemListpersonRefId",: "freight",
"addressList""00000000-0000-1000-0000-000012271661"
},
"invoiceDatatotalItem": 1,
"transactionprice": 559.2617,
"splitPaymentoriginalPrice": 2203.3980,
"mixedBundlingdiscountList": [
]
} | | 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": {
"refId": "00000000-0000-1000-0000-000012282310",
"document": "03915826588"
},
"paymentMethod": "TCV",
"conciliationAccount": "YAPY",
"price": 1118.5200,
"originalPrice": 4406.8000,
"discountList": [
{
"rate": 74.6183,
"amount": 3288.2800
}
],
"itemList": [
{
"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-000000118094000000118095",
"student": {
"refId": "00000000-0000-1000-0000-000020096053000020096149",
"personRefId": "00000000-0000-1000-0000-000012271661000012271845"
},
"totalItem": 1,
"price": 559.2617,
"originalPrice": 2203.398,
"discountList": [
{
"rate": 23.7097,
"reason": "COM",
"amount": 522.4191
},
{
"rate": 66.737300,
"reason": "FFSHP",
"amount": 1121.7172
}
],
"taxes": 0.0000,
"taxRate": 0.0000,
"salesType": "VENTA",
"salesChannel": "ALU",
"installments": 1
}
],
"freight": {
"transportName": "",
"transportPhone": "ALU",
"installmentstransportCode": 1
},
{
"",
"articleRefIdorderNote": "00000000-0000-1000-0000-000000118095",
"studentorderFreightValue": {0,
"refIdorderDeliveryForecast": "00000000-0000-1000-0000-000020096149dd/mm/yyyy",
"personRefIdorderEstablishment": "00000000-0000-1000-0000-000012271845"
},
},"addressList": [
{
"totalItemaddress": 1,{
"priceaddressType": 559.2617"Physical",
"originalPricestreet": 2203.398 "Rua Gavião Peixoto",
"discountListoutdoorNumber": ["313",
{
"interiorNumber": "",
"rateneighborhood": 23.7097"Icaraí",
"reasoncity": "COMRIO DE JANEIRO",
"amountpostalCode": 522.4191
},
{
"24230092",
"ratecounty": 66.7300,{
"reasonrefId": "HP00000000-0000-1000-0000-000000020226",
"amountcountyCode": 1121.7172"BE402DF"
},
],
"taxescontact": 0.0000"Alfredo Pai",
"taxRatephone": 0.0000"",
"salesTypephone2": "VENTA12345678901",
"salesChannelposition": "ALUContacto Principal",
"installmentsofficeHours": 1"",
}
],
"freightemail": { "transportName": ""test@test.com",
"transportPhonetimeZone": "",
{
"transportCoderefId": "",
"orderNote": "",
00000000-0000-1000-0000-000000000028"
},
"orderFreightValuelanguage": 0,{
"orderDeliveryForecastrefId": "dd/mm/yyyy",
00000000-0000-1000-0000-000000000017"
},
"orderEstablishmentactive": ""true
},
"addressList": [
},
{
"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
}
}
],
{ "addressinvoiceData": {
"addressTypename": "MailingAlfredo",
"street": "Rua Gavião Peixoto", "outdoorNumberlastName": "313Bernal",
"interiorNumber": "",
"neighborhood
"document": "Icaraí07319150972",
"cityisLegalPerson": "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
}
}
],
"invoiceData": {
"name": "Alfredofalse
},
"transaction": {
"orderId": 3511,
"transactionId": 20027340,
"establishmentCode": 1627652346504,
"paymentMethodCode": 190,
"value": 198055,
"valueDiscount": 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",
"lastNamecardNumber": "Bernal123456*******7890",
"document": "07319150972"
},
"isLegalPerson"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 |
|---|
| {
"transactionexternal": {
"transactionIdorderId": 20027340,
"9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
"establishmentCodecollectionOrderId": 1627652346504"9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
"paymentMethodCodeconsolidatorOrderId": 190"9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
"valuetotalValue": 1980551118.5200,
"valueDiscountorderCount": 0,
1
},
"installmentspaymentDate": 2,
"2023-06-07T16:21:38+00:00",
"statusparentGuardian": 1,
{
"authorizationrefId": "263461",
"operatorTransactionCode00000000-0000-1000-0000-000012431581",
"document": "0027288324800",
},
"operatorApprovalDatepaymentMethod": "2023-07-19 11:26:35PWM",
"receiptconciliationAccount": "10462307190818157291",
"nsuprice": "11409373",
760.73,
"messageoriginalPrice": "Sucesso760."73,
"carditemList": [
{
"cardHolderarticleRefId": "Alfredo Bernal00000000-0000-1000-0000-000000118090",
"student": {
"cardNumberrefId": "123456*******7890",
00000000-0000-1000-0000-000020700764",
"documentpersonRefId": "07319150972"
00000000-0000-1000-0000-000012147907"
},
"paymentUrltotalItem": "https://api.bempaggo.io/proxy/yapay/checkout/api/v3/transacao/1627652346504/20027340"1,
"paymentValueprice": 198055741.12,
"interestoriginalPrice": 0741.12,
},
"mixedBundlingtaxes": false0.0000,
"splitPayment "taxRate": false
} | | Code Block |
|---|
| language | js |
|---|
| title | Ejemplo - Pago fraccionado |
|---|
| collapse | true |
|---|
| {
"external": {
0.0000,
"orderIdsalesType": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5VENTA",
"collectionOrderIdsalesChannel": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5ALU",
"consolidatorOrderIdsalesOption": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5"
},
"paymentDate": "2023-06-07T16:21:38+00:00",
"parentGuardian": {
"refIdOB",
"installments": 1,
"componentList": [
{
"articleRefId": "00000000-0000-1000-0000-000012431581000000094355",
"documenttotalItem": "27288324800"
},
"paymentMethod": "PWM",
"conciliationAccount": "",
"price": 760.73,
"originalPrice": 760.73,
"itemList1,
"price": 143.2523,
"originalPrice": 219,
"markupRate": 20.0000,
"priceWithMarkup": 0.0000,
"taxes": 0.0000,
"taxRate": 0.0000,
"discountList": [
{
"articleRefIdrate": "00000000-0000-1000-0000-000000118090"45.4900,
"student": {
"refIdreason": "00000000-0000-1000-0000-000020700764VEFR",
"personRefIdamount": "00000000-0000-1000-0000-000012147907"
119.5477
},
"totalItem": 1 ],
"pricesalesTerms": 741.12,{
"originalPrice": 741.12,
"taxesfamilyCode": 0.0000"idiomas",
"taxRate": 0.0000,
"salesTypecode": "VENTA"1,
"salesChannelgroup": "ALU"2,
"salesOptiondigitalCode": "OB22006077",
"installmentsisExclusive": 1,false
"componentList": [}
},
{
"articleRefId": "00000000-0000-1000-0000-00000009435500000094584",
"totalItem": 1,
"price": 14366.25237202,
"originalPrice": 219102,
"markupRate": 20.0000,
"priceWithMarkup": 0.0000,
"taxes": 0.0000,
"taxRate": 0.0000,
"discountList": [
{
"rate": 45.4900,
"reason": "VEFR",
"amount": 11955.54776798
}
],
"salesTerms": {
"familyCode": "idiomas",
"code": 1,
"group": 2,
"digitalCode": "22006077",
"isExclusive": false
}
},
{
"articleRefId": "00000000-0000-1000-0000-00000094584000000094294",
"totalItem": 1,
"price": 66138.72026734,
"originalPrice": 102212,
"priceWithMarkup": 0.0000,
"markupRate": 20.0000,
"taxes": 0.0000,
"taxRate": 0.0000,
"discountList": [
{
"rate": 45.4900,
"reason": "VEFR",
"amount": 55115.67987266
}
],
"salesTerms": {
"familyCode": "idiomas",
"code": 1,
"group": 2,
"digitalCode": "22006077",
"isExclusive": false
}
},
{
"articleRefId": "00000000-0000-1000-0000-000000094294000000094344",
"totalItem": 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-000000094344000000094291",
"totalItem": 1,
"price": 138.6734,
"originalPrice": 212": 212,
"markupRate": 20.0000,
"markupRatepriceWithMarkup": 200.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-000000094291000000094604",
"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
}
],
"salesTerms": {
"familyCode": "idiomas",
"code": 1,
"group": 2,
"digitalCode": "22006077",
"isExclusive": false
}
},
]
{}
],
"freight": {
"articleRefIdtransportName": "00000000-0000-1000-0000-000000094604",
"transportPhone": "",
"totalItemtransportCode": 1"",
"orderNote": "",
"priceorderFreightValue": 11519.125161,
"orderDeliveryForecast": "2023-06-07T16:21:38+00:00",
"orderEstablishment": ""
},
"originalPriceaddressList": 176,[
{
"markupRateaddress": 20,{
"taxesaddressType": 0"Physical",
"taxRatestreet": 0 "Rua Gavião Peixoto",
"discountListoutdoorNumber": ["313",
{
"rate"interiorNumber": 45.49"",
"reasonneighborhood": "VEFRIcaraí",
"amountcity": 96.0749"RIO DE JANEIRO",
}
],
"postalCode": "24230092",
"salesTermscounty": {
"familyCoderefId": "idiomas00000000-0000-1000-0000-000000020226",
"codecountyCode": 1,
"BE402DF"
},
"groupcontact": "Alfredo 2Pai",
"digitalCodephone": "22006077",
"isExclusivephone2": false"12345678901",
}
}
]"position": "Contacto Principal",
}
],
"freightofficeHours": {"",
"transportNameemail": "test@test.com",
"transportPhonetimeZone": "",
{
"transportCoderefId": "",
"orderNote": "",
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
}
}
],
{ "addressinvoiceData": {
"addressTypename": "MailingAlfredo",
"street": "Rua Gavião Peixoto", "outdoorNumberlastName": "313Bernal",
"interiorNumber": "",
"neighborhood
"document": "Icaraí07319150972",
"city": "RIO DE JANEIRO", "postalCodeisLegalPerson": "24230092",
"county": {
"refId": "00000000-0000-1000-0000-000000020226",
false
},
"transactions": [
{
"countyCodeorderId": 3511,
"BE402DFtransactionId": 20027340,
}"establishmentCode": 1627652346504,
"contactpaymentMethodCode": "Alfredo Pai"190,
"phonevalue": ""198055,
"phone2valueDiscount": "12345678901"0,
"positioninstallments": "Contacto Principal"2,
"officeHoursstatus": ""1,
"emailauthorization": "test@test.com263461",
"timeZoneoperatorTransactionCode": {
"00",
"refIdoperatorApprovalDate": "000000002023-0000-1000-0000-000000000028"
},
07-19 11:26:35",
"languagereceipt": {
"10462307190818157291",
"refIdnsu": "00000000-0000-1000-0000-000000000017"
}11409373",
"activemessage": true"Sucesso.",
}"card": {
}
],
"invoiceDatacardHolder": {"Alfredo Bernal",
"namecardNumber": "Alfredo123456*******7890",
"lastNamedocument": "Bernal07319150972"
},
"documentpaymentUrl": "07319150972https://api.bempaggo.io/proxy/yapay/checkout/api/v3/transacao/1627652346504/20027340",
"paymentValue": 198055,
"isLegalPersoninterest": false
0
},
{
"transactionorderId": {3511,
"transactionId": 2002734020027341,
"establishmentCode": 1627652346504,
"paymentMethodCode": 190,
"value": 198055,
"valueDiscount": 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",
"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
} |
|
|---|