Criar venda VTEX

Use este endpoint para fazer uma venda VTEX.

curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/acheron/vtex/payments?meioPagamento=SOFTWARE_EXPRESS' \ --header 'X-VTEX-API-AppKey;' \ --header 'X-VTEX-API-AppToken;' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'accept: */*' \ --header 'Content-Type: application/json' \ --data-raw '{ "paymentId": "358678", "paymentMethod": "SOFTWARE_EXPRESS", "merchantName": "TesteAut", "card": { "number": "6505000000002001", "holder": "PORTADOR MOCK", "expiration": { "month": "11", "year": "28" }, "csc": "111", "document": "01234567890" }, "value": 23.33, "currency": "986", "installments": 2, "adminInstallments": "N", "reference": "Referência do produto.", "transactionId": "123", "installmentsInterestRate": "0", "installmentsValue": "0", "deviceFingerprint": "Mozilla/5.0 (X11; Linux x86_64; rv:90.0) Gecko/20100101 Firefox/90.0", "miniCart": { "buyer": { "id": "1", "firstName": "Francisco", "lastName": "Silva", "document": "08974930284", "documentType": "CPF", "email": "francisco@teste.com", "phone": "98996788293" }, "shippingAddress": { "country": "Brasil", "street": "Rua da Amizade", "number": "420", "complement": "Casa", "neighborhood": "Centro", "postalCode": "58000000", "city": "João Pessoa", "state": "PB" }, "billingAddress": { "country": "Brasil", "street": "Rua da Amizade", "number": "420", "complement": "Casa", "neighborhood": "Centro", "postalCode": "58000000", "city": "João Pessoa", "state": "PB" }, "items": [ { "id": "1", "name": "Produto 01", "price": 25, "quantity": 2, "discount": 0 }, { "id": "1", "name": "Produto 01", "price": 25, "quantity": 2, "discount": 0 } ], "shippingValue": 10, "taxValue": 0 }, "url": "http:www.example.com/index.html", "callbackUrl": "http://example.com/index.html", "returnUrl": "http://localhost/#/location1" }'

{ "timestamp": "2019-08-24T14:15:22Z", "statusCode": 0, "error": "string", "message": "string", "path": "string", "fieldErrors": [ { "objectName": "string", "field": "string", "message": "string" } ] }

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Query

meioPagamento

enum<string>

requerido

O meio de pagamento usado na transação.

Valores permitidos:

AUTTARCABALCLOUDWALKECOMMERCEGOOD_CARDINGENICOIPFT_WEBITAUTECPAY_GORESOMAQSKYTEFURAURA_2VEROMERCISOFTWARE_EXPRESSDIRECAOTEF_NEUSCONDUCTOR_TEFECOMMERCE_CABALECOMMERCE_VTEXECOMMERCE_APITOTEMQRCODEAPITOTEM_EXTERNOSNXPIXPAYFACE

Exemplo:

SOFTWARE_EXPRESS

Parâmetros Header

X-VTEX-API-AppKey

string

requerido

AppKey configurada e fornecida pela RPE. Em caso de testes com a processadora Cards, utilize o valor 5afHXDAuO0CM6hyPpNeBUYkrS31jMK. Para testes com a processadora Dock, utilize o valor xsfa7x3oIPelAKu4Gy314wggF9PfOk.

Exemplo:

5afHXDAuO0CM6hyPpNeBUYkrS31jMKxsfa7x3oIPelAKu4Gy314wggF9PfOk

X-VTEX-API-AppToken

string

requerido

AppToken configurado e fornecido pela RPE. m caso de testes com a processadora Cards, utilize o valor rpacHjeg2gsuHwrjHVHn7Giy6fZ3RC. Para testes com a processadora Dock, utilize o valor HpbgImF1ViUM0xQLUVa9k9ryNCkdh5.

Exemplo:

rpacHjeg2gsuHwrjHVHn7Giy6fZ3RCHpbgImF1ViUM0xQLUVa9k9ryNCkdh5

Authorization

string

opcional

Header HTTP utilizado para autenticação do cliente. O valor deve ser um token JWT válido precedido do prefixo Bearer.

Exemplo:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ

Content-Type

string

requerido

Tipo de mídia do corpo da solicitação.

Padrão:

application/json

Exemplo:

application/json

string

opcional

Tipo do conteúdo aceito.

Padrão:

*/*

Exemplo:

*/*

Parâmetros Bodyapplication/json

paymentId

string

requerido

Identificador do pagamento.

Em caso de testes com a processadora Cards, utilize o valor 358678. Para testes com a processadora Dock, utilize o valor 846157

Exemplo:

358678846157

paymentMethod

string

requerido

Método de pagamento.

Exemplo:

SOFTWARE_EXPRESS

merchantName

string

requerido

Nome do estabelecimento.

Exemplo:

TesteAut

card

object

requerido

Informações sobre o cartão.

number

string

requerido

Número mascarado do cartão.

Exemplo:

6505000000002001

holder

string

requerido

Nome do portador do cartão.

Exemplo:

PORTADOR MOCK

expiration

object

requerido

Informações sobre a data de validade do cartão.

csc

string

requerido

Código de segurança do cartão.

Exemplo:

111

document

string

requerido

Documento do portador do cartão.

Exemplo:

01234567890

value

number <double>

requerido

Valor da transação.

Em caso de testes com a processadora Cards, utilize o valor 23.33. Para testes com a processadora Dock, utilize o valor 20.74

Padrão:

23.33

Exemplo:

23.3320.74

currency

string

requerido

Moeda da transação.

Exemplo:

986

installments

integer <int32>

requerido

Número de parcelas.

Exemplo:

adminInstallments

string

requerido

Indica se a transação foi parcelada pela administradora.

Exemplo:

reference

string

opcional

Referência

Exemplo:

Referência do produto.

transactionId

string

opcional

Identificador da transação.

Exemplo:

123

installmentsInterestRate

string

opcional

Taxa de juros da parcela.

Exemplo:

installmentsValue

string

opcional

Valor da parcela.

Exemplo:

deviceFingerprint

string

opcional

Identificador do dispositivo.

Exemplo:

Mozilla/5.0 (X11; Linux x86_64; rv:90.0) Gecko/20100101 Firefox/90.0

miniCart

object

opcional

Carrinho.

buyer

object

opcional

Comprador.

shippingAddress

object

opcional

Endereço de entrega.

billingAddress

object

opcional

items

array [object {5}]

opcional

Informações dos itens.

shippingValue

number

opcional

Valor do frete.

Exemplo:

taxValue

number

opcional

Valor de impostos.

Exemplo:

url

string

opcional

URL.

Exemplo:

http:www.example.com/index.html

callbackUrl

string

opcional

URL da rotina.

Exemplo:

http://example.com/index.html

returnUrl

string

opcional

URL de redirecionamento.

Exemplo:

http://localhost/#/location1

Examples

Respostas

🟠400Pedido inválido

application/json

Erro 400 - Solicitação inválida

Body

timestamp

string <date-time>

opcional

Data e hora em que o erro ocorreu, em formato YYYY-MM-DDTHH:MM:SS.u.

statusCode

integer

opcional

Status do erro. Erro 400 significa solicitação inválida.

Exemplo:

400

error

string

opcional

Tipo de erro.

message

string

opcional

Mensagem relacionada ao erro.

path

string

opcional

Path relacionado ao erro.

fieldErrors

array[object (fieldErrors) {3}]

opcional

Informações relacionadas ao erro.

objectName

string

opcional

Objeto relacionado ao erro.

field

string

opcional

Campo relacionado ao erro.

message

string

opcional

Mensagem relacionada ao erro.

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor

🟢200OK