API explorerChangelog
API explorer
Changelog

Theme switcher

Buscar Pix Recorrente

Esse endpoint é usado para buscar Pix Recorrente retonando uma listagem com paginação

Exemplo de response:

JSON
{
    "data": [
        {
            "id": 40123,
            "account_id": "9D12365D-3DEB-4271-9E0D-86D2C123D370",
            "customer_id": 20014,
            "global_id": "UGF5bWVudFN1YnNjcmlwdGlvbjo2OThjNzhmNzNlY123c2RiMWQyNDI4Nzc=",
            "correlation_id": "61123421-fe40-4c1c-86ce-241b11235bd",
            "value": 200,
            "frequency": 2,
            "name": "Assinatura Plano",
            "comment": "Assinatura Plano",
            "pix_recurring_retry_policy": 2,
            "status": "ACTIVE",
            "created_at": "2026-02-11T12:41:27.380000Z",
            "updated_at": "2026-02-11T12:41:27.877000Z",
            "webhook_url": "https://oriented-lamprey-inviting.ngrok-free.app/api",
            "subscription_pix_transaction": [
                {
                    "id": 40024,
                    "subscription_pix_id": 40123,
                    "transaction_id": "A1012314-5F5D-4A7F-8277-E7D6123AAC9",
                    "installment_status": null,
                    "cobr_status": null,
                    "cobr_try_status": null,
                    "created_at": "2026-02-11T12:41:27.397000Z",
                    "updated_at": "2026-02-11T12:41:27.397000Z",
                    "installment_number": "1",
                    "transaction": {
                        "id": "A1123814-5F5D-4A7F-8277-E7D6123AAC9",
                        "status": "pending",
                        "amount": "200",
                        "original_amount": "200",
                        "description": "Pagamento PIX Automatico",
                        "external_id": "6112321-fe40-4c1c-86ce-241b12385bd",
                        "payment_type": "pix_automatico",
                        "refunded": "0",
                        "voided": "0",
                        "captured": "0",
                        "account_id": "9D12365D-3DEB-4271-9E0D-86D2C123D370",
                        "deleted_at": null,
                        "created_at": "2026-02-11T12:41:27.317000Z",
                        "updated_at": "2026-02-11T12:41:27.903000Z",
                        "webhook_url": "https://oriented-lamprey-inviting.ngrok-free.app/api",
                        "transactions_pix_cash_in_id": "A1123815-3FD4-4FF4-8B65-65B8C1231100",
                        "end_to_end_id": null,
                        "payer_name": "João Silva",
                        "payer_national_registration": "06322593021",
                        "payer_type": null,
                        "gateway": "11",
                        "transactions_bank_slip_id": null,
                        "transaction_type": "7",
                        "payment_link_id": null,
                        "payer_email": null,
                        "in_infraction": false,
                        "token_used": null,
                        "refund_id": null,
                        "is_threeds": false,
                        "bank_ispb": null,
                        "end_to_end_refund_id": null
                    }
                }
            ],
            "customer": {
                "id": 20123,
                "external_id": "d31233d-d873-431b-84d1-bb141239edff",
                "name": "João Silva",
                "email": null,
                "phone_number": null,
                "document_type": 1,
                "document_number": "06322593020",
                "created_at": "2026-02-06T16:35:48.587000Z",
                "updated_at": "2026-02-06T16:35:48.587000Z",
                "anex": null,
                "prefer_contact": null,
                "status": 1
            }
        },
        {
            "id": 30017,
            "account_id": "9D51235D-3DEB-4271-9E0D-86D2123D370",
            "customer_id": 20123,
            "global_id": "UGF5bWVudFchYnNjcmlwdG6hbjo2123TkxNTUxMWVmOG4MDM1YjhhZmY=",
            "correlation_id": "076123816-3fef-46f8-8db6-5147d1234745",
            "value": 200,
            "frequency": 2,
            "name": "Assinatura Plano",
            "comment": "Assinatura Plano",
            "pix_recurring_retry_policy": 2,
            "status": "ACTIVE",
            "created_at": "2026-02-06T16:38:45.023000Z",
            "updated_at": "2026-02-06T16:38:45.380000Z",
            "webhook_url": "https://oriented-lamprey-inviting.ngrok-free.app/api",
            "subscription_pix_transaction": [
                {
                    "id": 30025,
                    "subscription_pix_id": 30017,
                    "transaction_id": "A1233E05-AC7A-4B4E-A58A-6A6F123A32E",
                    "installment_status": null,
                    "cobr_status": null,
                    "cobr_try_status": null,
                    "created_at": "2026-02-06T16:38:45.030000Z",
                    "updated_at": "2026-02-06T16:38:45.030000Z",
                    "installment_number": "1",
                    "transaction": {
                        "id": "A1123E05-AC7A-4B4E-A58A-6A6F123FA32E",
                        "status": "pending",
                        "amount": "200",
                        "original_amount": "200",
                        "description": "Pagamento PIX Automatico",
                        "external_id": "0767c816-3fef-46f8-8db6-5147dfda4745",
                        "payment_type": "pix_automatico",
                        "refunded": "0",
                        "voided": "0",
                        "captured": "0",
                        "account_id": "9D5123D-3DEB-4271-9E0D-86D2C0912370",
                        "deleted_at": null,
                        "created_at": "2026-02-06T16:38:45.003000Z",
                        "updated_at": "2026-02-06T16:38:45.397000Z",
                        "webhook_url": "https://oriented-lamprey-inviting.ngrok-free.app/api",
                        "transactions_pix_cash_in_id": "A1012306-422C-4BB3-9F3E-9B6123E2748D",
                        "end_to_end_id": null,
                        "payer_name": "Maria Santos",
                        "payer_national_registration": "06322593021",
                        "payer_type": null,
                        "gateway": "11",
                        "transactions_bank_slip_id": null,
                        "transaction_type": "7",
                        "payment_link_id": null,
                        "payer_email": null,
                        "in_infraction": false,
                        "token_used": null,
                        "refund_id": null,
                        "is_threeds": false,
                        "bank_ispb": null,
                        "end_to_end_refund_id": null
                    }
                }
            ],
            "customer": {
                "id": 20078,
                "external_id": "d31233d-d873-431b-84d1-bb146123edff",
                "name": "Maria Santos",
                "email": null,
                "phone_number": null,
                "document_type": 1,
                "document_number": "06322593020",
                "created_at": "2026-02-06T16:35:48.587000Z",
                "updated_at": "2026-02-06T16:35:48.587000Z",
                "anex": null,
                "prefer_contact": null,
                "status": 1
            }
        },
    ],
    "links": {
        "first": "http://localhost:8061/api/pix/cashIn/subscription?page=1",
        "last": null,
        "prev": null,
        "next": "http://localhost:8061/api/pix/cashIn/subscription?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "http://localhost:8061/api/pix/cashIn/subscription",
        "per_page": 15,
        "to": 15
    }
}

Todos os status possíveis:

  • ACTIVE: Assinatura ativa e criando novas parcelas nas datas pré definidas.
  • COMPLETED: Assinatura concluída e não criará novas parcelas. (Especificadamente quando a assinatura tem uma data final).
  • EXPIRED: Possui uma parcela que foi expirada
  • INACTIVE: Assinartura cancelada

Header Parameters

Authorizationstring Required

Colocar no formato Bearer TOKEN

Acceptstring Required

application/json

Content-Typestring Required

application/json

Response

200
Object
{     "data": [         {             "id": 40123,             "account_id": "9D12365D-3DEB-4271-9E0D-86D2C123D370",             "customer_id": 20014,             "global_id": "UGF5bWVudFN1YnNjcmlwdGlvbjo2OThjNzhmNzNlY123c2RiMWQyNDI4Nzc=",             "correlation_id": "61123421-fe40-4c1c-86ce-241b11235bd",             "value": 200,             "frequency": 2,             "name": "Assinatura Plano",             "comment": "Assinatura Plano",             "pix_recurring_retry_policy": 2,             "status": "ACTIVE",             "created_at": "2026-02-11T12:41:27.380000Z",             "updated_at": "2026-02-11T12:41:27.877000Z",             "webhook_url": "https://oriented-lamprey-inviting.ngrok-free.app/api",             "subscription_pix_transaction": [                 {                     "id": 40024,                     "subscription_pix_id": 40123,                     "transaction_id": "A1012314-5F5D-4A7F-8277-E7D6123AAC9",                     "installment_status": null,                     "cobr_status": null,                     "cobr_try_status": null,                     "created_at": "2026-02-11T12:41:27.397000Z",                     "updated_at": "2026-02-11T12:41:27.397000Z",                     "installment_number": "1",                     "transaction": {                         "id": "A1123814-5F5D-4A7F-8277-E7D6123AAC9",                         "status": "pending",                         "amount": "200",                         "original_amount": "200",                         "description": "Pagamento PIX Automatico",                         "external_id": "6112321-fe40-4c1c-86ce-241b12385bd",                         "payment_type": "pix_automatico",                         "refunded": "0",                         "voided": "0",                         "captured": "0",                         "account_id": "9D12365D-3DEB-4271-9E0D-86D2C123D370",                         "deleted_at": null,                         "created_at": "2026-02-11T12:41:27.317000Z",                         "updated_at": "2026-02-11T12:41:27.903000Z",                         "webhook_url": "https://oriented-lamprey-inviting.ngrok-free.app/api",                         "transactions_pix_cash_in_id": "A1123815-3FD4-4FF4-8B65-65B8C1231100",                         "end_to_end_id": null,                         "payer_name": "João Silva",                         "payer_national_registration": "06322593021",                         "payer_type": null,                         "gateway": "11",                         "transactions_bank_slip_id": null,                         "transaction_type": "7",                         "payment_link_id": null,                         "payer_email": null,                         "in_infraction": false,                         "token_used": null,                         "refund_id": null,                         "is_threeds": false,                         "bank_ispb": null,                         "end_to_end_refund_id": null                     }                 }             ],             "customer": {                 "id": 20123,                 "external_id": "d31233d-d873-431b-84d1-bb141239edff",                 "name": "João Silva",                 "email": null,                 "phone_number": null,                 "document_type": 1,                 "document_number": "06322593020",                 "created_at": "2026-02-06T16:35:48.587000Z",                 "updated_at": "2026-02-06T16:35:48.587000Z",                 "anex": null,                 "prefer_contact": null,                 "status": 1             }         },         {             "id": 30017,             "account_id": "9D51235D-3DEB-4271-9E0D-86D2123D370",             "customer_id": 20123,             "global_id": "UGF5bWVudFchYnNjcmlwdG6hbjo2123TkxNTUxMWVmOG4MDM1YjhhZmY=",             "correlation_id": "076123816-3fef-46f8-8db6-5147d1234745",             "value": 200,             "frequency": 2,             "name": "Assinatura Plano",             "comment": "Assinatura Plano",             "pix_recurring_retry_policy": 2,             "status": "ACTIVE",             "created_at": "2026-02-06T16:38:45.023000Z",             "updated_at": "2026-02-06T16:38:45.380000Z",             "webhook_url": "https://oriented-lamprey-inviting.ngrok-free.app/api",             "subscription_pix_transaction": [                 {                     "id": 30025,                     "subscription_pix_id": 30017,                     "transaction_id": "A1233E05-AC7A-4B4E-A58A-6A6F123A32E",                     "installment_status": null,                     "cobr_status": null,                     "cobr_try_status": null,                     "created_at": "2026-02-06T16:38:45.030000Z",                     "updated_at": "2026-02-06T16:38:45.030000Z",                     "installment_number": "1",                     "transaction": {                         "id": "A1123E05-AC7A-4B4E-A58A-6A6F123FA32E",                         "status": "pending",                         "amount": "200",                         "original_amount": "200",                         "description": "Pagamento PIX Automatico",                         "external_id": "0767c816-3fef-46f8-8db6-5147dfda4745",                         "payment_type": "pix_automatico",                         "refunded": "0",                         "voided": "0",                         "captured": "0",                         "account_id": "9D5123D-3DEB-4271-9E0D-86D2C0912370",                         "deleted_at": null,                         "created_at": "2026-02-06T16:38:45.003000Z",                         "updated_at": "2026-02-06T16:38:45.397000Z",                         "webhook_url": "https://oriented-lamprey-inviting.ngrok-free.app/api",                         "transactions_pix_cash_in_id": "A1012306-422C-4BB3-9F3E-9B6123E2748D",                         "end_to_end_id": null,                         "payer_name": "Maria Santos",                         "payer_national_registration": "06322593021",                         "payer_type": null,                         "gateway": "11",                         "transactions_bank_slip_id": null,                         "transaction_type": "7",                         "payment_link_id": null,                         "payer_email": null,                         "in_infraction": false,                         "token_used": null,                         "refund_id": null,                         "is_threeds": false,                         "bank_ispb": null,                         "end_to_end_refund_id": null                     }                 }             ],             "customer": {                 "id": 20078,                 "external_id": "d31233d-d873-431b-84d1-bb146123edff",                 "name": "Maria Santos",                 "email": null,                 "phone_number": null,                 "document_type": 1,                 "document_number": "06322593020",                 "created_at": "2026-02-06T16:35:48.587000Z",                 "updated_at": "2026-02-06T16:35:48.587000Z",                 "anex": null,                 "prefer_contact": null,                 "status": 1             }         },     ],     "links": {         "first": "http://localhost:8061/api/pix/cashIn/subscription?page=1",         "last": null,         "prev": null,         "next": "http://localhost:8061/api/pix/cashIn/subscription?page=2"     },     "meta": {         "current_page": 1,         "from": 1,         "path": "http://localhost:8061/api/pix/cashIn/subscription",         "per_page": 15,         "to": 15     } }
Was this section helpful?

What made this section unhelpful for you?

Base URL

Production:

Sandbox:

Language Box

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?