Criar recorrência

Corpo da requisição

Enviado em JSON.

• amountintegerobrigatório

  Valor cobrado a cada ciclo em centavos. Exemplo: R$ 1,00.

• currencystringobrigatório

  Moeda da recorrência. Hoje só BRL tem método de recorrência.

• methodstringobrigatório

  Método de recorrência (PIXAUTOMATIC, CREDIT_CARD).

• descriptionstringobrigatório

  Descrição da recorrência. Vai para a adquirente e o pagador vê no extrato e nos avisos dela.

• frequencystringobrigatório

  Frequência da cobrança (WEEKLY, MONTHLY, QUARTERLY, SEMIANNUALLY, ANNUALLY).

• customerobjectobrigatório5 campos

  Dados de quem está pagando a recorrência.

  • namestringobrigatório

    Nome completo do pagador.

  • taxIdstringobrigatório

    Documento do pagador.

  • emailstringobrigatório

    E-mail do pagador.

  • phonestring

    Telefone do pagador. Pode ser obrigatório em algumas operadoras.

  • addressobjectobrigatório8 campos

    Endereço de cobrança.

    • countrystringobrigatório

      Código do país no padrão ISO 3166-1 alpha-2 (ex: BR, US).

    • statestringobrigatório

      Estado ou província (ex: SP, CA, NY). Obrigatório quando country = BR.

    • citystringobrigatório

      Cidade. Obrigatório quando country = BR.

    • districtstringobrigatório

      Bairro. Obrigatório quando country = BR.

    • streetstringobrigatório

      Nome da rua ou logradouro. Obrigatório quando country = BR.

    • numberstringobrigatório

      Número do endereço. Obrigatório quando country = BR.

    • complementstring

      Complemento do endereço (apartamento, bloco, unidade, etc).

    • zipCodestringobrigatório

      CEP ou código postal.

• externalRefstring

  Referência externa da recorrência.

• notificationUrlstring

  URL para onde os webhooks da recorrência serão enviados.

• splitsarray of strings

  Lista de IDs de splits. Exemplo: ["split_id_1", "split_id_2"].

• metadataobject10 campos

  Metadados do pagamento utilizados para rastreabilidade e controle.

  • providerstringobrigatório

    Identificador da origem responsável pela criação do pagamento, como checkout, aplicativo, painel administrativo ou integração externa.

  • orderIdstringobrigatório

    Identificador único do pedido no sistema.

  • sellerTaxIdstringobrigatório

    Documento fiscal do vendedor recebedor do pagamento.

  • sellerEmailstringobrigatório

    E-mail do vendedor recebedor do pagamento.

  • checkoutUrlstring

    URL do checkout onde o pagamento foi iniciado.

  • memberProductUrlstring

    Página do produto da área de membros que originou a compra.

  • returnUrlstring

    URL de redirecionamento após o fluxo de pagamento.

  • shopUrlstring

    Página de venda ou oferta que originou a intenção de compra.

  • referrerLinkstring

    URL de origem imediata do acesso do usuário antes de chegar à página de venda.

  • extrastring

    Campo livre para armazenamento de metadados adicionais.

Respostas