Documentação

Autenticação

A autenticação é utiulizada para você se conectar à sua conta da Outpay, onde em todos os métodos da API que você utilizar com a sua autenticação será relacionado à sua conta.

  1. Acesse o seu dashboard (outpay.io/dashboard)
  2. Vá até o menu MINHA CONTA, e clique na aba ACESSO API.
  3. O seu código de autenticação estará no campo TOKEN.

Bibliotecas

Bibliotecas podem ajudar você a integrar rapidamente seu sistema a Outpay.

  1. outpay-php - Biblioteca PHP

1. Checkout de Pagamentoo

A Outpay utiliza a tecnologia via POST de dados. E é com ela que todos os métodos da API serão utilizados. Abaixo segue a sequencia que deve ser seguida para gerar sua chave do checkout e entregar ao seu cliente o Boleto para o pagamento:

  1. Ter o TOKEN da sua conta Outpay, o token é utilizado para você se conectar com a sua conta.
  2. Realizar o post com os DADOS obrigatórios no ítem DADOS desta documentação.
  3. Após o POST realizado o seu usuario será redirecionado para a página de checkout da Outpay.
  4. Nesta página ele irá confirmar o dados e imprimir o seu boleto para o pagamento.

1.1. Gerar Checkout (URL)

Você deverá fazer um POST para a seguinte URL com os seguintes parâmetros:

URL: https://outpay.io/api/v1/invoices

Parâmetros

Campo Descrição Obrigatório Tipo Observação
api_key Token da conta Outpay. Sim Texto
description Descrição do pedido na sua loja. Sim Texto
total Valor do pedido na sua loja (BRL). Sim Valor Ex: R$1000,00 = 1000
postback_url URL que vai receber o POST quando houver a alteração de status no checkout. Sim Valor Ex: https://minhaloja.com.br
payment_method Forma de Pagamento do checkout. Sim Texto billet | credit_card | debit_card
customer_type Tipo de pessoa que é o cliente. Sim Texto P = Física | C = Empresa
customer_name_social_reason Nome completo do cliente ou Razão Social da empresa. Sim Texto
customer_cpf_cnpj Documento do cliente (CPF ou CNPJ). Sim Texto Apenas números
customer_email Endereço de e-mail do cliente. Sim Texto
customer_address_zipcode CEP da residência onde o cliente reside. Sim Número Apenas números
customer_street Rua onde o cliente reside. Sim Texto
customer_number Número da residência onde o cliente reside. Sim Número
customer_district Bairro da residência onde o cliente reside. Sim Texto
customer_city Cidade da residência onde o cliente reside. Sim Texto
customer_state Estado da residência onde o cliente reside. Sim Texto Formato UF
customer_country País da residência onde o cliente reside. Sim Texto Por extenso

Caso o sucesso do POST, será retornado no formato JSON o TOKEN da transação e a URL para a qual você deve levar o seu usuário para o pagamento do meio de pagamento informado. E se houver erros, será apontado na resposta em JSON o erro tratado.

Exemplo do JSON de sucesso:
HTTP/1.1 200 OK
Status: 200 OK
Content-Type: application/json; charset=utf-8
...

[
  {
    "message":"Invoice generate with success.",
    "token":0f4255zjxs9brd918po6a5gqh0ngpbtn,
    "checkout_url":"https://outpay.io/invoice/0f4255zjxs9brd918po6a5gqh0ngpbtn",
    "status_id":"Aguardando Pagamento"
  }
]

1.2. Verificar status do Checkout

Você deverá fazer um POST para a seguinte URL com os seguintes parâmetros:

URL: https://outpay.io/api/v1/invoices/status

Parâmetros

Campo Descrição Obrigatório Tipo Observação
api_key Token da conta Outpay. Sim Texto
checkout_token Token do checkout gerado que deseja consultar. Sim Texto

Caso o sucesso do POST, será retornado no formato JSON o TOKEN da transação e o status atual do checkout. E se houver erros, será apontado na resposta em JSON o erro tratado.

Exemplo do JSON de sucesso:
HTTP/1.1 200 OK
Status: 200 OK
Content-Type: application/json; charset=utf-8
...

[
  {
    "checkout_token":0f4255zjxs9brd918po6a5gqh0ngpbtn,
    "status_id":"Completo"
  }
]

Possíveis status

Verifique os possíveis status da API:

Status Descrição
Aguardando Pagamento Pagamento ainda não realizado.
Processando Pagamento Pagamento recebido e sendo processado pela operadora.
Pagamento Confirmado Pagamento recebido e confirmado pela operadora.
Completo Pagamento creditado em sua conta Outpay.
Não aprovado O pagamento não foi aprovado.
Cancelado O pagamento foi cancelado.
Expirado Expirou o tempo para realizar o pagamento do pedido.

Thanks!