Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Descripción
MétodoPOST
URL
Ejemplo
Payload


Code Block
languagejs
titleJSON Schema
collapsetrue
{
	"$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": "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": { 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,
					"descriptionexclusiveMinimum": "Documento de identificación de la persona que está realizando el pago (CPF)" 0
                },
					"typeorderCount": "string"
				}{
			},
			"requireddescription": [
				"refId",
				"document"
			]
		},
		"paymentMethod": {
			"description": "Identificador del método de pago, es el campo parametro en la tabla forma_pago",
			"Es la cantidad de pedidos que conforman la compra",
                    "type": "string"number,
					"minLengthexclusiveMinimum": 0,
					"maxLengthexample": 10
2
				}
			},
			"conciliationAccountrequired": {[
				"orderId",
				"descriptionconsolidatorOrderId": "Identificador del concentrador de pago, es el campo parametro,
				"totalValue",
				"orderCount"
			]
		},
		"paymentDate": {
			"description": "Fecha en la tabla concentra_ que se realiza el pago",
			"type": "string",
			"minLengthformat": 0,"date-time"
		},
		"parentGuardian": {
			"maxLengthtype": 6"object",
			},"properties": {
				"pricerefId": {
					"description": "PrecioId finalen aBDC pagar,de despuésla depersona markup,que descuentos,está impuestosrealizando yel cargospago",

					"type": "numberstring",
			"exclusiveMinimum		"format": "uuid",
					"maxLength": 36,
					"minLength": 036
				},
				"originalPricedocument": {
					"description": "PrecioDocumento de inicialidentificación ade pagar,la antespersona deque markup,está descuentos,realizando impuestosel ypago cargos(CPF)",

					"type": "number"string"
				}
			},
			"exclusiveMinimumrequired": 0 [
				"refId",
				"document"
			]
		},
		"discountListpaymentMethod": { 
			"description": "ListaIdentificador dedel descuentosmétodo aplicados al total de la comprade pago, sies hayel más de 2 descuentos aplicados estos se acumulan en el segundo/último descuento", campo parametro en la tabla forma_pago",
			"type": "arraystring",

			"uniqueItemsminLength": true0, 
			"minItemsmaxLength": 10
1		},
			"maxItemsconciliationAccount": 2, {
			"itemsdescription": [ 
				{  "Identificador del concentrador de pago, es el campo parametro en la tabla concentra_pago",
					"type": "objectstring",

					"propertiesminLength": { 0,
						"ratemaxLength": {6

		},
		"price": {
			"description": "Indica el porcentaje del descuento",
							Precio final a pagar, después de markup, descuentos, impuestos y cargos", 
			"type": "number",

							"exclusiveMinimum": 0

						}, 
						"amountoriginalPrice": { 
							"description": "Indica el valor correspondiente al porcentaje del descuento",
							Precio inicial a pagar, antes de markup, descuentos, impuestos y cargos", 
			"type": "number",

							"exclusiveMinimum": 0 
						} 
					}, 
					"requireddiscounts": [{ 
						"rate"description": "Descuentos aplicados en la compra", 
						"amounttype": "object",
					] 
				} 
			] 
		},	
"properties": { 
				"itemListdiscountOne": {
					"description": "ListaConcentra deel paquetesvalor vendidos",
			"type": "array",
			"uniqueItems": true,
			"minItems": 1,
			"items": [
				{acumulado de los descuentos que no sean de tipo PARC",
					"type": "object", 
					"properties": { 
						"articleRefIdamount": { 
							"description": "Id en BDC del artículo/paqueteEs el valor acumulado de los descuentos que no sean de tipo PARC",
							"type": "stringnumber", 
							"formatminimum": "uuid",
							"maxLength": 36,0 
							"minLength":} 36
						}, 
						"studentrequired": [ {
							"typeamount": "object",
							"properties": {]
				},
				"refIddiscountTwo": {
									"description": "IdConcentra enel BDCvalor del alumno descuento de tipo PARC",
									"type": "stringobject", 
					"properties": { 
						"formatamount": { "uuid",
									"maxLengthdescription": 36 "Es el valor correspondiente al descuento de tipo PARC",
									"minLengthtype": 36"number", 
								},"minimum": 0 
								"personRefId": {} 
					}, 
					"descriptionrequired": "Id en BDC de la persona asociada al alumno",
		[ 
							"typeamount":
"string",
					]
				"format": "uuid",} 
			] 
		},
				"maxLengthtaxes": 36,{
									"minLength": 36
								}
							},
							"required": [
								"refId",
								"personRefId"
							]
						},
						"totalItem": {
							"description": "Valor total de los impuestos aplicados, correspondiente al porcentaje total de impuestos",
			"type": "number",
			"minimum": 0
		},
		"taxRate": { 
			"description": "CantidadPorcentaje total vendidade delimpuestos artículo/paqueteaplicados",
							"type": "integernumber",
							"exclusiveMinimum"minimum": 0
						},	
						"priceitemList": {
							"description": "Precio final del artículo/paquete, después Lista de markup,paquetes descuentosvendidos",
impuestos y cargos			"type": "array",
				"uniqueItems": true,
			"typeminItems": 1,
			"numberitems",: [
				{
					"exclusiveMinimumtype": 0"object",
						},"properties": {
						"originalPricearticleRefId": {
							"description": "PrecioId en inicialBDC del artículo/paquete, antes de markup, descuentos, impuestos y cargos",
							"type": "numberstring",
							"exclusiveMinimumformat": 0"uuid",
							}"maxLength": 36,
							"discountListminLength": { 36
						},
							"descriptionstudent": "Lista de descuentos aplicados al artículo/paquete, si hay más de 3 descuentos aplicados estos se acumulan en el tercer/último descuento", 
{
							"type": "arrayobject", 
							"uniqueItemsproperties": true,{

								"minItemsrefId": 1,{
									"maxItemsdescription": 3 "Id en BDC del alumno",

									"itemstype": ["string",

								{ 	"format": "uuid",
									"typemaxLength": "object"36,

									"propertiesminLength": {36

								},
								"ratepersonRefId": { 
											"description": "Indica el porcentaje del descuentoId en BDC de la persona asociada al alumno",
											"type": "numberstring",

											"exclusiveMinimumformat": 0 "uuid",
										}"maxLength": 36,

										"reasonminLength": { 36
								}
							},
							"descriptionrequired": "Identificador de la razón del descuento, es el campo parametro en la tabla razon",
		[
								"refId",
													"typepersonRefId":
"string",
											"minLength": 0,
											"maxLength": 16 
				]
						}, 
										"amounttotalItem": { 
											"description": "IndicaCantidad el valor correspondiente al porcentaje del descuentovendida del artículo/paquete",
											"type": "numberinteger", 
											"exclusiveMinimum": 0

										},

									}, 
		"price": {
							"requireddescription": [ 
 "Precio final del artículo/paquete, después de markup, descuentos, impuestos y cargos",
										"rate"type": "number", 
										"reasonexclusiveMinimum",: 0
						},
						"amountoriginalPrice": {
									] "description": "Precio inicial del artículo/paquete, antes de markup, descuentos, impuestos y cargos",
								} "type": "number",
							]"exclusiveMinimum": 0
						},
						"taxesdiscountList": { 
							"description": "ValorLista de los impuestosdescuentos aplicados al artículo/paquete, correspondiente al porcentaje de impuestos", 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": "integerarray", 
							"minimumuniqueItems": 0true, 
						}	"minItems": 1,
							"taxRatemaxItems": {3, 
							"descriptionitems": "Porcentaje[ de impuestos aplicados al artículo/paquete",

								"{ 
									"type": "integerobject", 
									"minimumproperties": { 0
						},
						"salesTyperate": { 
											"description": "Identificador del tipo de venta, esIndica el campoporcentaje parametro en la tabla tipo_ventadel descuento",
											"type": "stringnumber", 
											"minLengthexclusiveMinimum": 0, 
							"maxLength": 14			}, 
						},
						"salesChannelreason": { 
											"description": "Identificador delde la canalrazón dedel ventadescuento, es el campo parametro en la tabla canal_ventarazon",
											"type": "string",
											"minLength": 0,
											"maxLength": 16 10
										}, 
										"salesOptionamount": { 
											"description": "Identificador de la opción de venta, es Indica el campovalor parametrocorrespondiente enal laporcentaje tabladel opcion_ventadescuento",
											"type": "stringnumber", 
											"minLengthexclusiveMinimum": 0, 
										"maxLength":} 3
									}, 
									"componentListrequired": {[ 
										"descriptionrate": "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",
			, 
										"reason", 
										"typeamount": "array",
									"items":] [
								{} 
									"type": "object",] 
									"properties": {},
										"articleRefIdtaxes": {
											"description": "Id en BDC delValor de los impuestos aplicados al artículo/componente"paquete,
											"type": "string correspondiente al porcentaje de impuestos",
											"formattype": "uuidinteger",
											"maxLengthminimum": 36,
											"minLength": 36
		0
								},
										"totalItemtaxRate": { 
											"description": "Cantidad vendida delPorcentaje de impuestos aplicados al artículo/paquete",
											"type": "integer",
											"exclusiveMinimumminimum": 0
										},
										"pricesalesType": {
											"description": "Precio finalIdentificador del artículo/componente, despuéstipo de markupventa, descuentos,es impuestosel y cargoscampo parametro en la tabla tipo_venta",
											"type": "numberstring",
											"exclusiveMinimumminLength": 0,
							"maxLength": 14
						},
										"originalPricesalesChannel": {
											"description": "PrecioIdentificador del inicialcanal delde artículo/paqueteventa, es antesel decampo markup,parametro descuentos,en impuestosla ytabla cargoscanal_venta",
											"type": "numberstring",
											"exclusiveMinimumminLength": 0
										},
										"markupRatemaxLength": {10
						},
						"descriptionsalesOption": "",{
											"typedescription": "numberIdentificador de la opción de venta, es el campo parametro en la tabla opcion_venta",
							"type": "string",
							"minimumminLength": 0,
							"maxLength": 3
						},
										"taxescomponentList": {
											"description": "ValorLista de los impuestos aplicados al artículos/componentes que forman parte del artículo/componentepaquete vendidos, correspondienteeste atributo alsolo porcentajedebe deestar impuestos",
											"type": "number",
				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",
							"minimumitems": 0[
								{
				}					"type": "object",
									"properties": {
										"taxRatearticleRefId": {
											"description": "PorcentajeId deen impuestosBDC aplicados aldel artículo/componente",
											"type": "numberstring",
											"minimumformat": 0
							"uuid",
			},
										"discountListmaxLength": {36,
											"descriptionminLength": "Lista de descuentos aplicados al artículo/componente, solo puede indicarse el tipo de descuento por venta fraccionada",36
											"type": "array"},
											"uniqueItemstotalItem": true,{
											"minItemsdescription": 1 "Cantidad vendida del artículo/paquete",
											"maxItemstype": 1"integer",
											"itemsexclusiveMinimum": [0
												{
			},
										"typeprice": "object",{
													"propertiesdescription": {"Precio final del artículo/componente, después de markup, descuentos, impuestos y cargos",
											"type": "number",
											"rateexclusiveMinimum": {
 0
										},
										"originalPrice": {
											"description": "Indica el porcentaje del descuento",
										Precio inicial del artículo/componente, antes de markup, descuentos, impuestos y cargos",
											"type": "number",
											"exclusiveMinimum": 0
										},
										"markupRate": {
											"description": "",
											"type": "number",
											"minimum": 0
										},
										"priceWithMarkup": {
											"description": "Valor del precio inicial del articulo/componente, después del markup",
											"type": "number",
											"minimum": 0
										},
										"taxes": {
											"description": "Valor de los impuestos aplicados al artículo/componente, correspondiente al porcentaje de impuestos",
											"type": "number",
											"minimum": 0
										},
										"taxRate": {
											"description": "Porcentaje de impuestos aplicados al artículo/componente",
											"type": "number",
											"minimum": 0
										},
										"discountList": {
											"description": "Lista de descuentos aplicados al artículo/componente, solo puede indicarse el tipo de descuento por venta fraccionada",
											"type": "array",
											"uniqueItems": true,
											"minItems": 1,
											"maxItems": 1,
											"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, para venta fraccionada solo se acepta el valor VEFR y si es venta por paquete solo se acepta el valor COM",
															"type": "string",
															"maxLength": 4, 
															"minLength": 4
														},
														"amount": {
															"description": "Indica el valor correspondiente al porcentaje del descuento",
															"type": "number",
															"exclusiveMinimum": 0
														}
													},
													"required": [
														"rate",
														"reason",
														"amount"
													]
												}
											]
										},
										"salesTerms": {
											"type": "object",
											"properties": {
												"familyCode": {
													"description": "Código da Família do Produto | Lista na plataforma | Código da categoria",
													"type": "string",
													"example": "idiomas"
												},
												"code": {
													"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",
													"example": 1
												},
												"group": {
													"description": "1-Avulso, 2-Agrupado",
													"type": "number",
													"example": 1
												},
												"digitalCode": {
													"description": "Código ERP do produto digital | Caso o group == 2",
													"type": "string",
													"example": "22006077"
												},
												"isExclusive": {
													"description": "Item exclusivo: false - Não exclusivo, true - exclusivo",
													"type": "boolean",
													"example": true
												}
											},
											"required": [
												"familyCode",
												"code",
												"group",
												"digitalCode",
												"isExclusive"
											]
										}
									},
									"required": [
										"articleRefId",
										"totalItem",
										"price",
										"originalPrice",
										"markupRate",
										"priceWithMarkup",
										"taxes",
										"taxRate",
										"discountList",
										"salesTerms"
									]
								}
							]
						}
					},
					"required": [
						"articleRefId",
						"student",
						"totalItem",
						"price",
						"originalPrice",
						"taxes",
						"taxRate",
						"salesType",
						"salesChannel",
						"salesOption",
						"componentList"
					]
				}
			]
		},
		"freight": {
			"type": "object",
			"properties": {
				"transportName": {
					"type": "string"
				},
				"transportPhone": {
					"type": "string"
				},
				"transportCode": {
					"type": "string"
				},
				"orderNote": {
					"type": "string"
				},
				"orderFreightValue": {
					"type": "number"
				},
				"orderDeliveryForecast": {
					"type": "string"
				},
				"orderEstablishment": {
					"type": "string"
				}
			},
			"required": [
				"transportName",
				"transportPhone",
				"transportCode",
				"orderNote",
				"orderFreightValue",
				"orderDeliveryForecast",
				"orderEstablishment"
			]
		},
		"addressList": {
			"description": "Lista de domicilios asociados a la persona que realiza el pago",
			"type": "array",
			"uniqueItems": true,
			"minItems": 2,
			"maxItems": 3,
			"items": [
				{
					"type": "object",
					"properties": {
						"address": {
							"type": "object",
							"properties": {
								"addressType": {
									"description": "Indicador del tipo de domicilio, solo puede tener 3 valores (Physical, Mailing, Shipping)",
									"type": "string",
									"maxLength": 7,
									"minLength": 8
								},
								"street": {
									"type": "string"
								},
								"outdoorNumber": {
									"type": "string"
								},
								"interiorNumber": {
									"type": "string"
								},
								"neighborhood": {
									"type": "string"
								},
								"city": {
									"type": "string"
								},
								"postalCode": {
									"type": "string"
								},
								"county": {
									"type": "object",
									"properties": {
										"refId": {
											"type": "string",
											"format": "uuid",
											"maxLength": 36,
											"minLength": 36
										},
										"countyCode": {
											"type": "string"
										}
									},
									"required": [
										"refId",
										"countyCode"
									]
								},
								"contact": {
									"type": "string"
								},
								"phone": {
									"type": "string"
								},
								"phone2": {
									"type": "string"
								},
								"position": {
									"type": "string"
								},
								"officeHours": {
									"type": "string"
								},
								"email": {
									"type": "string",
									"format": "email"
								},
								"timeZone": {
									"type": "object",
									"properties": {
										"refId": {
											"type": "string",
											"format": "uuid",
											"maxLength": 36,
											"minLength": 36
										}
									},
									"required": [
										"refId"
									]
								},
								"language": {
									"type": "object",
									"properties": {
										"refId": {
											"type": "string",
											"format": "uuid",
											"maxLength": 36,
											"minLength": 36
										}
									},
									"required": [
										"refId"
									]
								},
								"active": {
									"type": "boolean"
								}
							},
							"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": "numberobject",
					"properties": {
										"exclusiveMinimumorderId": 0{
							"description": "Identificador de la compra del lado del integrador (Venda Bem Pago)",
							},"type": "string"
						},
								"reasontransactionId": {
															"description": "Identificador de la razóntransacción del descuento, es el campo parametro en la tabla razon, al ser venta fraccionada solo se acepta el valor VEFR",
				lado del integrador (Transaçao Bem Pago)",
											"type": "string",
						},
									"maxLengthestablishmentCode": 4, 
						{
									"minLengthtype": 4
							"integer"
							},
														"amountpaymentMethodCode": {
															"descriptiontype": "Indica el valor correspondiente al porcentaje del descuento",integer"
									},
						"typevalue": "number",
								{
							"exclusiveMinimumtype": 0"integer"
							},
							}"valueDiscount": {
							"type": "integer"
						},
						"installments": {
							"requiredtype": ["integer"
								},
						"ratestatus",: {
							"type": "integer"
							"reason"},
						"authorization": {
								"amount"type": "string"
						},
							]"operatorTransactionCode": {
							"type": "string"
						},
						"operatorApprovalDate": {
					]
				"type": "string"
						},
									},
		"receipt": {
							"requiredtype": ["string"
						},
						"articleRefIdnsu",: {
										"totalItem",
"type": "string"
						},
						"pricemessage",: {
										"originalPrice","type": "string"
						},
						"markupRatecard",: {
										"taxes"description": "Datos de la tarjeta, este campo solo es obligatorio cuando el pago es con tarjeta",
										"taxRate"type": "object",
										"discountListproperties": {
									]
"cardHolder": {
									}"description": "Nombre del titular de la tarjeta",
							]
			"type": "string"
			}
					},
								"requiredcardNumber": [{
									"articleRefId",
						"student",
						"totalItem",
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",
									"priceexamples",
						"originalPrice": ["123456*******7890"],
						"taxes",
						"taxRatetype",
						"salesType",
: "string"
							"salesChannel"	},
						"salesOption",
						"componentListdocument"
					]: {
				}
			]
		},
		"freightdescription": {
			"type": "object",
			"properties": {"Documento de identificación de la persona titular de la tarjeta (CPF)",
				"transportName": {
					"type": "string"
								},
						"transportPhone": {
	},
							"typerequired": "string"[
				},
				"transportCodecardHolder": {
,
								"typecardNumber":,
"string"
				},
				"orderNotedocument":
{
							"type": "string"
]
						},
						"orderFreightValuepaymentUrl": {
							"typedescription": "number"
				},
				"orderDeliveryForecast": {
Este campo es obligatorio cuando es un pago fraccionado",
							"type": "string"
						},
						"orderEstablishmentpaymentValue": {
							"type": "stringinteger"
						},
			},
			"requiredinterest": [{
				"transportName",
				"transportPhonedescription",: 				"transportCode"Es la diferencia entre paymentValue menos value",
				"orderNote",
				"orderFreightValuetype",: 				"orderDeliveryForecastinteger",
				"orderEstablishment"
			]
		},
		"addressList": {
			"description": "Lista de domicilios asociados a la persona que realiza el pago"
			"type": "array",
},
					"uniqueItemsrequired": true,[
						"minItemsorderId": 2,
						"maxItemstransactionId": 3,
						"itemsestablishmentCode":,
[
				{
					"type": "object"paymentMethodCode",
						"propertiesvalue": {,
						"addressvalueDiscount": {,
							"type": "object"installments",
							"propertiesstatus": {,
								"addressTypeauthorization": {
			,
						"description": "Indicador del tipo de domicilio, solo puede tener 3 valores (Physical, Mailing, Shipping)",
			operatorTransactionCode",
						"operatorApprovalDate",
						"type": "stringreceipt",
									"maxLengthnsu": 7,
									"minLengthpaymentUrl":
8
					]
				},
			]
		},
			"streetsplitPayment": {
									"typedescription": "string"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",
			"outdoorNumbertype": {
						boolean,
			"typeexample": "string"
						true
		},
								"interiorNumber"multipleBusinesses": {
						"description": "Indicador de que el pago es parte de una compra multi-sello",
			"type": "string"boolean,
			"example": false
				}
	},
	"required": [
		"external",
		"paymentDate",
		"parentGuardian",
		"neighborhoodpaymentMethod": {,
		"price",
			"originalPrice",
		"taxes",
		"typetaxRate":,
		"stringitemList",
		"freight",
		"addressList",
		"invoiceData",
		}"transaction",
		"splitPayment",
		"mixedBundling",
		"multipleBusinesses"
	]
}


Code Block
languagejs
titleEjemplo - Pago por paquete
collapsetrue
{
	"cityexternal": {
									"typeorderId": "string"
								},
						9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
		"postalCodecollectionOrderId": {
							"9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
		"typeconsolidatorOrderId": "string"
								},
								"county": {
									"type": "object",
									"properties9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
		"totalValue": 1118.5200,
		"orderCount": 1
	},
	"paymentDate": "2023-06-07T16:21:38+00:00",
	"parentGuardian": {
										"refId": {"00000000-0000-1000-0000-000012282310",
											"type"document": "03915826588"
	},
	"paymentMethod": "stringTCV",
											"formatconciliationAccount": "uuidYAPY",
											"maxLengthprice": 361118.5200,
											"minLength"originalPrice": 36
										},
										"countyCode4406.8000,
	"discountList": {[
		{
									"type"rate": "string"74.6183,
										}
									},
									"required"amount": 3288.2800
		}
	],
	"itemList": [
		{
								"refId"articleRefId": "00000000-0000-1000-0000-000000118094",
			"student": {
							"countyCode""refId": "00000000-0000-1000-0000-000020096053",
									]
				"personRefId": "00000000-0000-1000-0000-000012271661"
				},
					"totalItem": 1,
			"contactprice": {
						559.2617,
			"typeoriginalPrice": "string"
					2203.3980,
			},
"discountList": [
				{
					"phonerate": {
				23.7097,
					"typereason": "stringCOM",
					"amount": 522.4191
				},
				{
					"phone2rate": {
				36.7300,
					"typereason": "stringFFS",
					"amount": 1121.7172
				},
				{
					"positionrate": {25.0000,
					"reason": "IT",
					"typeamount": "string"1121.7172
				}
				}],
			"taxes": 0.0000,
			"taxRate": 0.0000,
			"officeHourssalesType": {
						"VENTA",
			"typesalesChannel": "stringALU",
			"installments": 1
					},
		{
			"articleRefId": "00000000-0000-1000-0000-000000118095",
			"emailstudent": {
									"typerefId": "string00000000-0000-1000-0000-000020096149",
									"formatpersonRefId": "email00000000-0000-1000-0000-000012271845"
								},
								"timeZonetotalItem": {1,
									"typeprice": "object"559.2617,
						"originalPrice": 2203.398,
			"propertiesdiscountList": {[
					{
					"refIdrate": {
						23.7097,
					"typereason": "stringCOM",
											"format"amount": "uuid",522.4191
				},
				{
					"maxLengthrate": 3666.7300,
						"reason": "HP",
					"minLengthamount": 36
				1121.7172
						}
									}],
									"requiredtaxes": [0.0000,
										"refId"
									]"taxRate": 0.0000,
			"salesType": "VENTA",
					}"salesChannel": "ALU",
			"installments": 1
		}
		],
	"languagefreight": {
		"transportName": "",
					"transportPhone": "",
		"transportCode": "",
		"typeorderNote": "object",
		"orderFreightValue": 0,
		"orderDeliveryForecast": "dd/mm/yyyy",
				"orderEstablishment": ""
	},
	"propertiesaddressList": {[
							{
			"refIdaddress": {
							
				"typeaddressType": "stringPhysical",
											"formatstreet": "uuidRua Gavião Peixoto",
											"maxLengthoutdoorNumber": 36"313",
											"minLengthinteriorNumber": 36"",
										}
									},
					"neighborhood": "Icaraí",
				"requiredcity": [
	 "RIO DE JANEIRO",
									"refIdpostalCode"
									]
								},
				: "24230092",
				"activecounty": {
									"typerefId": "boolean"00000000-0000-1000-0000-000000020226",
								}
			"countyCode": "BE402DF"
				},
							"requiredcontact": ["Alfredo Pai",
				"phone": "",
				"phone2": "addressType12345678901",
				"position": "Contacto Principal",
				"streetofficeHours": "",
								"outdoorNumber"email": "test@test.com",
								"interiorNumbertimeZone",: {
								"neighborhood","refId": "00000000-0000-1000-0000-000000000028"
				},
				"citylanguage",: {
								"postalCode","refId": "00000000-0000-1000-0000-000000000017"
				},
				"countyactive",: true
			}
		},
		{
			"contactaddress",: {
				"addressType": "Mailing",
				"phone"street": "Rua Gavião Peixoto",
				"outdoorNumber": "313",
				"interiorNumber"phone2: "",
								"position"neighborhood": "Icaraí",
								"officeHours",
			"city": "RIO DE JANEIRO",
					"email"postalCode": "24230092",
								"timeZonecounty",: {
								"language"refId": "00000000-0000-1000-0000-000000020226",
								"activecountyCode"
							]: "BE402DF"
						},
					}"contact": "Alfredo Pai",
					"requiredphone": ["",
						"address""phone2": "12345678901",
					]"position": "Contacto Principal",
				}
"officeHours": "",
				]
		},
"email": "test@test.com",
				"transactiontimeZone": {
					"typerefId": "array",
00000000-0000-1000-0000-000000000028"
				"items": {},
				"installmentslanguage": {
					"typerefId": "number"00000000-0000-1000-0000-000000000017"
				},
					"exclusiveMinimumactive": 0true
				}
			}
		}
	},],
  	"requiredinvoiceData": {
   [ 		"external"name": "Alfredo",
    		"paymentDate"lastName": "Bernal",
		"parentGuardian",
		"paymentMethod",
		"price",
		"originalPrice",    	"document": "07319150972",
    	"isLegalPerson": false  
  	},
	"transaction": {
		"itemListorderId": 3511,
		"freighttransactionId": 20027340,
   	 	"addressListestablishmentCode": 1627652346504,
		"transaction"
	]
}
Code Block
languagejs
titleEjemplo - Pago por paquete
collapsetrue
{    	"externalpaymentMethodCode": 190,
   { 		"orderIdvalue": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5",
		"orderConsolidatorId": "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": [
		{
			"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.398,
			"discountList": [
				{
					"rate": 23.7097,
					"reason": "COM",
					"amount": 522.4191
				},
				{
					"rate": 66.73,
					"reason": "FFS",
					"amount": 1121.7172
				}
			],
			"taxes": 0.0000,
			"taxRate": 0.0000,
			"salesType": "VENTA",
			"salesChannel": "ALU",
			"installments": 1
		},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"
    	},	
    	"paymentUrl": "https://api.bempaggo.io/proxy/yapay/checkout/api/v3/transacao/1627652346504/20027340",
		"paymentValue": 198055,
		"interest": 0
	},
	"mixedBundling": false,
    "splitPayment": false
}


Code Block
languagejs
titleEjemplo - Pago fraccionado
collapsetrue
{
	"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-000012431581",
		"document": "27288324800"
	},
	"paymentMethod": "PWM",
	"conciliationAccount": "",
	"price": 760.73,
	"originalPrice": 760.73,
	"itemList": [
		{
			"articleRefId": "00000000-0000-1000-0000-000000118095000000118090",
			"student": {
				"refId": "00000000-0000-1000-0000-000020096149000020700764",
				"personRefId": "00000000-0000-1000-0000-000012271845000012147907"
			},
			"totalItem": 1,
			"price": 559741.261712,
			"originalPrice": 2203741.39812,
			"discountListtaxes": [0.0000,
				{
		"taxRate": 0.0000,
			"salesType": "VENTA",
			"ratesalesChannel": 23.7097"ALU",
					"reasonsalesOption": "COMOB",
			"installments": 1,
			"amountcomponentList": 522.4191 [
				{
				}	"articleRefId": "00000000-0000-1000-0000-000000094355",
					{"totalItem": 1,
					"rateprice": 66143.73002523,
					"reasonoriginalPrice": "HP"219,
					"amountmarkupRate": 112120.71720000,
					}
			],
"priceWithMarkup": 0.0000,
					"taxes": 0.0000,
					"taxRate": 0.0000,
					"salesTypediscountList": "VENTA",[
			"salesChannel": "ALU",
			"installments": 1
{
			}
	],
	"freight": {
		"transportNamerate": ""45.4900,
			"transportPhone": "",
		"transportCode": "",
		"orderNotereason": "VEFR",
			"orderFreightValue": 0,
		"orderDeliveryForecast": "dd/mm/yyyy",
		"orderEstablishmentamount": ""
119.5477
						},
	"addressList": [					],
		{
			"addresssalesTerms": {
						"addressTypefamilyCode": "Physicalidiomas",
						"streetcode": "Rua Gavião Peixoto"1,
						"outdoorNumbergroup": "313"2,
						"interiorNumberdigitalCode": "22006077",
						"neighborhoodisExclusive": "Icaraí",false
					"city": "RIO DE JANEIRO",
}
				"postalCode": "24230092"},
				"county": {
					"refIdarticleRefId": "00000000-0000-1000-0000-00000002022600000094584",
					"countyCode": "BE402DF"
				},
				"contact": "Alfredo Pai",
totalItem": 1,
					"phoneprice": ""66.7202,
					"phone2originalPrice": "12345678901"102,
					"positionmarkupRate": "Contacto Principal"20.0000,
					"officeHourspriceWithMarkup": ""0.0000,
					"emailtaxes": "test@test0.com"0000,
					"timeZonetaxRate": {0.0000,
					"refIddiscountList": "00000000-0000-1000-0000-000000000028"
[
						},{
							"languagerate": {45.4900,
							"refIdreason": "00000000-0000-1000-0000-000000000017"VEFR",
				},
				"activeamount": true
55.6798
						}
				}	],
		{
			"addresssalesTerms": {
						"addressTypefamilyCode": "Mailingidiomas",
						"streetcode": "Rua Gavião Peixoto"1,
						"outdoorNumbergroup": "313"2,
						"interiorNumberdigitalCode": "22006077",
						"neighborhoodisExclusive": "Icaraí",false
				"city": "RIO DE JANEIRO",	}
				"postalCode": "24230092"},
				"county": {
					"refIdarticleRefId": "00000000-0000-1000-0000-000000020226000000094294",
					"countyCodetotalItem": "BE402DF"
				},
1,
					"contactprice": "Alfredo Pai"138.6734,
					"phoneoriginalPrice": ""212,
				"phone2": "12345678901",
				"positionpriceWithMarkup": "Contacto Principal"0.0000,
					"officeHoursmarkupRate": ""20.0000,
					"emailtaxes": "test@test0.com"0000,
					"timeZonetaxRate": {0.0000,
					"refIddiscountList": "00000000-0000-1000-0000-000000000028"
[
					},
	{
							"languagerate": {45.4900,
							"refIdreason": "00000000-0000-1000-0000-000000000017"
	VEFR",
			},
				"activeamount": true
115.7266
						}
		}
			],
	"transaction": {}
}
Code Block
languagejs
titleEjemplo - Pago fraccionado
collapsetrue
{
	"external				"salesTerms": {
						"orderIdfamilyCode": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5idiomas",
						"orderConsolidatorIdcode": "9d4d296d-f9c7-4ce8-96c5-9721cdd2c8d5"
	},
	"paymentDate": "2023-06-07T16:21:38+00:00",
	"parentGuardian": {
		"refId": "00000000-0000-1000-0000-000012431581",
		"document": "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,
						"group": 2,
						"digitalCode": "22006077",
						"isExclusive": false
					}
				},
				{
					"articleRefId": "00000000-0000-1000-0000-000000094344",
					"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-000000094355000000094291",
					"totalItem": 1,
					"price": 143138.25236734,
					"originalPrice": 212,
					"markupRate": 21920.0000,
					"markupRatepriceWithMarkup": 200.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-00000094584000000094604",
					"totalItem": 1,
					"price": 66115.72021251,
					"originalPrice": 102 176,
					"markupRate": 20,
					"markupRatepriceWithMarkup": 200.0000,
					"taxes": 0.0000,
					"taxRate": 0.0000,
					"discountList": [
						{
							"rate": 45.490049,
							"reason": "VEFR",
							"amount": 5596.67980749
						}
					]
				},
				{
					"articleRefId": "00000000-0000-1000-0000-000000094294",
					"totalItem": 1,
					"price": 138.6734,
					"originalPrice": 212,
					"markupRate": 20.0000,
					"taxes": 0.0000,
					"taxRate": 0.0000,
"salesTerms": {
						"discountListfamilyCode": ["idiomas",
						{
	"code": 1,
						"rategroup": 45.49002,
							"reasondigitalCode": "VEFR22006077",
							"amountisExclusive": 115.7266false
					}
				}
			]
		}
	],
	"freight": {
			}	"transportName": "",
		"transportPhone": "",
				{"transportCode": "",
		"orderNote": "",
		"orderFreightValue": 19.61,
			"articleRefIdorderDeliveryForecast": "000000002023-0000-1000-0000-00000009434406-07T16:21:38+00:00",
					"totalItemorderEstablishment": ""
1	},
					"priceaddressList": 138.6734,[
		{
			"originalPriceaddress": 212,{
					"markupRateaddressType": 20.0000"Physical",
					"taxesstreet": 0.0000 "Rua Gavião Peixoto",
					"taxRateoutdoorNumber": 0.0000"313",
					"discountListinteriorNumber": [
						{ 							"rate": 45.4900,
							"reasonneighborhood": "VEFRIcaraí",
							"amountcity": 115.7266
						}
					]"RIO DE JANEIRO",
				}"postalCode": "24230092",
				"county": {
					"articleRefIdrefId": "00000000-0000-1000-0000-000000094291000000020226",
					"totalItemcountyCode": 1,"BE402DF"
					"price": 138.6734},
					"originalPricecontact": 212"Alfredo Pai",
					"markupRatephone": 20.0000"",
					"taxesphone2": 0.0000"12345678901",
					"taxRateposition": 0.0000 "Contacto Principal",
					"discountListofficeHours": [
						{
							"rate": 45.4900,
							"reasonemail": "VEFRtest@test.com",
							"amounttimeZone": 115.7266
						}{
					]"refId": "00000000-0000-1000-0000-000000000028"
				},
				"language": {
					"articleRefIdrefId": "00000000-0000-1000-0000-000000094604"000000000017"
				},
					"totalItemactive": 1true
			}
		},
		{
			"priceaddress": 115.1251,{
					"originalPriceaddressType": 176"Mailing",
					"markupRatestreet": 20 "Rua Gavião Peixoto",
					"taxesoutdoorNumber": 0"313",
					"taxRateinteriorNumber": 0"",
					"discountListneighborhood": ["Icaraí",
				"city": "RIO DE JANEIRO",
		{
			"postalCode": "24230092",
				"ratecounty": 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": ""
00000000-0000-1000-0000-000000000017"
				},
				"addressListactive": [true
			{}
		}
	"address],
  	"invoiceData": {
			
    	"addressTypename": "PhysicalAlfredo",
    				"streetlastName": "Bernal"Rua,
  Gavião Peixoto", 				"outdoorNumberdocument": "31307319150972",
				"interiorNumber": ""    	"isLegalPerson": false  
  	},
				"neighborhoodtransactions": "Icaraí",[
		{
			"cityorderId": "RIO DE JANEIRO"3511,
				"postalCodetransactionId": "24230092"20027340,
				"countyestablishmentCode": {1627652346504,
					"refIdpaymentMethodCode": "00000000-0000-1000-0000-000000020226"190,
					"countyCodevalue": "BE402DF"
				}198055,
				"contactvalueDiscount": "Alfredo Pai"0,
				"phoneinstallments": ""2,
				"phone2status": "12345678901"1,
				"positionauthorization": "Contacto Principal263461",
				"officeHoursoperatorTransactionCode": "00",
				"emailoperatorApprovalDate": "test@test.com2023-07-19 11:26:35",
				"timeZonereceipt": {
		"10462307190818157291",
			"refIdnsu": "00000000-0000-1000-0000-000000000028"11409373",
				}"message": "Sucesso.",
				"languagecard": {
					"refIdcardHolder": "00000000-0000-1000-0000-000000000017"Alfredo Bernal",
				}"cardNumber": "123456*******7890",
				"activedocument": true"07319150972"
			}
		},
		{
			"addresspaymentUrl": {
				"addressType": "Mailing"https://api.bempaggo.io/proxy/yapay/checkout/api/v3/transacao/1627652346504/20027340",
				"streetpaymentValue": "Rua Gavião Peixoto"198055,
				"outdoorNumberinterest": "313" 0
		},
		{
			"interiorNumberorderId": ""3511,
				"neighborhoodtransactionId": "Icaraí"20027341,
				"cityestablishmentCode": "RIO DE JANEIRO"1627652346504,
				"postalCodepaymentMethodCode": "24230092"190,
				"countyvalue": {198055,
					"refIdvalueDiscount": "00000000-0000-1000-0000-000000020226"0,
					"countyCodeinstallments": "BE402DF"2,
				}"status": 1,
				"contactauthorization": "Alfredo Pai263462",
				"phoneoperatorTransactionCode": "00",
				"phone2operatorApprovalDate": "123456789012023-07-19 11:26:35",
				"positionreceipt": "Contacto Principal10462307190818157292",
				"officeHoursnsu": "11409374",
				"emailmessage": "test@testSucesso.com",
				"timeZonecard": {
					"refIdcardHolder": "00000000-0000-1000-0000-000000000028"Alfredo Bernal",
				}"cardNumber": "123456*******7890",
				"languagedocument": {"07319150972"
			},
			"refIdpaymentUrl": "00000000-0000-1000-0000-000000000017"https://api.bempaggo.io/proxy/yapay/checkout/api/v3/transacao/1627652346504/20027340",
				}"paymentValue": 198055,
				"activeinterest": true0
			}
		}
	],
	"transaction],
	"mixedBundling": false,
    "splitPayment": {}false
}