Skip to main content

Rotas API

Pix Automátio Rotas da API​

Você pode ver em mais detalhes pelo link

Criar uma Assinatura​

A principal rota é a /api/v1/subscriptions, na qual é possível realizar a criação de uma nova assinatura. link

Listar uma assinatura​

GET /api/v1/subscriptions/{id}

No objeto pixRecurring você tem acesso ao status do Pix Automático

{
    "subscription": {
        "customer": {
            "name": "Dan",
            "email": "[email protected]",
            "phone": "+5511999999999",
            "address": {
                "zipcode": "04556300",
                "street": "rua de são paulo",
                "number": "3432",
                "neighborhood": "BROOKLIN PAULISTA",
                "city": "SAO PAULO",
                "state": "SP",
                "complement": "CONJ 26",
                "country": "BR",
                "location": {
                    "coordinates": []
                },
                "_id": "68acbcd4a95653ef243b66eb"
            },
            "taxID": {
                "taxID": "111111111111",
                "type": "BR:CPF"
            },
            "correlationID": "6f4131ea-b816-4b08-8ba6-11cf6b622a6e"
        },
        "dayGenerateCharge": 25,
        "value": 100,
        "status": "ACTIVE",
        "correlationID": "My-UniqueID",
        "pixRecurring": {
            "recurrencyId": "RN5481141720250825yPWxVcFfpA1",
            "emv": "QRCODE",
            "journey": "PAYMENT_ON_APPROVAL",
            "status": "CREATED"
        },
        "globalID": "UGF5bWVudFN1YnNjcmlwdGlvbjo2OGFjYmNkNGE5NTY1M2VmMjQzYjY2Zjc="
    }
}

Listar todas as assinaturas​

GET /api/v1/subscriptions/

{
  "subscriptions": [],
  "pageInfo": {
        "skip": 0,
        "limit": 100,
        "totalCount": 0,
        "hasPreviousPage": false,
        "hasNextPage": true
    }
}

Buscar os dados de uma parcela​

no objeto COBR vc tem acesso ao status da cobrança.

GET /api/v1/installments/{id}

Listar todas as parcelas de uma assinatura​

GET /api/v1/subscriptions/{id}/installments

{
  "installments": [],
  "pageInfo": {
        "skip": 0,
        "limit": 100,
        "totalCount": 0,
        "hasPreviousPage": false,
        "hasNextPage": true
    }
}