Cancel Billing Scheduled

Endpoint para cancelaamento de instruções de pagamento para recorrências de uma conta

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros Header

Parâmetros Bodyapplication/json

Exemplo

{
    "reason_code": "SLBD",
    "stakeholder": "PAYER_PSP",
    "requester_tax_id": "12345678000123"
}

Respostas

🟢200OK

application/json

Body

Examples

SucessoErro

{
    "billing_cancelled": {
        "uuid": "66579e1b-7903-4638-9428-ed729869ba55",
        "correlation_id": "IS375112582026011251f3b3d368a",
        "authorization_date_time": "2026-01-12 13:32:00",
        "end_to_end_id": "E9999991820260114150074137627696",
        "tx_id": "e380db9dab9646beb0f94ea16d1f1721",
        "transaction_id": null,
        "status": "cancelled",
        "scheduled_date_time": "2026-01-12 13:37:23",
        "final_cicle_date": "2026-02-13",
        "cancellation_id": "CA37511258202601217cff6ea00a5",
        "cancellation_requester_tx_id": "46204312000118",
        "cancellation_date_time": "2026-01-21 15:11:30",
        "cancellation_stake_holder": "PAYER_PSP",
        "cancellation_reason_code": "SLBD",
        "created_at": "2026-01-12T16:37:23.000000Z",
        "value": "255.74",
        "purpose_type": "AGND",
        "receiver_account_number": "000000",
        "receiver_account_branch": "0",
        "receiver_account_type": "CACC",
        "rejection_code": null,
        "expiry_date": "2026-01-14",
        "account_id": "62dde80e-6208-4a02-a5f1-8a8d1cfef4fb",
        "recurrence": {
            "uuid": "31b31172-4546-435b-8015-e22b5ac80004",
            "recurrence_id": "RR999999182026011207536809730",
            "frequency_type": "MNTH",
            "creation_date_time": "2026-01-12 16:36:34",
            "initial_date": "2026-01-12",
            "final_date": null,
            "value_type": "FIXED",
            "value": "255.74000",
            "receiver_min_value": null,
            "debtor_name": "INOVANTI",
            "debtor_tax_id": "37511258000162",
            "document_number": "7475956",
            "document_description": null,
            "receiver_name": "Pix Tester 918",
            "receiver_tax_id": "99999918999924",
            "receiver_ispb": "99999918",
            "payer_tax_id": "46204312000118",
            "payer_ispb": "37511258",
            "payer_account_number": "21180",
            "payer_account_branch": "3",
            "recurrence_status": "confirmed_by_payer",
            "correlation_id": "SC9999991820260112Em89fefcsrO",
            "status_update_date_time": "2026-01-12 16:36:34",
            "status_rejection_code": null,
            "status_municipality_code": "0000000",
            "status_original_id": "SC9999991820260112Em89fefcsrO",
            "status_holder_creator": "PAYER_PSP",
            "created_at": "2026-01-12T16:36:42.000000Z",
            "journey": "AUT1",
            "journey_date_time": "2026-01-12 13:36:34-03",
            "unformated_creation_date_time": "2026-01-12T16:36:34.451Z",
            "unformated_journey_date_time": "2026-01-12T16:36:34.451Z",
            "unformated_status_update_date_time": "2026-01-12T16:36:34.451Z",
            "account_id": "62dde80e-6208-4a02-a5f1-8a8d1cfef4fb"
        }
    }
}