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",
				"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": "number",
													"exampleminimum": 10
												},
												"isExclusivetaxRate": {
													"description": "ItemPorcentaje exclusivo:de falseimpuestos -aplicados Não exclusivo, true - exclusivoal artículo/componente",
													"type": "booleannumber",
													"exampleminimum": true0
												}
											},
											"requireddiscountList": [{
												"familyCodedescription",
												"code: "Lista de descuentos aplicados al artículo/componente, solo puede indicarse el tipo de descuento por venta fraccionada",
												"group"type": "array",
												"digitalCodeuniqueItems": true,
												"isExclusiveminItems": 1,
											]
"maxItems": 1,
											}"items": [
									},
			{
													"requiredtype": [
"object",
													"articleRefIdproperties",: {
										"totalItem",
				"rate": {
						"price",
										"originalPrice"description": "Indica el porcentaje del descuento",
										"markupRate",
											"taxes"type": "number",
										"taxRate",
										"discountListexclusiveMinimum": 0
									]
								},
							]
						}
					},
					"required"reason": [{
						"articleRefId",
						"student",
						"totalItemdescription",
						"price",
						"originalPrice",
						"taxes",
						"taxRate",
						"salesType",
: "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",
									"salesChannel",
						"salesOptiontype",
						"componentList": "string",
					]
				}
			]
		},
		"freightmaxLength": 4, {
			"type": "object",
			"properties": {
				"transportName": {
					"typeminLength": "string"4
				},
				"transportPhone": {
						"type": "string"
},
					},
				"transportCode": {
					"typeamount": "string"{
				},
						"orderNote": {
					"typedescription": "string"Indica el valor correspondiente al porcentaje del descuento",
				},
						"orderFreightValue": {
					"type": "number",
							},
								"orderDeliveryForecastexclusiveMinimum": {0
						"type": "string"
				},
				"orderEstablishment": {
}
						"type": "string"
				}
			},
					"required": [
				"transportName",
				"transportPhonerequired",: [
				"transportCode",
				"orderNote",
				"orderFreightValue",
				"orderDeliveryForecastrate",
				"orderEstablishment"
			]
		},
		"addressList": {
			"description": "Lista de domicilios asociados a la persona que realiza el pago",
			"type": "array",
			"uniqueItems": true,
			"minItems": 2,
reason",
														"maxItemsamount":
3,
				"items": [
				{
					"type": "object",
]
						"properties": {						}
											]
										},
										"addresssalesTerms": {
											"type": "object",
											"properties": {
												"addressTypefamilyCode": {
													"description": "IndicadorCódigo delda tipoFamília dedo domicilio,Produto solo| puedeLista tenerna 3plataforma valores| (Physical, Mailing, Shipping)Código da categoria",
													"type": "string",
													"maxLengthexample": 7,"idiomas"
									"minLength": 8
				},
				},
								"streetcode": {
													"typedescription": "string"
			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",
					},
								"outdoorNumbertype": {
"number",
													"typeexample": "string"1
												},
												"interiorNumbergroup": {
													"typedescription": "string"
			1-Avulso, 2-Agrupado",
					},
								"neighborhoodtype": {"number",
													"typeexample": "string"1
												},
												"citydigitalCode": {
													"typedescription": "string"
			Código ERP do produto digital | Caso o group == 2",
					},
								"postalCodetype": {"string",
													"typeexample": "string22006077"
												},
												"countyisExclusive": {
													"typedescription": "objectItem exclusivo: false - Não exclusivo, true - exclusivo",
													"propertiestype": {
"boolean",
													"refIdexample": {true
											"type": "string"	}
											},
											"formatrequired": [
"uuid												"familyCode",
												"maxLengthcode": 36,
												"minLengthgroup":,
36
												}"digitalCode",
												"countyCodeisExclusive": {
											"type": "string"
]
										}
									},
									"required": [
										"refIdarticleRefId",
										"countyCodetotalItem",
										]
"price",
										}"originalPrice",
										"contactmarkupRate":,
{
										"typepriceWithMarkup": "string"
,
										}"taxes",
										"phonetaxRate":,
{
										"typediscountList": "string,
										"salesTerms"
									},]
								"phone2": {
}
							]
			"type": "string"
			}
					},
								"positionrequired": {[
									"typearticleRefId":,
"string"
								}"student",
								"officeHourstotalItem":,
{
									"typeprice":,
"string"
								}"originalPrice",
								"emailtaxes": {
			,
						"typetaxRate": "string",
									"format": "email"salesType",
								}"salesChannel",
								"timeZonesalesOption": {,
									"typecomponentList": "object",
					]
				}
			]
		},
		"propertiesfreight": {
			"type": "object",
			"properties": {
				"refIdtransportName": {
											"type": "string",
				},
				"transportPhone": {
					"formattype": "uuidstring",
				},
							"maxLengthtransportCode": 36,
				{
							"minLengthtype": 36"string"
				},
						}"orderNote": {
					"type": "string"
				},
				"orderFreightValue": {
					"requiredtype": ["number"
						},
				"refIdorderDeliveryForecast": {
									]"type": "string"
								},
								"languageorderEstablishment": {
									"type": "objectstring",
				}
			},
			"propertiesrequired": {[
					"transportName",
					"refIdtransportPhone": {,
							"transportCode",
				"typeorderNote": "string",
							"orderFreightValue",
				"formatorderDeliveryForecast": "uuid",
				"orderEstablishment"
			]
		},
		"maxLengthaddressList": 36,
								{
			"minLengthdescription": "Lista 36
										}
									},
									"required": [
										"refId"
									]
								},
								"active": {
				de domicilios asociados a la persona que realiza el pago",
			"type": "array",
			"uniqueItems": true,
			"minItems": 2,
			"maxItems": 3,
			"items": [
				{
					"type": "booleanobject",
								}"properties": {
							},"address": {
							"requiredtype": ["object",
								"addressTypeproperties",: {
								"streetaddressType",: {
									"outdoorNumber",
description": "Indicador del tipo de domicilio, solo puede tener 3 valores (Physical, Mailing, Shipping)",
									"interiorNumbertype": "string",
									"neighborhoodmaxLength": 7,
									"cityminLength",: 8
								"postalCode"},
								"countystreet",: {
									"contact",type": "string"
								"phone"},
								"phone2outdoorNumber",: {
								"position",	"type": "string"
								"officeHours"},
								"emailinteriorNumber",: {
									"type": "timeZonestring",
								"language"},
								"activeneighborhood": {
									]"type": "string"
								},
					},
			"city": {
									"requiredtype": [ "string"
								},
								"addresspostalCode": {
					]
				}
"type": "string"
						]
		},
    								"invoiceDatacounty": {
      									"type": "object",
	      									"properties": {
        										"namerefId": {
          						"type"					"type": "string"
        		},
        ,
											"lastNameformat": {
          "uuid",
											"typemaxLength": 36,
"string"
        											"minLength": 36
										},
        										"documentcountyCode": {
          											"type": "string"
        										}
									},
        									"isLegalPersonrequired": {
          [
										"typerefId": "boolean"
        		}
      ,
										"countyCode"
									]
								},
      								"requiredcontact": [
        		"name",
        		"document",
        		"isLegalPerson"
      		]
    {
									"type": "string"
								},
		"transaction						"phone": {
									"type": "object",
      string"
								},
								"propertiesphone2": {
						        "transactionId": {
		        	"type": "integerstring"
			        },
		        "establishmentCode			},
								"position": {
								          	"type": "integerstring"
			        					},
								        "paymentMethodCode"officeHours": {
		          							"type": "integerstring"
        								},
								        "value"email": {
					          					"type": "integerstring",
									"format":        "email"
								},
		        "valueDiscount						"timeZone": {
		          							"type": "integerobject",
									"properties":        },
		        "installments{
										"refId": {
        		  											"type": "integerstring",
			        },
		        "status": {
        		  	"type								"format": "integeruuid",
								        },
		        "authorization			"maxLength": {36,
		          	"type									"minLength": "string"36
		        								}
									},
					        "operatorTransactionCode				"required": {[
		          	"type": "string"
		        },
        		"operatorApprovalDate										"refId"
									]
								},
								"language": {
		          							"type": "stringobject",
							        },
		        "receipt"properties": {
				          	"type": "string"
		        },
		        "nsu						"refId": {
		          											"type": "string",
		        },
		        "message": {
		          	"type									"format": "stringuuid",
		        },
		        "card": {
					"description": "Datos de la tarjeta, este campo solo es obligatorio cuando el pago es con tarjeta",
          			"type": "object",
          			"properties": {
            			"cardHolder											"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": "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",
						"establishmentCode",
						"examplespaymentMethodCode": ["123456*******7890"],
              ,
						"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",
			"documenttype"
         : boolean,
			]
        "example": true
		},
  
     		"paymentUrlmultipleBusinesses": {
					"description": "EsteIndicador campode esque obligatorioel cuandopago es un pago fraccionadoparte de una compra multi-sello",
			"type": boolean,
			"example": false
		}
	},
	"required": [
		"external",
		"paymentDate",
		"parentGuardian",
		"typepaymentMethod":,
		"stringprice",
		"originalPrice",
		"taxes",
     		"taxRate",
		"itemList",
		}"freight",
		"addressList",
		"paymentValueinvoiceData": {,
			"transaction",
		"typesplitPayment":,
		"integermixedBundling",
				},
				"interest"multipleBusinesses"
	]
}


Code Block
languagejs
titleEjemplo - Pago por paquete
collapsetrue
{
	"external": {
					"descriptionorderId": "Es la diferencia entre paymentValue menos value9d4d296d-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
languagejs
titleEjemplo - Pago por paquete
collapsetrue
{
	"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
languagejs
titleEjemplo - Pago fraccionado
collapsetrue
{
	"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
languagejs
titleEjemplo - Pago fraccionado
collapsetrue
{
	"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
}