Criação de autorização

post

https://api-staging.shipay.com.br/v2/automatic-pix/enrollment

Esse serviço gera uma autorização (contrato que define os parâmetros para as cobranças recorrentes).

Quando aceito pelo pagador, estabelece um vinculo que possibilita a cobrança recorrente de forma automática.

Observações

Serviço disponível somente na para autorizações da jornada 2 e 3.
Disponível para Itaú e Bradesco. (Em desenvolvimento para os demais bancos).

Body Params

Estrutura para criação de uma nova autorização de pagamento recorrente via Pix.

external_enrollment_id

string

Identificador externo da autorização.

contract

string

length between 3 and 35

Identificador que representa o objeto da autorização, é exibido para o pagador no momento do aceite.

buyer

object

required

Informações do devedor.

calendar

object

required

Informações do calendário relacionadas a uma autorização (Enrollment), incluindo datas e frequência de pagamento.

amount

required

Valor das cobranças futuras associadas a esta autorização. Pode ser um valor fixo ou variável.

activation

object

required

Informações sobre a ativação da autorização.

account_id

string

required

Identificador da conta recebedora cadastrada no painel Shipay.

callback_url

string

A URL informada será notificada toda vez que a autorização ou uma cobrança vinculada a ela alterar de status.

additional_information

array of objects

Informações adicionais.

additional_information

retry_policy

string

enum

Define se o fluxo de retentativa para cobranças é permitido.
Caso este campo não seja enviado, por padrão a autorização é criada com o parâmetro configurado como "not_allowed"

Se a autorização for criada como 'not_allowed', não é possível realizar a alteração deste parâmetro posteriormente.

Valor	Descrição
`allowed`	Permite fluxo de retentativa. As retentativas serão agendadas em dias consecutivos.
`not_allowed`	Não permite fluxo de retentativa.
`allowed_alternate_days`	Permite fluxo de retentativa. As retentativas serão agendadas um dia após a tentativa anterior, em dias alternados.

Allowed:

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Autorização criada com sucesso.