API Reference

Solicitação de Criação de Pagamento

post
https://apis-staging.shipay.com.br/v1/payments

Este serviço cria uma solicitação de pagamento que debita o valor da conta bancária associada na Shipay e credita na conta bancária informada.

É possível utilizar os seguintes dados para realizar transferências:

  • Chave Pix;
  • Transferência Pix por Dados bancários;
  • Boleto bancário.

Atualmente, este serviço está disponível na Shipay com os seguintes bancos parceiros:

  • Tivit (Tbanks)
  • Bs2
  • Itaú
  • Santander
  • Sicoob

IMPORTANTE:

  • No momento, a criação de solicitação de pagamentos Pix via dados bancários, está disponível somente para os bancos Itaú e Santander.
  • No momento, a criação de solicitação de pagamentos via boleto bancário, está disponível somente para o banco Santander.
  • Para acessar esse serviço, além da autenticação, é necessário configurar o certificado MTLS.
    Para mais informações, acessar o passo a passo para criação do certificado MTLS.

Body Params
string
required

Identificador único do pagamento no sistema do cliente. Deve ser único por requisição para evitar pagamentos duplicados.

float
required

Valor do pagamento em reais.

string

Identificador da configuração da conta do pagador. Quando não informado, a carteira padrão da loja é utilizada.

beneficiary
required
string

URL informada será notificada toda vez que a cobrança alterar de status.
Para mais detalhes, acessar https://docs.shipay.com.br/faq/#callback.

string
length ≤ 30

Mensagem opcional para o pagamento (máximo 30 caracteres para boleto).

boolean
Defaults to false

Controla o fluxo de autorização prévia de pagamentos via boleto.
Caso seja enviado como false,o pagamento será processado de forma automática sem a necessidade de um fluxo de validação.

Caso seja enviado como true, o status muda para “pending_validation”, o que permite que seja realizada a chamada de autorização de pagamento via boleto bancário.
Observações:
- Fluxo disponível apenas para o Santander
- Caso não seja enviado esse campo, o padrão é false.

Headers
string
required

Token de autorização do serviço de autenticação /pdvauth.

Responses

Updated 4 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?