Vtex Createpayment Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "CreatePayment",
"method": "POST",
"path": "/payments",
"summary": "VTex Create payment",
"requestExamples": [
{
"contentType": "application/json",
"name": "Credit Card Success Approved",
"example": {
"reference": "618272",
"orderId": "1072430428324",
"shopperInteraction": "ecommerce",
"transactionId": "2F023FD5A72A49D48A8633252B7CCBD6",
"paymentId": "01693EB95BE443AC85874E395CD91565",
"paymentMethod": "Diners",
"paymentMethodCustomCode": null,
"merchantName": "mystore",
"card": {
"holder": "John Doe",
"number": "364901****2661",
"csc": "***",
"expiration": {
"month": "12",
"year": "2020"
},
"document": "39295416023",
"token": null
},
"value": 31.9,
"referenceValue": 31.9,
"currency": "BRL",
"installments": 1,
"installmentsInterestRate": 0,
"installmentsValue": 31.9,
"deviceFingerprint": "75076388",
"ipAddress": "187.105.111.65",
"miniCart": {
"buyer": {
"id": "c1245228-1c68-11e6-94ac-0afa86a846a5",
"firstName": "John",
"lastName": "Doe",
"document": "01234567890",
"documentType": "cpf",
"corporateName": null,
"tradeName": null,
"corporateDocument": null,
"isCorporate": false,
"email": "john.doe@example.com",
"phone": "+5521999999999",
"createdDate": "2020-02-18T18:17:45"
},
"shippingAddress": {
"country": "BRA",
"street": "Praia de Botafogo St.",
"number": "300",
"complement": "3rd Floor",
"neighborhood": "Botafogo",
"postalCode": "22250040",
"city": "Rio de Janeiro",
"state": "RJ"
},
"billingAddress": {
"country": "BRA",
"street": "Brigadeiro Faria Lima Avenue",
"number": "4440",
"complement": "10th Floor",
"neighborhood": "Itaim Bibi",
"postalCode": "04538132",
"city": "S\u00e3o Paulo",
"state": "SP"
},
"items": [
{
"id": "8",
"name": "Tenis Preto I",
"price": 30.9,
"quantity": 1,
"discount": 0,
"deliveryType": "Normal",
"categoryId": "5",
"sellerId": "1"
}
],
"shippingValue": 1,
"taxValue": 0
},
"url": "https://admin.mystore.example.com/orders?q=1072430428324",
"callbackUrl": "https://api.mystore.example.com/some-path/to-notify/status-changes?an=mystore",
"returnUrl": "https://mystore.example.com/checkout/order/1072430428324",
"inboundRequestsUrl": "https://api.mystore.example.com/checkout/order/1072430428324/inbound-request/:action",
"recipients": [
{
"id": "mymarketplace",
"name": "My Marketplace QA",
"documentType": "CNPJ",
"document": "99999999999999",
"role": "marketplace",
"chargeProcessingFee": true,
"chargebackLiable": true,
"amount": 31.9
}
],
"merchantSettings": [
{
"name": "field1",
"value": "value1"
},
{
"name": "field2",
"value": "value2"
}
],
"connectorMetadata": [
{
"name": "MetadataName",
"value": "MetadataValue"
}
]
}
},
{
"contentType": "application/json",
"name": "Pix Success Approved",
"example": {
"reference": "32478982",
"orderId": "v967373115140abc",
"shopperInteraction": "ecommerce",
"transactionId": "D3AA1FC8372E430E8236649DB5EBD08E",
"paymentId": "F5C1A4E20D3B4E07B7E871F5B5BC9F91",
"paymentMethod": "Pix",
"paymentMethodCustomCode": null,
"merchantName": "mystore",
"value": 4307.23,
"referenceValue": 4307.23,
"currency": "BRL",
"installments": 1,
"deviceFingerprint": "15ace369587ha",
"card": {
"holder": null,
"number": null,
"csc": null,
"expiration": {
"month": null,
"year": null
}
},
"miniCart": {
"shippingValue": 11.44,
"taxValue": 10.01,
"buyer": {
"id": "c1245228-1c68-11e6-94ac-0afa86a846a5",
"firstName": "John",
"lastName": "Doe",
"document": "01234567890",
"documentType": "cpf",
"email": "john.doe@example.com",
"phone": "+5521999999999"
},
"shippingAddress": {
"country": "BRA",
"street": "Praia de Botafogo St.",
"number": "300",
"complement": "3rd Floor",
"neighborhood": "Botafogo",
"postalCode": "22250040",
"city": "Rio de Janeiro",
"state": "RJ"
},
"billingAddress": {
"country": "BRA",
"street": "Brigadeiro Faria Lima Avenue",
"number": "4440",
"complement": "10th Floor",
"neighborhood": "Itaim Bibi",
"postalCode": "04538132",
"city": "S\u00e3o Paulo",
"state": "SP"
},
"items": [
{
"id": "132981",
"name": "My First Product",
"price": 2134.9,
"quantity": 2,
"discount": 5
},
{
"id": "123242",
"name": "My Second Product",
"price": 21.98,
"quantity": 1,
"discount": 1
}
]
},
"url": "https://admin.mystore.example.com/orders/v32478982",
"callbackUrl": "https://api.example.com/some-path/to-notify/status-changes?an=mystore",
"returnUrl": "https://mystore.example.com/checkout/order/v32478982"
}
},
{
"contentType": "application/json",
"name": "Success Undefined",
"example": {
"reference": "32478982",
"orderId": "v967373115140abc",
"shopperInteraction": "ecommerce",
"transactionId": "D3AA1FC8372E430E8236649DB5EBD08E",
"paymentId": "F5C1A4E20D3B4E07B7E871F5B5BC9F91",
"paymentMethod": "Visa",
"paymentMethodCustomCode": null,
"merchantName": "mystore",
"value": 4307.23,
"referenceValue": 4000,
"currency": "BRL",
"installments": 3,
"deviceFingerprint": "12ade389087fe",
"card": {
"holder": "John Doe",
"number": "4682185088924788",
"csc": "021",
"expiration": {
"month": "06",
"year": "2029"
}
},
"miniCart": {
"shippingValue": 11.44,
"taxValue": 10.01,
"buyer": {
"id": "c1245228-1c68-11e6-94ac-0afa86a846a5",
"firstName": "John",
"lastName": "Doe",
"document": "01234567890",
"documentType": "CPF",
"email": "john.doe@example.com",
"phone": "+5521987654321"
},
"shippingAddress": {
"country": "BRA",
"street": "Praia de Botafogo St.",
"number": "300",
"complement": "3rd Floor",
"neighborhood": "Botafogo",
"postalCode": "22250040",
"city": "Rio de Janeiro",
"state": "RJ"
},
"billingAddress": {
"country": "BRA",
"street": "Brigadeiro Faria Lima Avenue",
"number": "4440",
"complement": "10th Floor",
"neighborhood": "Itaim Bibi",
"postalCode": "04538132",
"city": "S\u00e3o Paulo",
"state": "SP"
},
"items": [
{
"id": "132981",
"name": "My First Product",
"price": 2134.9,
"quantity": 2,
"discount": 5
},
{
"id": "123242",
"name": "My Second Product",
"price": 21.98,
"quantity": 1,
"discount": 1
}
]
},
"url": "https://admin.mystore.example.com/orders/v32478982",
"callbackUrl": "https://api.example.com/some-path/to-notify/status-changes?an=mystore",
"returnUrl": "https://mystore.example.com/checkout/order/v32478982"
}
},
{
"contentType": "application/json",
"name": "BankInvoice Success Undefined",
"example": {
"reference": "32478982",
"orderId": "v967373115140abc",
"shopperInteraction": "ecommerce",
"transactionId": "D3AA1FC8372E430E8236649DB5EBD08E",
"paymentId": "F5C1A4E20D3B4E07B7E871F5B5BC9F91",
"paymentMethod": "BankInvoice",
"paymentMethodCustomCode": null,
"merchantName": "mystore",
"value": 4307.23,
"referenceValue": 4307.23,
"currency": "BRL",
"installments": 1,
"deviceFingerprint": "12ade389087fe",
"card": {
"holder": null,
"number": null,
"csc": null,
"expiration": {
"month": null,
"year": null
}
},
"miniCart": {
"shippingValue": 11.44,
"taxValue": 10.01,
"buyer": {
"id": "c1245228-1c68-11e6-94ac-0afa86a846a5",
"firstName": "John",
"lastName": "Doe",
"document": "01234567890",
"documentType": "CPF",
"email": "john.doe@example.com",
"phone": "+5521987654321"
},
"shippingAddress": {
"country": "BRA",
"street": "Praia de Botafogo St.",
"number": "300",
"complement": "3rd Floor",
"neighborhood": "Botafogo",
"postalCode": "22250040",
"city": "Rio de Janeiro",
"state": "RJ"
},
"billingAddress": {
"country": "BRA",
"street": "Brigadeiro Faria Lima Avenue",
"number": "4440",
"complement": "10th Floor",
"neighborhood": "Itaim Bibi",
"postalCode": "04538132",
"city": "S\u00e3o Paulo",
"state": "SP"
},
"items": [
{
"id": "132981",
"name": "My First Product",
"price": 2134.9,
"quantity": 2,
"discount": 5
},
{
"id": "123242",
"name": "My Second Product",
"price": 21.98,
"quantity": 1,
"discount": 1
}
]
},
"url": "https://admin.mystore.example.com/orders/v32478982",
"callbackUrl": "https://api.example.com/some-path/to-notify/status-changes?an=mystore",
"returnUrl": "https://mystore.example.com/checkout/order/v32478982"
}
},
{
"contentType": "application/json",
"name": "Success Denied",
"example": {
"reference": "32478982",
"orderId": "v967373115140abc",
"shopperInteraction": "ecommerce",
"transactionId": "D3AA1FC8372E430E8236649DB5EBD08E",
"paymentId": "F5C1A4E20D3B4E07B7E871F5B5BC9F91",
"paymentMethod": "Visa",
"paymentMethodCustomCode": null,
"merchantName": "mystore",
"value": 4307.23,
"referenceValue": 4000,
"currency": "BRL",
"installments": 3,
"deviceFingerprint": "12ade389087fe",
"card": {
"holder": "John Doe",
"number": "4682185088924788",
"csc": "021",
"expiration": {
"month": "06",
"year": "2029"
}
},
"miniCart": {
"shippingValue": 11.44,
"taxValue": 10.01,
"buyer": {
"id": "c1245228-1c68-11e6-94ac-0afa86a846a5",
"firstName": "John",
"lastName": "Doe",
"document": "01234567890",
"documentType": "CPF",
"email": "john.doe@example.com",
"phone": "+5521987654321"
},
"shippingAddress": {
"country": "BRA",
"street": "Praia de Botafogo St.",
"number": "300",
"complement": "3rd Floor",
"neighborhood": "Botafogo",
"postalCode": "22250040",
"city": "Rio de Janeiro",
"state": "RJ"
},
"billingAddress": {
"country": "BRA",
"street": "Brigadeiro Faria Lima Avenue",
"number": "4440",
"complement": "10th Floor",
"neighborhood": "Itaim Bibi",
"postalCode": "04538132",
"city": "S\u00e3o Paulo",
"state": "SP"
},
"items": [
{
"id": "132981",
"name": "My First Product",
"price": 2134.9,
"quantity": 2,
"discount": 5
},
{
"id": "123242",
"name": "My Second Product",
"price": 21.98,
"quantity": 1,
"discount": 1
}
]
},
"url": "https://admin.mystore.example.com/orders/v32478982",
"callbackUrl": "https://api.example.com/some-path/to-notify/status-changes?an=mystore",
"returnUrl": "https://mystore.example.com/checkout/order/v32478982"
}
},
{
"contentType": "application/json",
"name": "BankInvoice Success Approved",
"example": {
"reference": "618272",
"orderId": "1072430428324",
"shopperInteraction": "ecommerce",
"transactionId": "2F023FD5A72A49D48A8633252B7CCBD6",
"paymentId": "01693EB95BE443AC85874E395CD91565",
"paymentMethod": "BankInvoice",
"paymentMethodCustomCode": null,
"merchantName": "mystore",
"card": {
"holder": "null",
"number": "null",
"csc": "null",
"expiration": {
"month": "null",
"year": "null"
}
},
"document": null,
"token": null,
"value": 31.9,
"referenceValue": 31.9,
"currency": "BRL",
"installments": 1,
"installmentsInterestRate": 0,
"installmentsValue": 31.9,
"deviceFingerprint": "98073964",
"ipAddress": "187.105.111.65",
"miniCart": {
"buyer": {
"id": "c1245228-1c68-11e6-94ac-0afa86a846a5",
"firstName": "John",
"lastName": "Doe",
"document": "01234567890",
"documentType": "cpf",
"corporateName": null,
"tradeName": null,
"corporateDocument": null,
"isCorporate": false,
"email": "john.doe@example.com",
"phone": "+5521999999999",
"createdDate": "2020-02-18T18:17:45"
},
"shippingAddress": {
"country": "BRA",
"street": "Praia de Botafogo St.",
"number": "300",
"complement": "3rd Floor",
"neighborhood": "Botafogo",
"postalCode": "22250040",
"city": "Rio de Janeiro",
"state": "RJ"
},
"billingAddress": {
"country": "BRA",
"street": "Brigadeiro Faria Lima Avenue",
"number": "4440",
"complement": "10th Floor",
"neighborhood": "Itaim Bibi",
"postalCode": "04538132",
"city": "S\u00e3o Paulo",
"state": "SP"
},
"items": [
{
"id": "8",
"name": "Tenis Preto I",
"price": 30.9,
"quantity": 1,
"discount": 0,
"deliveryType": "Normal",
"categoryId": "5",
"sellerId": "1"
}
],
"shippingValue": 11.44,
"taxValue": 10.01
},
"url": "https://admin.mystore.example.com/orders?q=1072430428324",
"callbackUrl": "https://api.example.com/some-path/to-notify/status-changes?an=mystore",
"returnUrl": "https://mystore.example.com/checkout/order/1072430428324",
"inboundRequestsUrl": "https://api.mystore.example.com/checkout/order/1072430428324/inbound-request/:action",
"recipients": [
{
"id": "mymarketplace",
"name": "My Marketplace QA",
"documentType": "CNPJ",
"document": "99999999999999",
"role": "marketplace",
"chargeProcessingFee": true,
"chargebackLiable": true,
"amount": 31.9
}
],
"merchantSettings": [
{
"name": "field1",
"value": "value1"
},
{
"name": "field2",
"value": "value2"
}
]
}
},
{
"contentType": "application/json",
"name": "Payment App + Inbound Request Success Undefined",
"example": {
"reference": "32478982",
"orderId": "v967373115140abc",
"shopperInteraction": "ecommerce",
"transactionId": "D3AA1FC8372E430E8236649DB5EBD08E",
"paymentId": "F5C1A4E20D3B4E07B7E871F5B5BC9F91",
"paymentMethod": "CustomPay",
"paymentMethodCustomCode": null,
"merchantName": "mystore",
"value": 4307.23,
"referenceValue": 4307.23,
"currency": "BRL",
"installments": 1,
"deviceFingerprint": "12ade389087fe",
"card": {
"holder": null,
"number": null,
"csc": null,
"expiration": {
"month": null,
"year": null
}
},
"miniCart": {
"shippingValue": 11.44,
"taxValue": 10.01,
"buyer": {
"id": "c1245228-1c68-11e6-94ac-0afa86a846a5",
"firstName": "John",
"lastName": "Doe",
"document": "01234567890",
"documentType": "CPF",
"email": "john.doe@example.com",
"phone": "+5521987654321"
},
"shippingAddress": {
"country": "BRA",
"street": "Praia de Botafogo St.",
"number": "300",
"complement": "3rd Floor",
"neighborhood": "Botafogo",
"postalCode": "22250040",
"city": "Rio de Janeiro",
"state": "RJ"
},
"billingAddress": {
"country": "BRA",
"street": "Brigadeiro Faria Lima Avenue",
"number": "4440",
"complement": "10th Floor",
"neighborhood": "Itaim Bibi",
"postalCode": "04538132",
"city": "S\u00e3o Paulo",
"state": "SP"
},
"items": [
{
"id": "132981",
"name": "My First Product",
"price": 2134.9,
"quantity": 2,
"discount": 5
},
{
"id": "123242",
"name": "My Second Product",
"price": 21.98,
"quantity": 1,
"discount": 1
}
]
},
"url": "https://admin.mystore.example.com/orders/v32478982",
"callbackUrl": "https://api.example.com/some-path/to-notify/status-changes?an=mystore",
"returnUrl": "https://mystore.example.com/checkout/order/v32478982",
"inboundRequestsUrl": "https://mystore.api.example.com/some-path/inbound-request/:action"
}
},
{
"contentType": "application/json",
"name": "Redirect Success Undefined",
"example": {
"reference": "32478982",
"orderId": "v967373115140abc",
"shopperInteraction": "ecommerce",
"transactionId": "D3AA1FC8372E430E8236649DB5EBD08E",
"paymentId": "F5C1A4E20D3B4E07B7E871F5B5BC9F91",
"paymentMethod": "FakePay",
"paymentMethodCustomCode": null,
"merchantName": "mystore",
"value": 4307.23,
"referenceValue": 4307.23,
"currency": "BRL",
"installments": 1,
"deviceFingerprint": "12ade389087fe",
"card": {
"holder": null,
"number": null,
"csc": null,
"expiration": {
"month": null,
"year": null
}
},
"miniCart": {
"shippingValue": 11.44,
"taxValue": 10.01,
"buyer": {
"id": "c1245228-1c68-11e6-94ac-0afa86a846a5",
"firstName": "John",
"lastName": "Doe",
"document": "01234567890",
"documentType": "CPF",
"email": "john.doe@example.com",
"phone": "+5521987654321"
},
"shippingAddress": {
"country": "BRA",
"street": "Praia de Botafogo St.",
"number": "300",
"complement": "3rd Floor",
"neighborhood": "Botafogo",
"postalCode": "22250040",
"city": "Rio de Janeiro",
"state": "RJ"
},
"billingAddress": {
"country": "BRA",
"street": "Brigadeiro Faria Lima Avenue",
"number": "4440",
"complement": "10th Floor",
"neighborhood": "Itaim Bibi",
"postalCode": "04538132",
"city": "S\u00e3o Paulo",
"state": "SP"
},
"items": [
{
"id": "132981",
"name": "My First Product",
"price": 2134.9,
"quantity": 2,
"discount": 5
},
{
"id": "123242",
"name": "My Second Product",
"price": 21.98,
"quantity": 1,
"discount": 1
}
]
},
"url": "https://admin.mystore.example.com/orders/v32478982",
"callbackUrl": "https://api.example.com/some-path/to-notify/status-changes?an=mystore",
"returnUrl": "https://mystore.example.com/checkout/order/v32478982"
}
},
{
"contentType": "application/json",
"name": "Redirect Success Approved",
"example": {
"reference": "618272",
"orderId": "1072430428324",
"shopperInteraction": "ecommerce",
"transactionId": "2F023FD5A72A49D48A8633252B7CCBD6",
"paymentId": "01693EB95BE443AC85874E395CD91565",
"paymentMethod": "RedirectPay",
"paymentMethodCustomCode": null,
"merchantName": "mystore",
"value": 31.9,
"referenceValue": 31.9,
"currency": "BRL",
"installments": 1,
"installmentsInterestRate": 0,
"installmentsValue": 31.9,
"deviceFingerprint": "75076388",
"ipAddress": "187.105.111.65",
"miniCart": {
"buyer": {
"id": "c1245228-1c68-11e6-94ac-0afa86a846a5",
"firstName": "John",
"lastName": "Doe",
"document": "01234567890",
"documentType": "cpf",
"corporateName": null,
"tradeName": null,
"corporateDocument": null,
"isCorporate": false,
"email": "john.doe@example.com",
"phone": "+5521999999999",
"createdDate": "2020-02-18T18:17:45"
},
"shippingAddress": {
"country": "BRA",
"street": "Praia de Botafogo St.",
"number": "300",
"complement": "3rd Floor",
"neighborhood": "Botafogo",
"postalCode": "22250040",
"city": "Rio de Janeiro",
"state": "RJ"
},
"billingAddress": {
"country": "BRA",
"street": "Brigadeiro Faria Lima Avenue",
"number": "4440",
"complement": "10th Floor",
"neighborhood": "Itaim Bibi",
"postalCode": "04538132",
"city": "S\u00e3o Paulo",
"state": "SP"
},
"items": [
{
"id": "8",
"name": "Tenis Preto I",
"price": 30.9,
"quantity": 1,
"discount": 0,
"deliveryType": "Normal",
"categoryId": "5",
"sellerId": "1"
}
],
"shippingValue": 1,
"taxValue": 0
},
"url": "https://admin.mystore.example.com/orders/v32478982",
"callbackUrl": "https://api.example.com/some-path/to-notify/status-changes?an=mystore",
"returnUrl": "https://mystore.example.com/checkout/order/v32478982",
"inboundRequestsUrl": "https://api.mystore.example.com/checkout/order/1072430428324/inbound-request/:action",
"recipients": [
{
"id": "mymarketplace",
"name": "My Marketplace QA",
"documentType": "CNPJ",
"document": "99999999999999",
"role": "marketplace",
"chargeProcessingFee": true,
"chargebackLiable": true,
"amount": 31.9
}
],
"merchantSettings": [
{
"name": "field1",
"value": "value1"
},
{
"name": "field2",
"value": "value2"
}
]
}
},
{
"contentType": "application/json",
"name": "Fail Generic Error",
"example": {
"reference": "32478982",
"orderId": "v967373115140abc",
"shopperInteraction": "ecommerce",
"transactionId": "D3AA1FC8372E430E8236649DB5EBD08E",
"paymentId": "F5C1A4E20D3B4E07B7E871F5B5BC9F91",
"paymentMethod": "Visa",
"paymentMethodCustomCode": null,
"merchantName": "mystore",
"value": 4307.23,
"referenceValue": 4000,
"currency": "BRL",
"installments": 3,
"deviceFingerprint": "12ade389087fe",
"card": {
"holder": "John Doe",
"number": "4682185088924788",
"csc": "021",
"expiration": {
"month": "06",
"year": "2029"
}
},
"miniCart": {
"shippingValue": 11.44,
"taxValue": 10.01,
"buyer": {
"id": "c1245228-1c68-11e6-94ac-0afa86a846a5",
"firstName": "John",
"lastName": "Doe",
"document": "01234567890",
"documentType": "CPF",
"email": "john.doe@example.com",
"phone": "+5521987654321"
},
"shippingAddress": {
"country": "BRA",
"street": "Praia de Botafogo St.",
"number": "300",
"complement": "3rd Floor",
"neighborhood": "Botafogo",
"postalCode": "22250040",
"city": "Rio de Janeiro",
"state": "RJ"
},
"billingAddress": {
"country": "BRA",
"street": "Brigadeiro Faria Lima Avenue",
"number": "4440",
"complement": "10th Floor",
"neighborhood": "Itaim Bibi",
"postalCode": "04538132",
"city": "S\u00e3o Paulo",
"state": "SP"
},
"items": [
{
"id": "132981",
"name": "My First Product",
"price": 2134.9,
"quantity": 2,
"discount": 5
},
{
"id": "123242",
"name": "My Second Product",
"price": 21.98,
"quantity": 1,
"discount": 1
}
]
},
"url": "https://admin.mystore.example.com/orders/v32478982",
"callbackUrl": "https://api.example.com/some-path/to-notify/status-changes?an=mystore",
"returnUrl": "https://mystore.example.com/checkout/order/v32478982"
}
},
{
"contentType": "application/json",
"name": "Fail Bad Request",
"example": {
"reference": "32478982",
"orderId": "v967373115140abc",
"shopperInteraction": "ecommerce",
"transactionId": "D3AA1FC8372E430E8236649DB5EBD08E",
"paymentId": "F5C1A4E20D3B4E07B7E871F5B5BC9F91",
"paymentMethod": "Visa",
"paymentMethodCustomCode": null,
"merchantName": "mystore",
"value": 4307.23,
"referenceValue": 4000,
"currency": "BRL",
"installments": 3,
"deviceFingerprint": "12ade389087fe",
"card": {
"holder": "John Doe",
"number": "4682185088924788",
"csc": "021",
"expiration": {
"month": "06",
"year": "2029"
}
},
"miniCart": {
"shippingValue": 11.44,
"taxValue": 10.01,
"buyer": {
"id": "c1245228-1c68-11e6-94ac-0afa86a846a5",
"firstName": "John",
"lastName": "Doe",
"document": "01234567890",
"documentType": "CPF",
"email": "john.doe@example.com",
"phone": "+5521987654321"
},
"shippingAddress": {
"country": "BRA",
"street": "Praia de Botafogo St.",
"number": "300",
"complement": "3rd Floor",
"neighborhood": "Botafogo",
"postalCode": "22250040",
"city": "Rio de Janeiro",
"state": "RJ"
},
"billingAddress": {
"country": "BRA",
"street": "Brigadeiro Faria Lima Avenue",
"number": "4440",
"complement": "10th Floor",
"neighborhood": "Itaim Bibi",
"postalCode": "04538132",
"city": "S\u00e3o Paulo",
"state": "SP"
},
"items": [
{
"id": "132981",
"name": "My First Product",
"price": 2134.9,
"quantity": 2,
"discount": 5
},
{
"id": "123242",
"name": "My Second Product",
"price": 21.98,
"quantity": 1,
"discount": 1
}
]
},
"url": "https://admin.mystore.example.com/orders/v32478982",
"callbackUrl": "https://api.example.com/some-path/to-notify/status-changes?an=mystore",
"returnUrl": "https://mystore.example.com/checkout/order/v32478982"
}
}
],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"name": "Success",
"example": {
"paymentId": "F5C1A4E20D3B4E07B7E871F5B5BC9F91",
"status": "approved",
"authorizationId": "AUT123567",
"nsu": "NSU987432",
"tid": "TID1578324421",
"acquirer": "FooBarPayments",
"delayToAutoSettle": 432000,
"delayToAutoSettleAfterAntifraud": 120,
"delayToCancel": 600,
"connectorMetadata": [
{
"name": "MetadataName",
"value": "MetadataValue"
}
]
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Success - PIX",
"example": {
"paymentId": "F5C1A4E20D3B4E07B7E871F5B5BC9F91",
"status": "undefined",
"tid": "TID1578324421",
"authorizationId": null,
"nsu": null,
"code": "APP123",
"paymentAppData": {
"payload": "{\"code\":\"https://bacen.pix/pix/code\",\"qrCodeBase64Image\":\"iVBORw0KGgoAAAANSUhEUgAAAAIAAAACCAYAAABytg0kAAABQGlDQ1BJQ0MgUHJvZmlsZQAAKJFjYGDiSSwoyGFhYGDIzSspCnJ3UoiIjFJgf8LAxSDMwMkgwiCZmFxc4BgQ4ANUwgCjUcG3awyMIPqyLsgspwWXFu+Xeyundb6w0WL33C5M9SiAKyW1OBlI/wHihOSCohIGBsYYIFu5vKQAxG4AskWKgI4CsqeA2OkQ9goQOwnC3gNWExLkDGRfALIFkjMSU4DsB0C2ThKSeDoSG2ovCLAZGZkbhBNwKKmgJLWiBEQ75xdUFmWmZ5QoOAJDJ1XBMy9ZT0fByMDIgIEBFNYQ1Z9vgMOQUYwDIZapzMBgmQEUfIQQSxNmYNiZzsDAU4UQU5/PwMBrxMBw5GJBYlEi3AGM31iK04yNIGzu7QwMrNP+//8M9Ca7JgPD3+v////e/v//32UMDMy3GBgOfAMA4+RdqZ9YRkcAAABWZVhJZk1NACoAAAAIAAGHaQAEAAAAAQAAABoAAAAAAAOShgAHAAAAEgAAAESgAgAEA
# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vtex/refs/heads/main/examples/vtex-createpayment-example.json