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",
,
"consolidatorOrderId",
"type": "numbertotalValue",
"exclusiveMinimumorderCount":
0 ]
},
"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 descuento",
el 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",
"exclusiveMinimum": 0
},
"discounts": {
"formatdescription": "uuidDescuentos aplicados en la compra",
"maxLengthtype": 36"object",
"minLengthproperties": 36{
},
"discountOne": {
"studentdescription": {
"Concentra el valor acumulado de los descuentos que no sean de tipo PARC",
"type": "object",
"properties": {
"refIdamount": {
"description": "IdEs enel BDC del alumnovalor acumulado de los descuentos que no sean de tipo PARC",
"type": "stringnumber",
"formatminimum": "uuid",
0
}
},
"maxLengthrequired": [ 36,
"minLengthamount": 36
]
},
"personRefIddiscountTwo": {
"description": "IdConcentra enel BDCvalor dedel ladescuento personade asociadatipo al alumnoPARC",
"type": "stringobject",
"formatproperties": { "uuid",
"maxLengthamount": { 36,
"minLengthdescription": "Es 36
el valor correspondiente al descuento de tipo PARC",
}"type": "number",
},"minimum": 0
"required":} [
},
"refId",
required": [
"personRefIdamount"
]
},
]
},
"totalItemtaxes": {
"description": "Cantidad vendida del artículo/paquete",
Valor total de los impuestos aplicados, correspondiente al porcentaje total de impuestos",
"type": "integernumber",
"exclusiveMinimumminimum": 0
},
"pricetaxRate": {
""description": "PrecioPorcentaje final del artículo/paquete, después de markup, descuentos, impuestos y cargostotal de impuestos aplicados",
"type": "number",
"exclusiveMinimumminimum": 0
},
"originalPriceitemList": {
"description": "Precio inicial del artículo/paquete, antesLista de markup,paquetes descuentosvendidos",
impuestos y cargos "type": "array",
"uniqueItems": true,
"typeminItems": 1,
"numberitems",: [
{
"exclusiveMinimumtype": 0"object",
},"properties": {
"discountListarticleRefId": {
"description": "ListaId deen descuentosBDC aplicados aldel 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": "arraystring",
"uniqueItemsformat": true"uuid",
"minItemsmaxLength": 136,
"maxItemsminLength": 3, 36
"items": [ },
{
"student": {
"type": "object",
"properties": {
"raterefId": {
"description": "IndicaId elen porcentajeBDC del descuentoalumno",
"type": "numberstring",
"format": "uuid",
"exclusiveMinimummaxLength": 0
36,
"minLength": 36
},
"reasonpersonRefId": {
"description": "IdentificadorId en BDC de la razónpersona delasociada descuento, es el campo parametro en la tabla razonal alumno",
"type": "string",
"minLengthformat": 0"uuid",
"maxLength": 16 36,
},
"minLength": 36
}
"amount": {
},
"descriptionrequired": "Indica el valor correspondiente al porcentaje del descuento",
[
"type": "number"refId",
"exclusiveMinimumpersonRefId":
0
}
]
},
"requiredtotalItem": [ {
"rate",
"reason",
"description": "Cantidad vendida del artículo/paquete",
"amounttype": "integer",
]
}
] "exclusiveMinimum": 0
},
"taxesprice": {
"description": "ValorPrecio definal los impuestos aplicados al del artículo/paquete, correspondientedespués alde porcentajemarkup, dedescuentos, impuestos y cargos",
"type": "integernumber",
"minimumexclusiveMinimum": 0
},
"taxRateoriginalPrice": {
"description": "PorcentajePrecio inicial del artículo/paquete, antes de markup, descuentos, impuestos aplicados al artículo/paquetey cargos",
"type": "integernumber",
"minimumexclusiveMinimum": 0
},
"salesTypediscountList": {
"description": "IdentificadorLista de deldescuentos tipoaplicados deal ventaartículo/paquete, essi hay elun campodescuento parametrocomercial eneste ladebe 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",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": "stringarray",
"minLengthuniqueItems": 0true,
"maxLengthminItems": 101,
}"maxItems": 3,
"salesOptionitems": [
{
"descriptiontype": "object"Identificador, de la opción de venta, es el campo parametro en la tabla opcion_venta",
"properties": {
"rate": {
"description": "Indica el porcentaje del descuento",
"type": "stringnumber",
"minLengthexclusiveMinimum": 0,
"maxLength": 3
},
},
"componentListreason": {
"description": "ListaIdentificador de los artículos/componentes que forman partela razón del artículo/paquete vendidosdescuento, estees atributoel solocampo debeparametro estaren presentela cuando es un pago de una venta fraccionadatabla razon",
"type": "arraystring",
"itemsminLength": [
0,
{
"typemaxLength": 16 "object",
"properties": {},
"articleRefIdamount": {
"description": "Id en BDCIndica el valor correspondiente al porcentaje del artículo/componentedescuento",
"type": "stringnumber",
"formatexclusiveMinimum": 0 "uuid",
"maxLength": 36,
}
},
"minLengthrequired": [ 36
}"rate",
"totalItemreason":, {
"description": amount"Cantidad vendida del artículo/paquete",
]
"type": "integer", }
"exclusiveMinimum": 0
]
},
"pricetaxes": {
"description": "Precio final delValor de los impuestos aplicados al artículo/componentepaquete, despuéscorrespondiente deal markup,porcentaje descuentos,de impuestos y cargos",
"type": "numberinteger",
"exclusiveMinimumminimum": 0
},
"originalPricetaxRate": {
"description": "Precio inicial delPorcentaje de impuestos aplicados al artículo/paquete, antes de markup, descuentos, impuestos y cargos",
"type": "numberinteger",
"exclusiveMinimumminimum": 0
},
"markupRatesalesType": {
"description": "Identificador del tipo de venta, es el campo parametro en la tabla tipo_venta",
"type": "numberstring",
"minimumminLength": 0,
"maxLength": 14
},
"taxessalesChannel": {
"description": "ValorIdentificador del canal de losventa, impuestoses aplicadosel al artículo/componente, correspondiente al porcentaje de impuestos",
campo parametro en la tabla canal_venta",
"type": "numberstring",
"minimumminLength": 0,
},"maxLength": 10
},
"taxRatesalesOption": {
"description": "PorcentajeIdentificador de la opción de impuestos aplicados al artículo/componente venta, es el campo parametro en la tabla opcion_venta",
"type": "numberstring",
"minimumminLength": 0,
"maxLength": 3
},
"discountListcomponentList": {
"description": "Lista de descuentos aplicados allos artículos/componentes que forman parte del artículo/componente,paquete vendidos, este atributo solo puede indicarse el tipo debe estar presente cuando es un pago de descuento poruna 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": [
"uniqueItems {
"type": true"object",
"minItemsproperties": 1,{
"maxItemsarticleRefId": 1,{
"itemsdescription": ["Id en BDC del artículo/componente",
{
"type": "string",
"typeformat": "objectuuid",
"propertiesmaxLength": {36,
"rateminLength": {36
},
"totalItem": {
"description": "IndicaCantidad el porcentajevendida del descuentoartículo/paquete",
"type": "numberinteger",
"exclusiveMinimum": 0
},
"reasonprice": {
"description": "Identificador de la razónPrecio final del descuentoartículo/componente, esdespués elde campo parametro en la tabla razonmarkup, descuentos, alimpuestos ser venta fraccionada solo se acepta el valor VEFRy cargos",
"type": "stringnumber",
"maxLengthexclusiveMinimum": 4,
0
},
"minLength": 4
},
"amount"originalPrice": {
"description": "Indica el valor correspondiente al porcentaje del descuentoPrecio inicial del artículo/componente, antes de markup, descuentos, impuestos y cargos",
"type": "number",
"exclusiveMinimum": 0
},
},
"markupRate": {
"requireddescription": ["",
"rate"type": "number",
"reasonminimum",: 0
"amount"},
]"priceWithMarkup": {
}
]
},
"description": "Valor del precio inicial del articulo/componente, después del markup",
"salesTermstype": {"number",
"typeminimum": "object",0
"properties": {},
"familyCodetaxes": {
"description": "CódigoValor dade Famílialos doimpuestos Produtoaplicados | Lista na plataforma | Código da categoriaal artículo/componente, correspondiente al porcentaje de impuestos",
"type": "stringnumber",
"exampleminimum": "idiomas"0
}},
"codetaxRate": {
"description": "ElPorcentaje indicadorde delimpuestos tipoaplicados deal 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
},
"groupdiscountList": {
"description": "1-Avulso, 2-Agrupado",
Lista de descuentos aplicados al artículo/componente, solo puede indicarse el tipo de descuento por venta fraccionada",
"type": "numberarray",
"exampleuniqueItems": 1true,
}"minItems": 1,
"digitalCodemaxItems": {1,
"descriptionitems": "Código ERP do produto digital | Caso o group == 2",
[
"type": "number",{
"exampletype": 1"object",
},
"properties": {
"isExclusiverate": {
"description": "ItemIndica exclusivo:el falseporcentaje - Não exclusivo, true - exclusivodel descuento",
"type": "booleannumber",
"exampleexclusiveMinimum": true0
},
},
"required"reason": [{
"familyCode",
"description": "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": "codestring",
"groupmaxLength": 4,
"digitalCodeminLength",: 4
"isExclusive"
},
]
"amount": {
}
"description": "Indica el valor correspondiente al porcentaje del descuento",
},
"requiredtype": [
"number",
"articleRefIdexclusiveMinimum",: 0
"totalItem",
}
"price",
},
"originalPrice",
"markupRaterequired",: [
"taxesrate",
"taxRatereason",
"discountListamount"
]
}
]
}
},
"requiredsalesTerms": [{
"articleRefId "type": "object",
"studentproperties",: {
"totalItem",
"pricefamilyCode",: {
"originalPrice",
"taxes"description": "Código da Família do Produto | Lista na plataforma | Código da categoria",
"taxRate",
"type": "salesTypestring",
"salesChannel",
"salesOption",
example": "idiomas"
"componentList"
]},
}
]
},
"freightcode": {
"type": "object",
"properties": {
"transportName": {
"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": "stringnumber",
},
"transportPhone": {
"typeexample": "string"1
},
"transportCode": {
"type": "string"
},
},
"orderNote": {
"typegroup": "string"{
},
"orderFreightValue": {
"typedescription": "number"1-Avulso, 2-Agrupado",
},
"orderDeliveryForecast": {
"type": "stringnumber",
},
"orderEstablishment": {
"typeexample": "string"1
}
},
"required": [
"transportName"},
"transportPhone",
"transportCode",
"orderNotedigitalCode",: {
"orderFreightValue",
"orderDeliveryForecast",
"description"orderEstablishment: "Código ]
},
"addressList": {
"description": "Lista de domicilios asociados a la persona que realiza el pago"
"type": "array",
"uniqueItems": true,
"minItems": 2,
"maxItems": 3,
"items": [
{
ERP do produto digital | Caso o group == 2",
"type": "string",
"typeexample": "object22006077",
"properties": {
"address": {
},
"type": "object",
"propertiesisExclusive": {
"addressType": {
"description": "Indicador del tipo de domicilio, solo puede tener 3 valores (Physical, Mailing, Shipping)",
Item exclusivo: false - Não exclusivo, true - exclusivo",
"type": "stringboolean",
"maxLengthexample": 7,true
"minLength": 8
}
},
"streetrequired": {[
"type": "string"familyCode",
},
"code",
"outdoorNumber": {
"type": "string"group",
},
"digitalCode",
"interiorNumber": {
"typeisExclusive":
"string"
},
]
"neighborhood": {
"type": "string"
}
},
"cityrequired": {[
"typearticleRefId": "string"
,
}"totalItem",
"postalCodeprice":,
{
"typeoriginalPrice": "string"
,
}"markupRate",
"countypriceWithMarkup":,
{
"type": "objecttaxes",
"propertiestaxRate": {,
"refIddiscountList": {,
"typesalesTerms": "string",
]
"format": "uuid",
}
"maxLength": 36,]
}
},
"minLengthrequired": 36[
"articleRefId",
}"student",
"countyCodetotalItem":,
{
"price",
"type": "string"originalPrice",
"taxes",
}
"taxRate",
}"salesType",
"requiredsalesChannel": [,
"refIdsalesOption",
"countyCodecomponentList"
]
]}
]
},
"freight": {
"type": "object",
"contactproperties": {
"transportName": {
"type": "string"
}},
"phonetransportPhone": {
"type": "string"
},
"phone2transportCode": {
"type": "string"
},
"positionorderNote": {
"type": "string"
},
"officeHoursorderFreightValue": {
"type": "stringnumber"
},
"emailorderDeliveryForecast": {
"type": "string"
},
"orderEstablishment": {
"formattype": "emailstring"
}
},
"timeZonerequired": {[
"transportName",
"type": "objecttransportPhone",
"transportCode",
"propertiesorderNote": {,
"orderFreightValue",
"orderDeliveryForecast",
"refIdorderEstablishment": {
]
},
"addressList": {
"typedescription": "stringLista de domicilios asociados a la persona que realiza el pago",
"format"type": "uuidarray",
"uniqueItems": true,
"minItems": 2,
"maxLengthmaxItems": 363,
"items": [
{
"minLengthtype": 36"object",
"properties": {
}"address": {
}"type": "object",
"requiredproperties": [{
"refIdaddressType"
]: {
},
"languagedescription": { "Indicador del tipo de domicilio, solo puede tener 3 valores (Physical, Mailing, Shipping)",
"type": "objectstring",
"propertiesmaxLength": {7,
"refIdminLength": {8
},
"typestreet": "string",
{
"formattype": "uuidstring",
"maxLength": 36},
"minLengthoutdoorNumber": 36{
}
"type": "string"
},
"requiredinteriorNumber": [{
"refIdtype"
]: "string"
},
"activeneighborhood": {
"type": "booleanstring"
},
},
"city": {
"requiredtype": ["string"
"addressType"},
"streetpostalCode",: {
"outdoorNumber",type": "string"
"interiorNumber"},
"neighborhoodcounty",: {
"city "type": "object",
"postalCodeproperties",: {
"countyrefId",
: {
"type": "contactstring",
"format": "phoneuuid",
"phone2maxLength": 36,
"positionminLength",: 36
"officeHours"},
"emailcountyCode",
: {
"timeZone",
"type": "string"
}
},
"languagerequired",: [
"activerefId",
]
"countyCode"
}]
},
"requiredcontact": [{
"address"type": "string"
]
},
]
},
"invoiceDataphone": {
"type": "objectstring",
"properties": {
"name },
"phone2": {
"type": "string"
},
"lastNameposition": {
"type": "string"
},
"documentofficeHours": {
"type" "type": "string"
},
"isLegalPersonemail": {
"type": "booleanstring",
"format": }
"email"
},
"requiredtimeZone": [
{
"nametype": "object",
"documentproperties",: "isLegalPerson"
]
},
"transaction{
"refId": {
"type": "objectstring",
"propertiesformat": {
"transactionId": {
"type": "integer"
},
"establishmentCode": {
"type": "integer"
},
"paymentMethodCode": {
"uuid",
"maxLength": 36,
"minLength": 36
}
},
"required": [
"refId"
]
},
"language": {
"type": "integerobject"
},
"value,
"properties": {
"type": "integer"
},
"valueDiscount"refId": {
"type": "integerstring",
},
"installments": {
"typeformat": "integeruuid",
},
"status"maxLength": {
"type": "integer"
},
"authorization": {
"type": "string"
},
"operatorTransactionCode": {
36,
"minLength": 36
}
},
"required": [
"refId"
]
},
"active": {
"type": "stringboolean"
},
"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}
},
"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": {
"description": "NombreEs la deldiferencia titularentre depaymentValue lamenos tarjetavalue",
"type": "stringinteger"
},
}
},
"cardNumberrequired": {[
"descriptionorderId": "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",
,
"transactionId",
"examplesestablishmentCode": ["123456*******7890"],
,
"paymentMethodCode",
"value",
"typevalueDiscount": "string"
},
,
"installments",
"status",
"documentauthorization": {,
"descriptionoperatorTransactionCode": "Documento de identificación de la persona titular de la tarjeta (CPF)",
,
"operatorApprovalDate",
"typereceipt": "string"
,
"nsu",
"paymentUrl"
]
}
]
},
"splitPayment": {
"requireddescription": ["Indicador de que la información es parte de un pago realizado con 2 tarjetas",
"cardHoldertype": boolean,
"example": true
},
"mixedBundling": {
"cardNumberdescription",: "Indicador de que el pago es fraccionado",
"document"
type": boolean,
]"example": true
},
"paymentUrlmultipleBusinesses": {
"description": "EsteIndicador campode esque obligatorioel cuandopago es unparte pagode fraccionado"una compra multi-sello",
"type": boolean,
"example": false
}
},
"required": [
"external",
"typepaymentDate":,
"stringparentGuardian",
"paymentMethod",
"price",
"originalPrice",
"taxes",
"taxRate",
}"itemList",
"freight",
"paymentValueaddressList":,
{
"invoiceData",
"typetransaction":,
"integersplitPayment",
}"mixedBundling",
"multipleBusinesses"
]
} |
Code Block |
---|
language | js |
---|
title | Ejemplo - Pago por paquete |
---|
collapse | true |
---|
| {
"interestexternal": {
"descriptionorderId": "Es la diferencia entre paymentValue menos value"
9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
"typecollectionOrderId": "integer"9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
}
},
"required": [
"transactionId",
"establishmentCode",
"paymentMethodCode",
"value",
"valueDiscount",
"installments",
"status",
"authorization",
"operatorTransactionCode",
"operatorApprovalDate",
"receipt",
"nsu",
"paymentUrl"
]
}
},
"required": [
"external",
"paymentDate",
"parentGuardian",
"paymentMethod",
"price",
"originalPrice",
"itemList",
"freight",
"addressList",
"invoiceData",
"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": {
"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": [
"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-000012282310",
"document": "03915826588"
},
"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-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": "",
"transportCode": "",
{
"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"
},
] "contact": "Alfredo Pai",
"taxesphone": 0.0000"",
"taxRatephone2": 0.0000"12345678901",
"salesTypeposition": "VENTAContacto Principal",
"salesChannelofficeHours": "ALU",
"installmentsemail": 1"test@test.com",
}
],
"freighttimeZone": {
"transportNamerefId": "",
"transportPhone": "",
"transportCode": "",
"orderNote": "",
"orderFreightValue": 0,
"orderDeliveryForecast": "dd/mm/yyyy",
"orderEstablishment": ""
},
"addressList": [00000000-0000-1000-0000-000000000028"
},
"language": {
"refId": "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",
"streetisLegalPerson": false
"Rua Gavião Peixoto" },
"outdoorNumbertransaction": "313",
{
"interiorNumberorderId": ""3511,
"neighborhoodtransactionId": "Icaraí",20027340,
"cityestablishmentCode": "RIO DE JANEIRO",
"postalCode1627652346504,
"paymentMethodCode": "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": "Alfredo",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",
"cardNumber": "123456*******7890",
"document": "07319150972"
},
"lastNamepaymentUrl": "Bernalhttps://api.bempaggo.io/proxy/yapay/checkout/api/v3/transacao/1627652346504/20027340",
"paymentValue": 198055,
"interest": 0
},
"documentmixedBundling": false,
"07319150972splitPayment",
"isLegalPerson: false
} |
Code Block |
---|
language | js |
---|
title | Ejemplo - Pago fraccionado |
---|
collapse | true |
---|
| {
"external": false{
},
"transactionorderId": {"9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
"transactionIdcollectionOrderId": 20027340,
"9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
"establishmentCodeconsolidatorOrderId": 1627652346504"9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
"paymentMethodCodetotalValue": 1901118.5200,
"valueorderCount": 1
198055,
},
"valueDiscountpaymentDate": 0,
"installments": 2,
"2023-06-07T16:21:38+00:00",
"statusparentGuardian": 1,
{
"authorizationrefId": "26346100000000-0000-1000-0000-000012431581",
"operatorTransactionCodedocument": "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"
},
"totalItem": 1,
"paymentUrlprice": "https://api.bempaggo.io/proxy/yapay/checkout/api/v3/transacao/1627652346504/20027340",
741.12,
"paymentValueoriginalPrice": 198055741.12,
"interesttaxes": 0.0000,
}
} | Code Block |
---|
language | js |
---|
title | Ejemplo - Pago fraccionado |
---|
collapse | true |
---|
| {
"external": {
"orderId": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5 "taxRate": 0.0000,
"salesType": "VENTA",
"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,
"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": 143.2523,
"originalPrice": 219,
"markupRate": 20.0000,
"priceWithMarkup": 0.0000,
"taxes": 0.0000,
"taxRate": 0.0000,
"discountList": [
{
"rate": 45.4900,
"reason": "VEFR",
"amount": 119.5477
}
],
"salesTerms": {
"familyCode": "idiomas",
"code": 1,
"group": 2,
"digitalCode": "22006077",
"isExclusive": false
}
},
{
"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": 102 212,
"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": 138.6734212,
"originalPricemarkupRate": 21220.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",
"totalItemtransportPhone": 1"",
"pricetransportCode": 115.1251"",
"originalPriceorderNote": 176"",
"markupRateorderFreightValue": 2019.61,
"taxesorderDeliveryForecast": 0"2023-06-07T16:21:38+00:00",
"taxRateorderEstablishment": 0""
},
"discountListaddressList": [
{
"address": {
"rateaddressType": 45.49"Physical",
"reasonstreet": "VEFRRua Gavião Peixoto",
"amountoutdoorNumber": 96.0749"313",
}
],
"interiorNumber": "",
"salesTermsneighborhood": {
"Icaraí",
"familyCodecity": "idiomasRIO DE JANEIRO",
"codepostalCode": 1"24230092",
"groupcounty": 2,{
"digitalCoderefId": "2200607700000000-0000-1000-0000-000000020226",
"isExclusivecountyCode": false
}"BE402DF"
},
] "contact": "Alfredo Pai",
}
],
"freightphone": {"",
"transportNamephone2": "12345678901",
"transportPhoneposition": "Contacto Principal",
"transportCodeofficeHours": "",
"orderNoteemail": "test@test.com",
"orderFreightValuetimeZone": 19.61,
{
"orderDeliveryForecastrefId": "2023-06-07T16:21:38+00:00",
"orderEstablishment": ""
},
"addressList": [00000000-0000-1000-0000-000000000028"
},
"language": {
"refId": "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",
"interiorNumberdocument": "07319150972",
"neighborhoodisLegalPerson": "Icaraí",
"city": "RIO DE JANEIRO",
"postalCode": "24230092",
false
},
"transactions": [
{
"countyorderId": {3511,
"refIdtransactionId": "00000000-0000-1000-0000-000000020226"20027340,
"countyCodeestablishmentCode": "BE402DF"
} 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
}
}
],
"invoiceData"Sucesso.",
"card": {
"namecardHolder": "Alfredo Bernal",
"lastNamecardNumber": "Bernal123456*******7890",
"document": "07319150972"
},
"paymentUrl": "https://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
} |
|
---|