### cURL Request Example Source: https://developers.celcoin.com.br/docs/sweeping-accounts-listar-consentimentos Example of how to make a GET request to the API using cURL with query parameters and authorization. ```bash curl --location 'https://api.exemplo.com/open-keys/itp/api/v2/sweeping-accounts/v2/payment-initiation?status=AUTHORISED&initialDate=2025-11-28&finalDate=2025-11-27&page=1&pageSize=10' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' ``` -------------------------------- ### Python Request Example Source: https://developers.celcoin.com.br/docs/sweeping-accounts-callback-do-consentimento This Python example shows how to send the callback request using the requests library. ```python import requests import json url = "https://api.exemplo.com/open-keys/itp/api/v2/payment-initiation/callback" payload = json.dumps({ "code": "{{callback_code}}", "id_token": "{{callback_id_token}}", "state": "{{callback_state}}" }) headers = { 'Content-Type': 'application/json' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text) ``` -------------------------------- ### POST /pix/payment Request Example Source: https://developers.celcoin.com.br/docs/autoriza%C3%A7%C3%A3o-jornada-3-baas This JSON object represents a request to initiate a Pix payment, including details for an immediate payment and a recurring payment setup. ```json { "amount": 584.71, "clientCode": "bb877108-657a-4c39-aec6-e836a9cc25af", "debitParty": { "account": "4171740" }, "endToEndId": "E139358932025071818222NYE7gQVL3C", "creditParty": { "taxId": "99999918999924", "bank": "99999918", "account": "121212", "branch": "1235", "name": "teste", "accountType": "TRAN", "personType": "NATURAL_PERSON", "key": "f4c6089a-bfde-4c00-a2d9-9eaa584b0219" }, "initiationType": "DYNAMIC_QRCODE", "transactionIdentification": "6200770704454492b187705eba48de68", "paymentType": "IMMEDIATE", "urgency": "HIGH", "transactionType": "TRANSFER", "recurrencyAccept": true, "recurrency": { "recurrencyId": "RR999999182025071841111672931", "journeyType": 3, "interval": { "start": "2025-07-18", "end": null, "frequencyType": "MONTHLY" }, "amount": 321.52, "recurrencyMaxAmount": 0, "recurrencyAmountType": "FIXED", "creditParty": { "bank": "99999918", "taxId": "99999918999924", "name": "Pix Tester 918" }, "debitParty": { "name": "Blanca Fritsch", "personType": "NATURAL_PERSON", "taxId": "46128231845", "bank": "13935893", "branch": "0001", "account": "4171740", "accountType": "CACC", "stateCode": "0" }, "debtor": { "taxId": "13935893000109", "name": "INTEGRATED SOLUTIONS TO BUSINE" }, "contract": { "number": "85092252", "description": "Serviço de Segurança" } } } ``` -------------------------------- ### JavaScript/Node.js Request Example Source: https://developers.celcoin.com.br/docs/sweeping-accounts-callback-do-consentimento This JavaScript example demonstrates how to make the callback request using the axios library. ```javascript const axios = require('axios'); let data = JSON.stringify({ "code": "{{callback_code}}", "id_token": "{{callback_id_token}}", "state": "{{callback_state}}" }); let config = { method: 'post', maxBodyLength: Infinity, url: 'https://api.exemplo.com/open-keys/itp/api/v2/payment-initiation/callback', headers: { 'Content-Type': 'application/json' }, data : data }; axios.request(config) .then((response) => { console.log(JSON.stringify(response.data)); }) .catch((error) => { console.log(error); }); ``` -------------------------------- ### POST /pix/payment Example Source: https://developers.celcoin.com.br/docs/autoriza%C3%A7%C3%A3o-jornada-3-copy-5 Example JSON payload for initiating a Pix payment. Ensure all required fields are correctly populated. ```json { "bank": "0000000", "name": "Academia Fitness Pro" } { "personType": "NATURAL_PERSON", "taxId": "98765432100", "bank": "0000000", "account": "98765-4", "branch":"0001", "stateCode": "SP" } { "personType": "NATURAL_PERSON", "taxId": "98765432100", "name": "Carlos Eduardo Oliveira" } { "number": "CTR-PIX-2025-001", "description": "Plano anual academia com acesso ilimitado" } null, null, "2025-05-10T09:00:00Z", "2025-05-10T09:10:00Z", null, "2025-05-16T10:00:00Z", null } ``` -------------------------------- ### JavaScript/Node.js Request Example Source: https://developers.celcoin.com.br/docs/sweeping-accounts-listar-consentimentos Example of how to make a GET request to the API using axios in JavaScript/Node.js, including headers and error handling. ```javascript const axios = require('axios'); let config = { method: 'get', maxBodyLength: Infinity, url: 'https://api.exemplo.com/open-keys/itp/api/v2/sweeping-accounts/v2/payment-initiation?status=AUTHORISED&initialDate=2025-11-28&finalDate=2025-11-27&page=1&pageSize=10', headers: { 'Authorization': '••••••' } }; axios.request(config) .then((response) => { console.log(JSON.stringify(response.data)); }) .catch((error) => { console.log(error); }); ``` -------------------------------- ### POST /pix/payment Example Source: https://developers.celcoin.com.br/docs/autoriza%C3%A7%C3%A3o-jornada-3-copy-5 Example of a POST request to the /pix/payment endpoint, demonstrating the required fields for initiating a Pix payment. ```APIDOC ## POST /pix/payment ### Description Initiates a Pix payment transaction. ### Method POST ### Endpoint /pix/payment ### Request Body - **transactionId** (string) - Required - Unique identifier for the transaction. - **amount** (number) - Required - The amount to be paid. - **description** (string) - Required - Description of the payment. - **merchant** (object) - Required - Information about the merchant. - **taxId** (string) - Required - Merchant's tax ID. - **name** (string) - Required - Merchant's name. - **bank** (string) - Required - Merchant's bank code. - **debitParty** (object) - Required - Information about the party debited. - **personType** (string) - Required - Type of person (e.g., NATURAL_PERSON, LEGAL_ENTITY). - **taxId** (string) - Required - Debtor's tax ID. - **bank** (string) - Required - Debtor's bank code. - **account** (string) - Required - Debtor's account number. - **branch** (string) - Required - Debtor's branch number. - **stateCode** (string) - Required - Debtor's state code. - **debtor** (object) - Required - Information about the debtor. - **personType** (string) - Required - Type of person (e.g., NATURAL_PERSON, LEGAL_ENTITY). - **taxId** (string) - Required - Debtor's tax ID. - **name** (string) - Required - Debtor's name. - **contract** (object) - Optional - Contract details. - **number** (string) - Required - Contract number. - **description** (string) - Required - Contract description. ### Request Example ```json { "transactionId": "a1b2c3d4-e5f6-7890-1234-567890abcdef", "amount": 100.50, "description": "Payment for services rendered", "merchant": { "taxId": "12345678000199", "name": "Academia Fitness Pro", "bank": "0000000" }, "debitParty": { "personType": "NATURAL_PERSON", "taxId": "98765432100", "bank": "0000000", "account": "98765-4", "branch": "0001", "stateCode": "SP" }, "debtor": { "personType": "NATURAL_PERSON", "taxId": "98765432100", "name": "Carlos Eduardo Oliveira" }, "contract": { "number": "CTR-PIX-2025-001", "description": "Plano anual academia com acesso ilimitado" } } ``` ### Response #### Success Response (200) - **createDate** (string) - The date and time the transaction was created. - **acceptanceDate** (string) - The date and time the transaction was accepted. - **denyDate** (string) - The date and time the transaction was denied. - **updateDate** (string) - The date and time the transaction was last updated. - **deleteDate** (string) - The date and time the transaction was deleted. #### Response Example ```json { "createDate": "2025-05-10T09:00:00Z", "acceptanceDate": "2025-05-10T09:10:00Z", "denyDate": null, "updateDate": "2025-05-16T10:00:00Z", "deleteDate": null } ``` ``` -------------------------------- ### Response Example for Margin Query Source: https://developers.celcoin.com.br/docs/autoriza%C3%A7%C3%A3o-de-consulta-consulta-de-v%C3%ADculo-empregat%C3%ADcio This JSON response details the available margin for a loan applicant, including employer and employee information, product details, and metadata. It is returned by the GET /banking/originator/guarantee/(product_id)/get-balance endpoint. ```json { "links": [ { "employer": { "code": "123456", "document": "95818221485", "name": "Empresa Exemplo LTDA" }, "employee": { "code": "1564882125", "document": "90110651669", "name": "João da Silva" }, "config": { "agency": "3a7e1beb-c64f-4936-8555-b9edb42c3328", "consignee": "468f5087-d35f-45dd-96db-3cf71a83fe08" }, "products": [ { "balance_check_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "authorization": { "details": [ { "type_product": "LOAN", "authorized": true, "validity": "2025-12-31" } ], "portability": [ { "authorized": false, "available_balance": 0, "type_product": "LOAN", "validity": "2025-12-31", "contract_port": { "contract_id": "PORT123", "document": "12345678900", "name_consignee": "BANCO XYZ" } } ] }, "rubric": { "code": "RUB001", "description": "Rubrica de Empréstimo" }, "agreement": "AG001", "available_balance": 5000.75 } ], "meta_data": { "nationality_country": { "description": "Brasil", "code": "BR" }, "termination_reason_code": "TRC001", "birth_date": "1985-08-06", "worker_category_code": "101", "termination_date": "2025-06-01", "prior_notice_date": "2025-05-15", "prior_notice_end_date": "2025-06-15", "gender": { "description": "Masculino", "code": 1 }, "job_code": { "description": "Analista de Sistemas", "code": "21240" }, "economic_activity_code": { "description": "Atividades de tecnologia", "code": "6201-5/01" }, "politically_exposed_person": { "description": "Não", "code": 0 }, "unauthorization_reason": { "description": "Nenhum", "code": 0 }, "base_margin_value": "3000.00", "alerts": [ { "absence_reason_code": "A001", "alert_type": { "description": "Licença Médica", "code": 1 }, "absence_date": "2025-01-10", "absence_end_date": "2025-01-25", "reference_date": "2025-01", "event_id": "EVT123", "termination_reason_code": "TRC001" } ], "amount_loans_assets_suspended": "2", "admission_date": "2010-03-15", "total_earnings": "8500.00", "legacy_loans": [ { "financial_institution_code": 123, "contract": "CON123456789", "contract_start_date": "2021-01-01", "contract_end_date": "2026-01-01", "installment_amount": 350.25, "loan_amount": 10000.00, "net_amount": 9500.00, "update_date_time": "2025-08-01T10:00:00Z", "interest_tax": 1.85, "monthly_cet": 2.1, "installment_quantity": 60, "paid_installments_quantity": 30, "debtor_balance_amount": 5000.00, "contract_type": { "description": "Crédito Consignado", "code": 1 } } ], "employer_activity_start_date": "2005-01-01", "mother_name": "Maria de Lourdes" }, "balance_check_date": "2025-08-05" } ], "message": "Verificação de margem realizada com sucesso" } ``` -------------------------------- ### Callback API Request Example (cURL) Source: https://developers.celcoin.com.br/docs/callback-do-v%C3%ADnculo Example of how to make a callback request using cURL, demonstrating the endpoint and JSON payload. ```bash curl --location 'https://api.exemplo.com/open-keys/itp/api/v2/payment-initiation/callback' \ --header 'Content-Type: application/json' \ --data '{ "code": "{{callback_code}}", "id_token": "{{callback_id_token}}", "state": "{{callback_state}}" }' ``` -------------------------------- ### POST /pix/payment Example Source: https://developers.celcoin.com.br/docs/autoriza%C3%A7%C3%A3o-jornada-3-copy-3 Example of a POST request to authorize a PIX payment. ```APIDOC ## POST /pix/payment ### Description Authorizes a PIX payment transaction. ### Method POST ### Endpoint /pix/payment ### Request Body - **creditor** (object) - Required - Information about the creditor. - **personType** (string) - Required - Type of person (e.g., NATURAL_PERSON, LEGAL_PERSON). - **taxId** (string) - Required - Tax identification number. - **name** (string) - Required - Name of the creditor. - **bank** (string) - Required - Bank code of the creditor. - **debitParty** (object) - Required - Information about the party making the debit. - **personType** (string) - Required - Type of person. - **taxId** (string) - Required - Tax identification number. - **bank** (string) - Required - Bank code. - **account** (string) - Required - Account number. - **branch** (string) - Required - Branch number. - **stateCode** (string) - Required - State code. - **debtor** (object) - Required - Information about the debtor. - **personType** (string) - Required - Type of person. - **taxId** (string) - Required - Tax identification number. - **name** (string) - Required - Name of the debtor. - **contract** (object) - Optional - Contract details. - **number** (string) - Required - Contract number. - **description** (string) - Required - Description of the contract. ### Request Example ```json { "creditor": { "personType": "NATURAL_PERSON", "taxId": "12345678900", "name": "Academia Fitness Pro", "bank": "0000000" }, "debitParty": { "personType": "NATURAL_PERSON", "taxId": "98765432100", "bank": "0000000", "account": "98765-4", "branch": "0001", "stateCode": "SP" }, "debtor": { "personType": "NATURAL_PERSON", "taxId": "98765432100", "name": "Carlos Eduardo Oliveira" }, "contract": { "number": "CTR-PIX-2025-001", "description": "Plano anual academia com acesso ilimitado" } } ``` ### Response #### Success Response (200) - **cancellation** (object) - Details about cancellation, if applicable. - **error** (object) - Details about any errors, if applicable. - **createDate** (string) - The date and time the transaction was created. - **acceptanceDate** (string) - The date and time the transaction was accepted. - **denyDate** (string) - The date and time the transaction was denied. - **updateDate** (string) - The date and time the transaction was last updated. - **deleteDate** (string) - The date and time the transaction was deleted. #### Response Example ```json { "cancellation": null, "error": null, "createDate": "2025-05-10T09:00:00Z", "acceptanceDate": "2025-05-10T09:10:00Z", "denyDate": null, "updateDate": "2025-05-16T10:00:00Z", "deleteDate": null } ``` ``` -------------------------------- ### SFTP File Naming Example Source: https://developers.celcoin.com.br/docs/sobre-as-transfer%C3%AAncias An example of how the movement or rejection file might be named when sent via SFTP. ```plaintext TRANSFERENCIA_MOV_ID0002_NSA001501_DATA20160901 ``` -------------------------------- ### Request Example for Pix Cashin Query Source: https://developers.celcoin.com.br/docs/recebimentos-pix-cashin Use this example to query the status of a Pix Cashin payment. Ensure the URL is correctly formatted for the environment (sandbox or production). ```bash url --request GET \ --url \ --header 'accept: application/json' ``` -------------------------------- ### Make GET Request to Consult Webhooks Source: https://developers.celcoin.com.br/docs/sobre-dda Example using curl to perform a GET request to the DDA API to consult webhook configurations. ```curl curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/dda-servicewebhook-webservice/v1/webhook/routes' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer {{access_token}}' ``` -------------------------------- ### Python Request Example Source: https://developers.celcoin.com.br/docs/sweeping-accounts-listar-consentimentos Example of how to make a GET request to the API using the requests library in Python, including headers and response printing. ```python import requests url = "https://api.exemplo.com/open-keys/itp/api/v2/sweeping-accounts/v2/payment-initiation?status=AUTHORISED&initialDate=2025-11-28&finalDate=2025-11-27&page=1&pageSize=10" payload = {} headers = { 'Authorization': '••••••' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text) ``` -------------------------------- ### List Cards Request Example Source: https://developers.celcoin.com.br/docs/listar-cart%C3%B5es Use this cURL command to list cards. Ensure you replace placeholders like {accountId} and {TOKEN} with your actual values. The `startAt` parameter can filter by status, such as 'active'. ```curl curl --request GET \ --url 'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/cards?account={accountId}&startAt=active' \ --header 'accept: application/json' \ --header 'authorization: Bearer {TOKEN}' ``` -------------------------------- ### cURL Request Example Source: https://developers.celcoin.com.br/docs/buscar-jornada-de-v%C3%ADnculo This example demonstrates how to make a GET request to the journey session API using cURL. Replace YOUR_ACCESS_TOKEN with your actual token. ```bash curl --location 'https://api.exemplo.com/open-keys/itp/api/v2/enrollments/v2/journeys-sessions/{id}' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' ``` -------------------------------- ### cURL Request Example Source: https://developers.celcoin.com.br/docs/buscar-jornada-de-pagamento Example of how to call the Get Journey Session API using cURL. Replace placeholders with your actual token and session ID. ```bash curl --location 'https://api.exemplo.com/open-keys/itp/api/v2/payments/v4/journeys-sessions/{id}' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' ``` -------------------------------- ### Exemplo de retorno de sucesso (200 OK) Source: https://developers.celcoin.com.br/docs/reenvio-de-webhook-1 Este é um exemplo da estrutura de resposta esperada ao consultar detalhes de webhooks enviados com sucesso. Contém informações sobre a paginação e uma lista de detalhes de cada webhook. ```json { "body": { "limit": 200, "currentPage": 1, "limitPerPage": 200, "totalPages": 1, "webhookDetails": [ { "webhookId": "84c5fc12-c2e4-4582-9566-9b334a7486a0", "httpStatusCode": 404, "webhookUrl": "https://webhook.site/3bc30e7c-0cf6-427d-86c8-ba5ae044c4c7", "request": "{\"entity\":\"onboarding-create\",\"createTimestamp\":\"2023-11-08T17:47:49.2665988\",\"status\":\"CONFIRMED\",\"body\":{\"account\":{\"branch\":\"0001\",\"account\":\"300540655630\",\"name\":\"Nome Sobrenome\",\"documentNumber\":\"04072747580\"},\"onboardingId\":\"84c5fc12-c2e4-4582-9566-9b334a7486a0\",\"clientCode\":\"100011\",\"createDate\":\"2023-11-08T17:47:49.2665988\"}}", "response": "{\"success\":false,\"error\":{\"message\":\"Token not found\",\"id\":null}}", "status": "PENDENTE", "createDate": "2023-11-08T17:47:49.576Z", "lastUpdateDate": "2023-11-08T18:02:50.237Z", "filter": { "documentNumber": "04072747580", "account": "300540655630", "id": null, "clientRequestId": "100011" } }, { "webhookId": "9d7cd74a-ae11-402d-9562-8df18a3419e5", "httpStatusCode": 200, "webhookUrl": "https://webhook.site/e94d2b08-cad1-4003-9fc9-14d466553ebf", ``` -------------------------------- ### Basic Authentication Configuration Source: https://developers.celcoin.com.br/docs/sobre-dda Example of the basicAuthentication object for webhook setup. Requires 'identification' and 'password' fields. ```json "basicAuthentication": { "identification": "João", "password": "Um@Pro7ec@o" } ``` -------------------------------- ### OAuth Two Authentication Configuration Source: https://developers.celcoin.com.br/docs/sobre-dda Example of the oAuthTwo object for webhook setup. Requires 'endpoint', 'grantType', 'clientId', and 'clientSecret'. Other fields are optional. ```json "oAuthTwo": { "endpoint": "https://yoursite.azurewebsites.net/oauth/callback", "grantType": "client_credentials", "clientId": "CBA114E0-02A7-44CC-9D65-2DB588B58DBE", "clientSecret": "eyJ0eXAiOiJKV1QiLCjhbGciOiJSUzl1Nils", "scope": "vso.profile vso.agentpools", "state": "string", "code": "", "refreshToken": "", "contentType": "application/json" } ``` -------------------------------- ### List Customers Response Example Source: https://developers.celcoin.com.br/docs/listar-clientes This is an example of a successful JSON response when listing customers. It includes total found, and a list of customer objects with their details. ```json { "totalQtdFoundInPage": 1, "Customers": [ { "galaxPayId": 1, "myId": "pay-69989591c72018.92270541", "name": "Lorem ipsum dolor sit amet.", "document": "10195953703", "emails": [ "teste6720email7580@galaxpay.com.br", "teste2157email537@galaxpay.com.br" ], "phones": [ 3140201512, 31983890110 ], "status": "active", "createdAt": "2020-06-02 10:10:00", "updatedAt": "2020-06-02 10:10:00", "Address": { "zipCode": "30411330", "street": "Rua platina", "number": "1330", "complement": "2º andar", "neighborhood": "Prado", "city": "Belo Horizonte", "state": "MG" } } ] } ``` -------------------------------- ### List Journey Sessions cURL Request Source: https://developers.celcoin.com.br/docs/sweeping-accounts-listar-sess%C3%B5es-de-jornada Example of how to make a GET request to list journey sessions using cURL. Ensure you replace YOUR_ACCESS_TOKEN with a valid token. ```bash curl --location 'https://api.exemplo.com/open-keys/itp/api/v2/sweeping-accounts/v2/journeys-sessions?page=1&pageSize=1' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' ``` -------------------------------- ### Exemplo POST /pix/payment Source: https://developers.celcoin.com.br/docs/autoriza%C3%A7%C3%A3o-jornada-3-baas Este endpoint é utilizado para realizar um pagamento imediato que precede a autorização do Pix Automático. A autorização do Pix Automático só ocorrerá após a confirmação deste pagamento. ```APIDOC ## POST /pix/payment ### Description Realiza um pagamento imediato como pré-requisito para a autorização de Pix Automático. ### Method POST ### Endpoint /pix/payment ### Request Body - **amount** (number) - Required - Valor do pagamento. - **clientCode** (string) - Required - Código do cliente. - **debitParty** (object) - Required - Informações da parte debitada. - **account** (string) - Required - Conta debitada. - **endToEndId** (string) - Required - Identificador de ponta a ponta da transação. - **creditParty** (object) - Required - Informações da parte creditada. - **taxId** (string) - Required - CPF/CNPJ do recebedor. - **bank** (string) - Required - Código do banco recebedor. - **account** (string) - Required - Conta recebedora. - **branch** (string) - Required - Agência recebedora. - **name** (string) - Required - Nome do recebedor. - **accountType** (string) - Required - Tipo da conta recebedora (ex: TRAN). - **personType** (string) - Required - Tipo de pessoa (NATURAL_PERSON, LEGAL_ENTITY). - **key** (string) - Required - Chave Pix do recebedor. - **initiationType** (string) - Required - Tipo de iniciação (ex: DYNAMIC_QRCODE). - **transactionIdentification** (string) - Required - Identificação da transação. - **paymentType** (string) - Required - Tipo de pagamento (ex: IMMEDIATE). - **urgency** (string) - Required - Urgência da transação (ex: HIGH). - **transactionType** (string) - Required - Tipo de transação (ex: TRANSFER). - **recurrencyAccept** (boolean) - Required - Indica se a recorrência é aceita. - **recurrency** (object) - Optional - Detalhes da recorrência. - **recurrencyId** (string) - Optional - ID da recorrência. - **journeyType** (number) - Optional - Tipo da jornada. - **interval** (object) - Optional - Intervalo da recorrência. - **start** (string) - Optional - Data de início. - **end** (string) - Optional - Data de fim. - **frequencyType** (string) - Optional - Tipo de frequência (ex: MONTHLY). - **amount** (number) - Optional - Valor da recorrência. - **recurrencyMaxAmount** (number) - Optional - Valor máximo da recorrência. - **recurrencyAmountType** (string) - Optional - Tipo de valor da recorrência (ex: FIXED). - **creditParty** (object) - Optional - Detalhes da parte creditada na recorrência. - **bank** (string) - Optional - Código do banco. - **taxId** (string) - Optional - CPF/CNPJ. - **name** (string) - Optional - Nome. - **debitParty** (object) - Optional - Detalhes da parte debitada na recorrência. - **name** (string) - Optional - Nome. - **personType** (string) - Optional - Tipo de pessoa. - **taxId** (string) - Optional - CPF/CNPJ. - **bank** (string) - Optional - Código do banco. - **branch** (string) - Optional - Agência. - **account** (string) - Optional - Conta. - **accountType** (string) - Optional - Tipo da conta. - **stateCode** (string) - Optional - Código do estado. - **debtor** (object) - Optional - Detalhes do devedor. - **taxId** (string) - Optional - CPF/CNPJ. - **name** (string) - Optional - Nome. - **contract** (object) - Optional - Detalhes do contrato. - **number** (string) - Optional - Número do contrato. - **description** (string) - Optional - Descrição do contrato. ### Request Example ```json { "amount": 584.71, "clientCode": "bb877108-657a-4c39-aec6-e836a9cc25af", "debitParty": { "account": "4171740" }, "endToEndId": "E139358932025071818222NYE7gQVL3C", "creditParty": { "taxId": "99999918999924", "bank": "99999918", "account": "121212", "branch": "1235", "name": "teste", "accountType": "TRAN", "personType": "NATURAL_PERSON", "key": "f4c6089a-bfde-4c00-a2d9-9eaa584b0219" }, "initiationType": "DYNAMIC_QRCODE", "transactionIdentification": "6200770704454492b187705eba48de68", "paymentType": "IMMEDIATE", "urgency": "HIGH", "transactionType": "TRANSFER", "recurrencyAccept": true, "recurrency": { "recurrencyId": "RR999999182025071841111672931", "journeyType": 3, "interval": { "start": "2025-07-18", "end": null, "frequencyType": "MONTHLY" }, "amount": 321.52, "recurrencyMaxAmount": 0, "recurrencyAmountType": "FIXED", "creditParty": { "bank": "99999918", "taxId": "99999918999924", "name": "Pix Tester 918" }, "debitParty": { "name": "Blanca Fritsch", "personType": "NATURAL_PERSON", "taxId": "46128231845", "bank": "13935893", "branch": "0001", "account": "4171740", "accountType": "CACC", "stateCode": "0" }, "debtor": { "taxId": "13935893000109", "name": "INTEGRATED SOLUTIONS TO BUSINE" }, "contract": { "number": "85092252", "description": "Serviço de Segurança" } } } ``` ### Response #### Success Response (200) - **status** (string) - Status da transação (ex: PROCESSING). - **version** (string) - Versão da resposta. - **body** (object) - Corpo da resposta. - **id** (string) - ID da transação. - **amount** (number) - Valor da transação. - **clientCode** (string) - Código do cliente. - **transactionIdentification** (string) - Identificação da transação. - **endToEndId** (string) - Identificador de ponta a ponta. - **initiationType** (string) - Tipo de iniciação. - **paymentType** (string) - Tipo de pagamento. - **urgency** (string) - Urgência da transação. - **transactionType** (string) - Tipo de transação. - **debitParty** (object) - Detalhes da parte debitada. - **account** (string) - Conta debitada. - **branch** (string) - Agência debitada. - **taxId** (string) - CPF/CNPJ debitado. - **name** (string) - Nome debitado. - **accountType** (string) - Tipo da conta debitada. - **creditParty** (object) - Detalhes da parte creditada. - **bank** (string) - Código do banco creditado. - **key** (string) - Chave Pix creditada. - **account** (string) - Conta creditada. - **branch** (string) - Agência creditada. - **taxId** (string) - CPF/CNPJ creditado. - **name** (string) - Nome creditado. - **accountType** (string) - Tipo da conta creditada. - **remittanceInformation** (string) - Informações de remessa. - **recurrencyAccept** (boolean) - Indica se a recorrência é aceita. - **recurrency** (object) - Detalhes da recorrência. - **journeyType** (number) - Tipo da jornada. - **interval** (object) - Intervalo da recorrência. - **start** (string) - Data de início. - **end** (string) - Data de fim. - **frequencyType** (string) - Tipo de frequência. - **recurrencyAmountType** (string) - Tipo de valor da recorrência. - **amount** (number) - Valor da recorrência. - **recurrencyMaxAmount** (number) - Valor máximo da recorrência. - **maxValueFloor** (string) - Valor mínimo da recorrência. - **creditParty** (object) - Detalhes da parte creditada na recorrência. - **taxId** (string) - CPF/CNPJ. - **name** (string) - Nome. - **bank** (string) - Código do banco. - **debitParty** (object) - Detalhes da parte debitada na recorrência. - **name** (string) - Nome. - **taxId** (string) - CPF/CNPJ. - **bank** (string) - Código do banco. - **branch** (string) - Agência. - **account** (string) - Conta. - **accountType** (string) - Tipo da conta. - **stateCode** (string) - Código do estado. - **maxAmount** (string) - Valor máximo. - **debtor** (object) - Detalhes do devedor. - **taxId** (string) - CPF/CNPJ. - **name** (string) - Nome. - **contract** (object) - Detalhes do contrato. - **number** (string) - Número do contrato. - **description** (string) - Descrição do contrato. - **taxIdPaymentInitiator** (string) - CPF/CNPJ do iniciador do pagamento. #### Response Example ```json { "status": "PROCESSING", "version": "1.0.0", "body": { "id": "81c83a3e-728e-48e5-a8b9-3459d1cb1c79", "amount": 584.71, "clientCode": "bb877108-657a-4c39-aec6-e836a9cc25af", "transactionIdentification": "6200770704454492b187705eba48de68", "endToEndId": "E139358932025071818222NYE7gQVL3C", "initiationType": "DYNAMIC_QRCODE", "paymentType": "IMMEDIATE", "urgency": "HIGH", "transactionType": "TRANSFER", "debitParty": { "account": "4171740", "branch": "0001", "taxId": "46128231845", "name": "Blanca Fritsch", "accountType": "TRAN" }, "creditParty": { "bank": "99999918", "key": "f4c6089a-bfde-4c00-a2d9-9eaa584b0219", "account": "121212", "branch": "1235", "taxId": "99999918999924", "name": "teste", "accountType": "TRAN" }, "remittanceInformation": null, "recurrencyAccept": true, "recurrency": { "journeyType": 3, "interval": { "start": "2025-07-18T00:00:00", "end": null, "frequencyType": "MONTHLY" }, "recurrencyAmountType": "FIXED", "amount": 321.52, "recurrencyMaxAmount": 0, "maxValueFloor": null, "creditParty": { "taxId": "99999918999924", "name": "Pix Tester 918", "bank": "99999918" }, "debitParty": { "name": "Blanca Fritsch", "taxId": "46128231845", "bank": "13935893", "branch": "0001", "account": "4171740", "accountType": "CACC", "stateCode": "0", "maxAmount": null }, "debtor": { "taxId": "13935893000109", "name": "INTEGRATED SOLUTIONS TO BUSINE" }, "contract": { "number": "85092252", "description": "Serviço de Segurança" } }, "taxIdPaymentInitiator": null } } ``` ``` -------------------------------- ### List Sweeping Accounts Consents (Python) Source: https://developers.celcoin.com.br/docs/copy-of-listar-consentimentos Example of how to list sweeping accounts consents using Python with the requests library. Shows how to define the URL, payload, and headers for the GET request. ```python import requests url = "http://sandbox.openfinance.celcoin.com.br/baas/v1/open/itp/sweeping-accounts/payment-initiation?status=AUTHORISED&initialDate=2025-11-28&finalDate=2025-11-27&page=1&pageSize=10" payload = {} headers = { 'Authorization': '••••••' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text) ``` -------------------------------- ### List Customers Request Example Source: https://developers.celcoin.com.br/docs/listar-clientes Use this cURL command to list customers. Ensure you replace {TOKEN} with your valid authorization token. The parameters allow filtering by account, documents, emails, dates, external IDs, and status. ```curl curl --request GET \ --url 'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/customers?account=1&documents=96139639956%2C84958444351&emails=teste5140email210%40galaxpay.com.br%2Cteste5171email5108%40galaxpay.com.br&createdAtFrom=2026-01-01&createdAtTo=2026-01-01&createdOrUpdatedAtFrom=2026-01-01&createdOrUpdatedAtTo=2026-01-01&myIds=1%2C2%2C3&galaxPayIds=4%2C5%2C6&startAt=0&status=active&limit=10&order=createdAt.asc' \ --header 'accept: application/json' \ --header 'authorization: Bearer {TOKEN}' ```