Criar venda e-commerce

Use este endpoint para fazer uma venda e-commerce.

curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/acheron/ecommerce/payments?meioPagamento&returnInvoice' \ --header 'AppKey;' \ --header 'AppToken;' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'accept: application/json' \ --header 'Content-Type: application/json' \ --data-raw '{ "card": { "csc": "111", "document": "01234567890", "expiration": { "month": "11", "year": "28" }, "holder": "PORTADOR MOCK", "number": "6505000000002001" }, "currency": "986", "installments": 3, "merchantName": "TesteAut", "paymentId": "671635", "paymentMethod": "X", "value": 35.33, "returnInvoice": "S", "adminInstallments": "N" }'

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>

opcional

Meio de pagamento usado na transação.

Valores permitidos:

AUTTARCABALCLOUDWALKECOMMERCEGOOD_CARDINGENICOIPFT_WEBITAUTECPAY_GORESOMAQSKYTEFURAURA_2VEROMERCISOFTWARE_EXPRESSDIRECAOTEF_NEUSCONDUCTOR_TEFECOMMERCE_CABALECOMMERCE_VTEXECOMMERCE_APITOTEMQRCODEAPITOTEM_EXTERNOSNXPIXPAYFACE

returnInvoice

string

opcional

Define se o comprovante será incluído na resposta. Use S para incluir o comprovante e N para não incluir.

Padrão:

Exemplo:

Parâmetros Header

AppKey

string

requerido

AppKey configurada e fornecida pela RPE.

AppToken

string

requerido

AppToken configurado e fornecido pela RPE.

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:

application/json

Parâmetros Bodyapplication/json

card

object

requerido

Objeto contendo as informações do cartão.

csc

string

requerido

Código de segurança do cartão (Caso o cliente esteja parametrizado para validar o CVV).

Exemplo:

111

document

string

requerido

Documento do titular do cartão.

Exemplo:

01234567890

expiration

object

requerido

Objeto que representa as informações de validade do cartão.

holder

string

requerido

Nome do titular impresso no cartão.

Exemplo:

PORTADOR MOCK

number

string

requerido

Número do cartão.

Exemplo:

6505000000002001

currency

string

requerido

Código da moeda no formato ISO 4217.

Exemplo:

986

installments

integer

requerido

Quantidade de parcelas.

Exemplo:

merchantName

string

requerido

Nome do estabelecimento.

Exemplo:

TesteAut

paymentId

string

requerido

ID de pagamento que pode ser usado como identificador único.

Exemplo:

671635

paymentMethod

string

requerido

O método de pagamento.

Exemplo:

value

number

requerido

O valor da transação.

Exemplo:

35.33

returnInvoice

enum<string>

requerido

Indica se irá retornar ou não o comprovante da transação. [Exclusivo para processadora Cards]

Valores permitidos:

adminInstallments

string

requerido

Indica se o parcelamento é pela administradora do cartão, com o valor seja S, caso contrário o valor é N.

Exemplo:

Examples

Respostas

🟢200OK

application/json

Sucesso

Body

paymentId

string

opcional

Identificador do pagamento.

Exemplo:

671635

status

enum<string>

opcional

Status da transação. Valores possíveis: approved (aprovado) ou denied(negado)

Valores permitidos:

approveddenied

nsu

string

opcional

Número Sequencial Único (NSU) gerado pela aplicação.

Exemplo:

203984

message

string

opcional

Mensagem de retorno da transação.

Exemplo:

TRANSACAO OK

invoice

string

opcional

Comprovante da transação. [Exclusivo para processadora Cards]

Exemplo:

COMPROVANTE DE OPERACAO: EMISSOR - PDV 9999, REDE NUMERO 999, CARTAO - 0000.XXXX.XXXX.9999, DIA DE VENCIMENTO DO CARTAO: 10, MELHOR DIA DE COMPRAS: 26, 14/06/2023, 10:45 AUTORIZ. 999998, NSU: 99998888. - VENDA CREDITO - PLANO: 3 PARCELAS, PRIMEIRA PARCELA EM: 10/07/2023, VALOR DA VENDA: R$ 25,45

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor