Como criar uma Assinatura com multa e juros usando a API?

Para criar uma nova assinatura com multa e juros usando a API, você deverá fazer uma chamada POST para o endpoint /api/v1/subscriptions.

Você pode acessar aqui a documentação referente a esse endpoint.

Como parte do body da requisição, esperamos o envio dos seguintes itens:

• value: O valor em centavos da assinatura a ser criada.
• customer: O cliente da assinatura a ser cobrado com o endereço. Este campo é idempotente, o que significa que se você enviar dados de um cliente que já exista, utilizaremos o existente ao invés de criar um novo.
• chargeType: O tipo da cobrança que você quer gerar. Nesse caso da multa e juros, você informa o tipo OVERDUE.

O body também aceita outros campos opcionais:

• dayGenerateCharge: Dia do mês em que as cobranças serão geradas. Deve ser um valor de 0 a 27.

Exemplo

O body da sua requisição será semelhante a este exemplo:

{
  "value": 100,
  "customer": {
    "name": "Dan",
    "taxID": "31324227036",
    "email": "[email protected]",
    "phone": "5511999999999",
    "address": {
      "zipcode": "30421322",
      "street": "Street",
      "number": "100",
      "neighborhood": "Neighborhood",
      "city": "Belo Horizonte",
      "state": "MG",
      "complement": "APTO",
      "country": "BR"
    }
  },
  "chargeType": "OVERDUE"
}

Após efetuar a requisição, se tudo ocorreu bem, o status code da requisição será 2xx e no body da resposta, retornaremos a assinatura criada.

Retornarmeros a seguinte resposta de exemplo:

{
  "subscription": {
    "customer": {
      "name": "Fernando Silva",
      "email": "[email protected]",
      "phone": "+5531988472275",
      "taxID": { "taxID": "13225476617", "type": "BR:CPF" },
      "correlationID": "1b112444-6530-46dd-934b-71d50d6c84bc",
      "address": {
        "zipcode": "30421322",
        "street": "Street",
        "number": "100",
        "neighborhood": "Neighborhood",
        "city": "Belo Horizonte",
        "state": "MG",
        "complement": "APTO",
        "country": "BR",
        "location": { "coordinates": [] },
        "_id": "64b7d32db5a5555c9b750bc0"
      }
    },
    "dayGenerateCharge": 5,
    "value": 1500,
    "globalID": "UGF5bWVudFN1YnNjcmlwdGlvbjo2M2UzYjJiNzczZDNkOTNiY2RkMzI5OTM="
  }
}

Exemplos em código

Shell + cURL

 curl --request POST \
     --url https://api.openpix.com.br/api/v1/subscriptions \
     --header 'Authorization: AUTHORIZATION' \
     --header 'content-type: application/json' \
     --data '{"value": 100,"customer": {"name":"Dan","taxID":"31324227036","email":"[email protected]","phone":"5511999999999", "address":{"zipcode":"30421322","street":"Street","number":"100","neighborhood":"Neighborhood","city":"Belo Horizonte","state":"MG","complement":"APTO","country":"BR"}},"chargeType":"OVERDUE"}'

JavaScript + Fetch

fetch('https://api.openpix.com.br/api/v1/subscriptions', {
  method: 'POST',
  body: JSON.stringify({
    value: 100,
    customer: {
      name: 'Dan',
      taxID: '31324227036',
      email: '[email protected]',
      phone: '5511999999999',
      address: {
        zipcode: '30421322',
        street: 'Street',
        number: '100',
        neighborhood: 'Neighborhood',
        city: 'Belo Horizonte',
        state: 'MG',
        complement: 'APTO',
        country: 'BR',
      },
    },
    chargeType: 'OVERDUE',
  }),
  headers: {
    Authorization: 'AUTHORIZATION',
    'Content-Type': 'application/json',
  },
}).then((res) => res.json());