### Define WebhookCreateSuccess Schema and Example Source: https://docs.goatpay.com.br/openapi.yaml Schema and example for webhook registration, noting that the secret is returned only once. ```yaml WebhookCreateSuccess: description: Webhook cadastrado (secret exibido uma vez). content: application/json: schema: type: object required: - success - message - data properties: success: type: boolean message: type: string data: $ref: '#/components/schemas/PublicWebhookCreateData' requestId: type: string examples: created: summary: Endpoint criado value: success: true message: Webhook criado com sucesso data: item: id: clx_webhook url: https://api.exemplo.com/webhooks/goatpay description: Produção events: - payment.paid - transfer.completed status: ACTIVE createdAt: '2026-06-01T10:00:00.000Z' secret: whsec_abc123def456ghi789 requestId: req_wh001 ``` -------------------------------- ### Account Balance Response Example Source: https://docs.goatpay.com.br/api-reference/endpoint/account/balance Example JSON response structure returned when successfully querying the account balance. ```json { "success": true, "message": "Saldo consultado com sucesso", "data": { "currency": "BRL", "availableAmount": 1000, "pendingAmount": 50, "blockedAmount": 0, "totalAmount": 1050, "status": "ACTIVE", "padrao": { "available": 1000, "pending": 50, "withdrawable": 950, "locked24h": 50, "nextUnlockAt": "2026-06-02T10:00:00.000Z" } }, "requestId": "req_bal001" } ``` -------------------------------- ### Create PIX Payment Request Examples Source: https://docs.goatpay.com.br/api-reference/endpoint/payment-pix/create Examples of JSON request bodies for creating a PIX payment, demonstrating both gross and net amount configurations. ```json { "amount": 100, "description": "Pedido 123", "coverFee": false } ``` ```json { "amount": 100, "description": "Pedido 123", "coverFee": true } ``` -------------------------------- ### Create PIX Refund Request Examples Source: https://docs.goatpay.com.br/openapi.yaml Examples for the createPixRefund operation, showing both transaction ID and EndToEndId based refund requests. ```yaml transactionId: clx_pix_in refundId: devolucao-pedido-123 amount: 100 nature: ORIGINAL description: Estorno pedido ``` ```yaml e2eId: E12345678202505301234567890123456 refundId: devolucao-pedido-123 ``` -------------------------------- ### List Webhooks Response Example Source: https://docs.goatpay.com.br/api-reference/endpoint/webhooks/list Example response structure returned by the /webhooks/list endpoint, showing two configured webhook endpoints. ```json success: true message: Webhooks listados com sucesso data: items: - id: clx_webhook_a url: https://api.exemplo.com/hooks/a description: Produção events: - payment.paid status: ACTIVE createdAt: '2026-06-01T10:00:00.000Z' - id: clx_webhook_b url: https://api.exemplo.com/hooks/b description: Homologação events: - webhook.test status: DISABLED createdAt: '2026-05-20T08:00:00.000Z' requestId: req_wh002 ``` -------------------------------- ### GET /v1/products/get/{id} Source: https://docs.goatpay.com.br/api-reference/endpoint/products/get Consulta um produto pelo ID. ```APIDOC ## GET /v1/products/get/{id} ### Description Consulta um produto pelo ID. ### Method GET ### Endpoint https://api.goatpay.com.br/v1/products/get/{id} ### Parameters #### Path Parameters - **id** (string) - Required - ID do produto. ### Request Example ```bash curl 'https://api.goatpay.com.br/v1/products/get/clx_product' \ -H 'X-API-Key: gp_live_SUA_CHAVE' ``` ### Response #### Success Response (200) - **success** (boolean) - Indica sucesso da requisição - **message** (string) - Mensagem de retorno - **data** (object) - Objeto contendo os detalhes do produto - **requestId** (string) - ID da requisição #### Response Example ```json { "success": true, "message": "Produto encontrado", "data": { "id": "clx_product", "name": "Curso completo", "sku": "CURSO-001", "price": 197, "status": "ACTIVE", "deliveries": [{ "type": "LINK", "redirectUrl": "https://loja.com/area-membros" }], "hasImage": true, "salesCount": 12 }, "requestId": "req_abc" } ``` ``` -------------------------------- ### POST /subaccount/portal/setup Source: https://docs.goatpay.com.br/api-reference/endpoint/subaccount/portal/setup Configures the login credentials for a subaccount's Portal Wallet. ```APIDOC ## POST /subaccount/portal/setup ### Description Configures the Portal Wallet login for a specific subaccount. Requires either the subaccount ID or an external reference. ### Method POST ### Endpoint /subaccount/portal/setup ### Request Body - **id** (string) - Optional - The ID of the subaccount. - **externalReference** (string) - Optional - The external reference of the subaccount (max 64 chars). - **email** (string) - Required - The email address for the portal login. - **password** (string) - Required - The password for the portal login (min 8 chars). ### Response #### Success Response (200) - **success** (boolean) - Indicates if the operation was successful. - **message** (string) - Status message. - **data** (object) - Contains the result of the setup. - **requestId** (string) - Unique identifier for the request. #### Response Example { "success": true, "message": "Portal Wallet configurado", "data": { "success": true, "mode": "portal_ready" }, "requestId": "req_abc123" } ``` -------------------------------- ### POST /v1/subaccount/portal/setup Source: https://docs.goatpay.com.br/api-reference/guides/subcontas Configures portal access for an existing subaccount that does not yet have login credentials. ```APIDOC ## POST /v1/subaccount/portal/setup ### Description Sets up portal login credentials for an existing subaccount. ### Method POST ### Endpoint /v1/subaccount/portal/setup ### Parameters #### Request Body - **id** (string) - Optional - Subaccount ID - **externalReference** (string) - Optional - Subaccount external reference ID - **email** (string) - Required - E-mail for portal login - **password** (string) - Required - Password for the operator ### Request Example { "externalReference": "loja-parceiro-a", "email": "operador@empresa.com", "password": "SenhaForte!123" } ### Response #### Success Response (200) - **success** (boolean) - Indicates if the operation was successful - **mode** (string) - Status of the portal setup ``` -------------------------------- ### PIX Deposit Response Examples Source: https://docs.goatpay.com.br/openapi.yaml Examples of successful responses for created and paid PIX deposits. ```json { "success": true, "message": "Pagamento PIX criado com sucesso", "data": { "id": "clx_transacao", "type": "PIX_IN", "status": "PENDING", "amount": 100, "feeAmount": 0.5, "netAmount": 99.5, "coverFee": false, "currency": "BRL", "countsTowardPixBalance": true, "settlementScope": "goatpay", "description": "Pedido 123", "externalReference": "pedido-123", "referenceId": "ref_pix_abc", "copyPaste": "000201010212...", "qrCodeBase64": "data:image/png;base64,...", "qrcodeUrl": "https://pay.goatpay.com.br/p/clx_transacao", "expiresAt": "2026-06-02T12:00:00.000Z", "createdAt": "2026-06-01T12:00:00.000Z" }, "requestId": "req_abc123" } ``` ```json { "success": true, "message": "Pagamento PIX encontrado", "data": { "id": "clx_transacao", "type": "PIX_IN", "status": "COMPLETED", "amount": 100, "feeAmount": 0.5, "netAmount": 99.5, "coverFee": false, "currency": "BRL", "countsTowardPixBalance": true, "settlementScope": "goatpay", "description": "Pedido 123", "externalReference": "pedido-123", "referenceId": "ref_pix_abc", "endToEndId": "E12345678202505301234567890123456", "payer": { "name": "João da Silva", "document": "12345678909" }, "completedAt": "2026-06-01T12:05:00.000Z", "createdAt": "2026-06-01T12:00:00.000Z" }, "requestId": "req_abc123" } ``` -------------------------------- ### List Products Request Source: https://docs.goatpay.com.br/api-reference/guides/loja Example request to list products using cURL with an API key. ```bash curl 'https://api.goatpay.com.br/v1/products/list' \ -H 'X-API-Key: gp_live_SUA_CHAVE' ``` -------------------------------- ### Webhook List Response Example Source: https://docs.goatpay.com.br/openapi.yaml Example JSON response structure for a successful retrieval of a list of webhooks. ```yaml success: true message: Webhooks listados com sucesso data: items: - id: clx_webhook_a url: https://api.exemplo.com/hooks/a description: Produção events: - payment.paid status: ACTIVE createdAt: '2026-06-01T10:00:00.000Z' - id: clx_webhook_b url: https://api.exemplo.com/hooks/b description: Homologação events: - webhook.test status: DISABLED createdAt: '2026-05-20T08:00:00.000Z' requestId: req_wh002 ``` -------------------------------- ### PIX Payment Response Examples Source: https://docs.goatpay.com.br/api-reference/endpoint/payment-pix/create Examples of successful API responses for created and paid PIX transactions. ```json { "success": true, "message": "Pagamento PIX criado com sucesso", "data": { "id": "clx_transacao", "type": "PIX_IN", "status": "PENDING", "amount": 100, "feeAmount": 0.5, "netAmount": 99.5, "coverFee": false, "currency": "BRL", "countsTowardPixBalance": true, "settlementScope": "goatpay", "description": "Pedido 123", "externalReference": "pedido-123", "referenceId": "ref_pix_abc", "copyPaste": "000201010212...", "qrCodeBase64": "data:image/png;base64,...", "qrcodeUrl": "https://pay.goatpay.com.br/p/clx_transacao", "expiresAt": "2026-06-02T12:00:00.000Z", "createdAt": "2026-06-01T12:00:00.000Z" }, "requestId": "req_abc123" } ``` ```json { "success": true, "message": "Pagamento PIX encontrado", "data": { "id": "clx_transacao", "type": "PIX_IN", "status": "COMPLETED", "amount": 100, "feeAmount": 0.5, "netAmount": 99.5, "coverFee": false, "currency": "BRL", "countsTowardPixBalance": true, "settlementScope": "goatpay", "description": "Pedido 123" } } ``` -------------------------------- ### POST /v1/subaccount/portal/setup Source: https://docs.goatpay.com.br/api-reference/endpoint/subaccount/portal/setup Cria ou redefine o e-mail e a senha do operador na subconta. ```APIDOC ## POST /v1/subaccount/portal/setup ### Description Cria ou redefine o e-mail e a senha do operador na subconta. O operador ganha acesso imediato ao portal sem necessidade de confirmação por e-mail. ### Method POST ### Endpoint https://api.goatpay.com.br/v1/subaccount/portal/setup ### Parameters #### Request Body - **id** (string) - Optional - ID da subconta. Informe id ou externalReference. - **externalReference** (string) - Optional - Referência externa da subconta. - **email** (string) - Required - E-mail de login (único na plataforma para portal). - **password** (string) - Required - Senha do operador (mín. 8 caracteres, maiúscula, minúscula, número e símbolo). ### Request Example { "externalReference": "loja-parceiro-a", "email": "operador@empresa.com", "password": "SenhaForte!123" } ### Response #### Success Response (200) - **success** (boolean) - Status da operação. - **message** (string) - Mensagem de confirmação. - **data** (object) - Objeto contendo o status e modo do portal. - **requestId** (string) - Identificador da requisição. #### Response Example { "success": true, "message": "Portal Wallet configurado", "data": { "success": true, "mode": "portal_ready" }, "requestId": "req_abc123" } ``` -------------------------------- ### Configurar Portal Wallet via cURL Source: https://docs.goatpay.com.br/api-reference/endpoint/subaccount/portal/setup Realiza a configuração do portal enviando as credenciais do operador e a referência da subconta. ```bash curl -X POST 'https://api.goatpay.com.br/v1/subaccount/portal/setup' \ -H 'X-API-Key: gp_live_SUA_CHAVE' \ -H 'Content-Type: application/json' \ -d '{ "externalReference": "loja-parceiro-a", "email": "operador@empresa.com", "password": "SenhaForte!123" }' ``` -------------------------------- ### POST /v1/customers/create Source: https://docs.goatpay.com.br/api-reference/endpoint/customers/create Endpoint para cadastrar um novo cliente no sistema GoatPay. ```APIDOC ## POST /v1/customers/create ### Description Cadastra um novo pagador (CPF/CNPJ) para processamento de cobranças e assinaturas. ### Method POST ### Endpoint https://api.goatpay.com.br/v1/customers/create ### Parameters #### Request Body - **name** (string) - Required - Nome (até 200 caracteres). - **email** (string) - Required - E-mail. - **document** (string) - Required - CPF (11) ou CNPJ (14 dígitos). - **phone** (string) - Optional - Telefone. - **type** (string) - Optional - PF ou PJ (inferido pelo documento se omitido). ### Request Example { "name": "Cliente Teste", "email": "cliente@email.com", "document": "12345678909" } ### Response #### Success Response (200) - **success** (boolean) - Indica sucesso na operação. - **message** (string) - Mensagem de confirmação. - **data** (object) - Objeto contendo os detalhes do cliente criado. - **requestId** (string) - Identificador único da requisição. #### Response Example { "success": true, "message": "Cliente criado", "data": { "id": "clx_customer", "name": "Cliente Exemplo", "email": "cliente@email.com", "whatsapp": "11999999999", "phone": "11999999999", "document": "123.456.789-09", "city": "São Paulo", "state": "SP", "type": "PF", "status": "Ativo", "createdAt": "2026-07-01T12:00:00.000Z", "lastActivityAt": "2026-07-04T10:00:00.000Z", "transactions": 5, "volume": 499.5 }, "requestId": "req_abc" } ``` -------------------------------- ### Create PIX Refund Request Examples Source: https://docs.goatpay.com.br/api-reference/endpoint/refunds/create Examples of JSON request bodies for creating a PIX refund, either by transaction ID or by EndToEndId. ```json { "transactionId": "clx_pix_in", "refundId": "devolucao-pedido-123", "amount": 100, "nature": "ORIGINAL", "description": "Estorno pedido" } ``` ```json { "e2eId": "E12345678202505301234567890123456", "refundId": "devolucao-pedido-123" } ``` -------------------------------- ### POST /v1/payment-pix/create Source: https://docs.goatpay.com.br/api-reference/endpoint/payment-pix/create Gera um QR Code PIX para o cliente realizar o pagamento. ```APIDOC ## POST /v1/payment-pix/create ### Description Gera um QR Code PIX para o cliente realizar o pagamento. ### Method POST ### Endpoint https://api.goatpay.com.br/v1/payment-pix/create ### Parameters #### Request Body - **amount** (number) - Required - Valor em reais. Mínimo R$ 1,00. - **description** (string) - Required - Descrição da cobrança (3 a 180 caracteres). - **coverFee** (boolean) - Optional - Se true, amount é o líquido desejado. Padrão false. - **emitFiscalInvoice** (boolean) - Optional - Se true, emite nota fiscal após pagamento. - **expirationSeconds** (integer) - Optional - Tempo de expiração do QR Code PIX em segundos. Padrão 86400. - **payerName** (string) - Optional - Nome do pagador. - **payerDocument** (string) - Optional - CPF ou CNPJ do pagador. - **externalReference** (string) - Optional - Referência externa do seu sistema. - **splitUser** (string) - Optional - E-mail GoatPay do parceiro no split interno. - **splitTax** (number) - Optional - Percentual do líquido repassado ao splitUser (0,01 a 100). ### Request Example { "amount": 100, "description": "Pedido 123", "coverFee": false, "emitFiscalInvoice": false } ### Response #### Success Response (200) - **success** (boolean) - Indica sucesso da operação. - **message** (string) - Mensagem de confirmação. - **data** (object) - Objeto contendo detalhes da transação (id, status, amount, copyPaste, qrCodeImage, expiresAt). - **requestId** (string) - Identificador da requisição. #### Response Example { "success": true, "message": "Pagamento PIX criado com sucesso", "data": { "id": "clx_transacao", "status": "PENDING", "amount": 100, "copyPaste": "000201010212...", "qrCodeImage": "data:image/png;base64,...", "expiresAt": "2026-07-08T12:00:00.000Z" }, "requestId": "req_abc" } ``` -------------------------------- ### POST /anticipations/simulate Source: https://docs.goatpay.com.br/openapi.yaml Simular antecipação. ```APIDOC ## POST /anticipations/simulate ### Description Simular antecipação. ### Method POST ### Endpoint /anticipations/simulate ### Request Body - **chargeId** (string) - Required ``` -------------------------------- ### POST /products/create Source: https://docs.goatpay.com.br/openapi.yaml Creates a new product in the store. Note that image uploads are only supported via the dashboard. ```APIDOC ## POST /products/create ### Description Criar produto. Permissão `products/create`. Upload de imagem apenas no dashboard. ### Method POST ### Endpoint /products/create ### Request Body - **CreateStoreProduct** (schema) - Required - The product details. ``` -------------------------------- ### GET /subaccount/list Source: https://docs.goatpay.com.br/openapi.yaml Listar subcontas. ```APIDOC ## GET /subaccount/list ### Description Listar subcontas. ### Method GET ### Endpoint /subaccount/list ### Parameters #### Query Parameters - **page** (integer) - Optional - Número da página - **limit** (integer) - Optional - Limite de itens por página - **status** (string) - Optional - Status da subconta (ACTIVE, DISABLED) ``` -------------------------------- ### GET /anticipations/list Source: https://docs.goatpay.com.br/openapi.yaml Listar antecipações. ```APIDOC ## GET /anticipations/list ### Description Listar antecipações. ### Method GET ### Endpoint /anticipations/list ``` -------------------------------- ### POST /v1/subscriptions/create Source: https://docs.goatpay.com.br/api-reference/endpoint/subscriptions/create Cria uma nova assinatura recorrente com cobrança automática. ```APIDOC ## POST /v1/subscriptions/create ### Description Cria uma nova assinatura recorrente com cobrança automática em um ciclo fixo. ### Method POST ### Endpoint https://api.goatpay.com.br/v1/subscriptions/create ### Parameters #### Request Body - **method** (string) - Required - BOLETO, CARD_CREDIT ou PIX. - **amount** (number) - Required - Valor de cada ciclo em reais. - **customer** (object) - Required - Pagador: name, taxId, email e phone opcionais, id opcional. - **cycle** (string) - Required - WEEKLY, BIWEEKLY, MONTHLY, BIMONTHLY, QUARTERLY, SEMIANNUALLY ou YEARLY. - **nextDueDate** (string) - Required - Primeiro vencimento (YYYY-MM-DD). - **description** (string) - Optional - Descrição da assinatura. - **cardToken** (string) - Optional - Token do cartão quando method é CARD_CREDIT. - **creditCard** (object) - Optional - Dados do cartão na primeira cobrança (CARD_CREDIT). - **creditCardHolderInfo** (object) - Optional - Titular do cartão (obrigatório com creditCard). - **remoteIp** (string) - Optional - IP do comprador (CARD_CREDIT). Se omitido, usa o IP da requisição. ### Request Example { "method": "BOLETO", "amount": 99.9, "cycle": "MONTHLY", "nextDueDate": "2026-08-01", "description": "Plano Premium", "customer": { "name": "Maria Silva", "taxId": "12345678909", "email": "maria@exemplo.com" } } ### Response #### Success Response (200) - **success** (boolean) - Status da operação. - **message** (string) - Mensagem de confirmação. - **data** (object) - Detalhes da assinatura criada. - **requestId** (string) - ID da requisição. #### Response Example { "success": true, "message": "Assinatura criada com sucesso", "data": { "subscriptionId": "sub_abc123", "externalId": "sub_ext_xyz", "status": "ACTIVE", "method": "BOLETO", "amount": 99.9, "cycle": "MONTHLY", "description": "Plano Premium", "nextDueDate": "2026-08-01", "createdAt": "2026-07-01T12:00:00.000Z", "customer": { "id": "12345678909", "name": "Maria Silva", "taxId": "12345678909" } }, "requestId": "req_abc123" } ``` -------------------------------- ### GET /payouts/list Source: https://docs.goatpay.com.br/openapi.yaml List all PIX payouts. ```APIDOC ## GET /payouts/list ### Description List all PIX payouts. ### Method GET ### Endpoint /payouts/list ``` -------------------------------- ### GET /v1/pix-automatic/payment-instructions/list Source: https://docs.goatpay.com.br/api-reference/endpoint/pix-automatic/payment-instructions-list Recupera uma lista de instruções de pagamento PIX Automático com suporte a paginação e filtros. ```APIDOC ## GET /v1/pix-automatic/payment-instructions/list ### Description Lista os débitos agendados ou concluídos de cada cobrança recorrente. ### Method GET ### Endpoint https://api.goatpay.com.br/v1/pix-automatic/payment-instructions/list ### Parameters #### Query Parameters - **offset** (number) - Optional - Índice inicial (padrão 0). - **limit** (number) - Optional - Itens por página (máx. 100). - **status** (string) - Optional - AWAITING_REQUEST, SCHEDULED, DONE, CANCELLED, REFUSED. - **paymentId** (string) - Optional - Filtrar por cobrança vinculada. ### Request Example curl -X GET 'https://api.goatpay.com.br/v1/pix-automatic/payment-instructions/list?offset=0&limit=10' \ -H 'X-API-Key: gp_live_SUA_CHAVE' ### Response #### Success Response (200) - **success** (boolean) - Indica sucesso da requisição. - **message** (string) - Mensagem informativa. - **data** (object) - Objeto contendo a lista de instruções. - **requestId** (string) - Identificador único da requisição. #### Response Example { "success": true, "message": "Instruções de pagamento listadas", "data": { "object": "list", "hasMore": false, "totalCount": 1, "limit": 10, "offset": 0, "data": [{ "id": "d1c9c4b2-6a97-4573-9d6d-26bb64f04c28", "status": "SCHEDULED", "value": 99.9, "scheduleDate": "2026-07-01", "authorizationId": "a33047b1-fb19-4b68-9373-a7ba8a8162aa", "paymentId": "clx_billing", "dateCreated": "2026-06-15T10:00:00.000Z" }] }, "requestId": "req_abc" } ``` -------------------------------- ### GET /anticipations/get/{id} Source: https://docs.goatpay.com.br/openapi.yaml Consultar antecipação. ```APIDOC ## GET /anticipations/get/{id} ### Description Consultar antecipação. ### Method GET ### Endpoint /anticipations/get/{id} ### Parameters #### Path Parameters - **id** (string) - Required - Resource ID ``` -------------------------------- ### GET /billings/list Source: https://docs.goatpay.com.br/openapi.yaml Listar cobranças avulsas. ```APIDOC ## GET /billings/list ### Description Listar cobranças avulsas. ### Method GET ### Endpoint /billings/list ### Parameters #### Query Parameters - **dateFrom** (string) - Optional - Date from - **dateTo** (string) - Optional - Date to - **status** (string) - Optional - PENDING, PROCESSING, CONFIRMED, RECEIVED, SETTLED, OVERDUE, CANCELED, FAILED, REFUNDED, PARTIALLY_REFUNDED, CHARGEBACK - **method** (string) - Optional - BOLETO, CARD_CREDIT, CARD_DEBIT, CARD_VOUCHER, PIX - **billingType** (string) - Optional - Deprecated. BOLETO, CARD_CREDIT, CARD_DEBIT, CARD_VOUCHER, PIX - **salesCustomerId** (string) - Optional - Sales customer ID - **externalReference** (string) - Optional - External reference - **search** (string) - Optional - Search term ``` -------------------------------- ### Configurar variável de ambiente da API Key Source: https://docs.goatpay.com.br/pages/guides/primeira-integracao Armazene sua chave de API recém-criada em uma variável de ambiente para uso seguro. ```bash export GOATPAY_API_KEY=gp_live_SUA_CHAVE ``` -------------------------------- ### GET /payment-crypto/currencies Source: https://docs.goatpay.com.br/openapi.yaml Lists all supported cryptocurrency currencies. ```APIDOC ## GET /payment-crypto/currencies ### Description Listar moedas cripto. ### Method GET ### Endpoint /payment-crypto/currencies ``` -------------------------------- ### Definição OpenAPI para listar produtos Source: https://docs.goatpay.com.br/api-reference/endpoint/products/list Especificação técnica do endpoint GET /products/list utilizando o padrão OpenAPI 3.1.0. ```yaml openapi: 3.1.0 info: title: GoatPay API description: > API pública merchant da GoatPay. Autenticação via header `X-API-Key: gp_live_...`. Respostas de sucesso usam o envelope `{ success, message, data, requestId }`. Campos internos (`accountId`, `metadata`, histórico de entregas de webhook, etc.) não são expostos. `providerTransactionId` aparece como `referenceId`; `providerInfractionId` como `infractionId`. Rate limit global: 100 requisições por minuto por API key (HTTP 429). Sem chave, limite por IP. version: 1.0.0 servers: - url: https://api.goatpay.com.br/v1 description: Produção security: - apiKeyAuth: [] tags: - name: pix description: >- Cobranças PIX (receber), reembolsos de depósito recebido e transferências PIX (enviar). Alias legado em payouts/* para envios. - name: transfer-internal description: Transferências entre contas GoatPay - name: transfer-scheduled description: Transferências programadas (agendar, repetir ou por saldo) - name: crypto description: Depósitos e transferências em criptomoeda - name: billings description: >- Cobranças avulsas (pagamento único) — boleto, cartão ou PIX na Conta Padrão (PF ou PJ) - name: subscriptions description: >- Assinaturas recorrentes com ciclo fixo — boleto, cartão ou PIX na Conta Padrão (PF ou PJ) - name: account description: Saldo e extrato - name: subaccount description: Subcontas merchant (carteiras lógicas sob a conta principal) - name: meds description: Disputas MED - name: webhooks description: Endpoints de webhook de saída - name: payouts description: Alias de transfer-pix para saques PIX - name: customers description: Clientes da loja (CRM) - name: products description: Produtos e entregas digitais - name: coupons description: Cupons de desconto para links - name: payment-links description: Links de pagamento e checkout hospedado paths: /products/list: get: tags: - products summary: Listar produtos operationId: listStoreProducts parameters: - $ref: '#/components/parameters/ListPage' - $ref: '#/components/parameters/ListPageSize' - name: search in: query schema: type: string - name: status in: query schema: type: string enum: - ACTIVE - INACTIVE responses: '200': $ref: '#/components/responses/StoreListSuccess' components: parameters: ListPage: name: page in: query schema: type: integer minimum: 1 default: 1 ListPageSize: name: pageSize in: query schema: type: integer minimum: 1 maximum: 100 default: 50 responses: StoreListSuccess: description: Lista paginada (clientes, produtos, cupons ou links). content: application/json: schema: type: object required: - success - message - data properties: success: type: boolean message: type: string data: $ref: '#/components/schemas/PublicPagedStoreList' requestId: type: string schemas: PublicPagedStoreList: type: object properties: items: type: array items: type: object page: type: integer pageSize: type: integer total: type: integer pages: type: integer securitySchemes: apiKeyAuth: type: apiKey in: header name: X-API-Key description: Chave `gp_live_...` criada em Integrações → Chaves de API no dashboard. ``` -------------------------------- ### Listar consultas de crédito via cURL Source: https://docs.goatpay.com.br/api-reference/endpoint/serasa/reports-list Realiza uma requisição GET para listar consultas de crédito, utilizando a chave de API no cabeçalho. ```bash curl -X GET 'https://api.goatpay.com.br/v1/serasa/reports/list?offset=0&limit=10' \ -H 'X-API-Key: gp_live_SUA_CHAVE' ``` -------------------------------- ### GET /webhooks/list Source: https://docs.goatpay.com.br/api-reference/guides/webhooks Retrieves a list of all configured webhooks. ```APIDOC ## GET /webhooks/list ### Description Lists all webhooks associated with the account. ### Method GET ### Endpoint /webhooks/list ``` -------------------------------- ### GET /account/balance Source: https://docs.goatpay.com.br/api-reference/endpoint/account/balance Consultar saldo da conta. ```APIDOC ## GET /account/balance ### Description Consultar saldo da conta. ### Method GET ### Endpoint /account/balance ### Response #### Success Response (200) - **success** (boolean) - Status da operação - **message** (string) - Mensagem de retorno - **data** (object) - Objeto contendo os saldos (currency, availableAmount, pendingAmount, blockedAmount, totalAmount, status, padrao) - **requestId** (string) - ID da requisição #### Response Example { "success": true, "message": "Saldo consultado com sucesso", "data": { "currency": "BRL", "availableAmount": 1000, "pendingAmount": 50, "blockedAmount": 0, "totalAmount": 1050, "status": "ACTIVE", "padrao": { "available": 1000, "pending": 50, "withdrawable": 950, "locked24h": 50, "nextUnlockAt": "2026-06-02T10:00:00.000Z" } }, "requestId": "req_bal001" } ``` -------------------------------- ### Autenticar requisição com X-API-Key Source: https://docs.goatpay.com.br/pages/guides/authentication Utilize o header X-API-Key para autenticar chamadas à API. O header Authorization com Bearer token é suportado para compatibilidade, mas o uso de X-API-Key é recomendado para novas implementações. ```bash curl https://api.goatpay.com.br/v1/account/balance \ -H "X-API-Key: gp_live_SUA_CHAVE" ``` -------------------------------- ### GET /payouts/get/{id} Source: https://docs.goatpay.com.br/openapi.yaml Consult a PIX payout by ID. ```APIDOC ## GET /payouts/get/{id} ### Description Consult a PIX payout by ID. ### Method GET ### Endpoint /payouts/get/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the payout. ``` -------------------------------- ### Consultar programação via cURL Source: https://docs.goatpay.com.br/api-reference/endpoint/transfer-scheduled/get Utilize este comando para buscar os dados de uma programação específica passando o ID na URL. ```bash curl -X GET 'https://api.goatpay.com.br/v1/transfer-scheduled/get/clx_sched_01' \ -H 'X-API-Key: gp_live_SUA_CHAVE' ``` -------------------------------- ### GET /webhooks/get/{id} Source: https://docs.goatpay.com.br/openapi.yaml Consult a specific webhook by ID. ```APIDOC ## GET /webhooks/get/{id} ### Description Consult a specific webhook by ID. ### Method GET ### Endpoint /webhooks/get/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the webhook. ``` -------------------------------- ### Get Subaccount Balance Source: https://docs.goatpay.com.br/openapi.yaml Retrieves the current balance for a subaccount. ```yaml /subaccount/balance: get: tags: - subaccount summary: Saldo da subconta operationId: getSubaccountBalance parameters: - name: id in: query schema: type: string - name: externalReference in: query schema: type: string responses: '200': $ref: '#/components/responses/SuccessEnvelope' ``` -------------------------------- ### POST /webhooks/create Source: https://docs.goatpay.com.br/api-reference/guides/webhooks Creates a new webhook configuration. ```APIDOC ## POST /webhooks/create ### Description Creates a new webhook in the system. ### Method POST ### Endpoint /webhooks/create ``` -------------------------------- ### GET /subaccount/get/{id} Source: https://docs.goatpay.com.br/openapi.yaml Retrieves details of a specific subaccount. ```APIDOC ## GET /subaccount/get/{id} ### Description Consults subaccount details. ### Method GET ### Endpoint /subaccount/get/{id} ### Parameters #### Path Parameters - **id** (string) - Required - Resource ID ``` -------------------------------- ### POST /v1/serasa/reports/create Source: https://docs.goatpay.com.br/api-reference/endpoint/serasa/reports-create Solicita uma nova consulta de crédito no Serasa. ```APIDOC ## POST /v1/serasa/reports/create ### Description Solicita uma nova consulta de crédito no Serasa. Taxa de referência: R$ 19,90. ### Method POST ### Endpoint https://api.goatpay.com.br/v1/serasa/reports/create ### Parameters #### Request Body - **customer** (string) - Optional - ID do cliente (POST /customers/create). - **cpfCnpj** (string) - Required - CPF ou CNPJ consultado. ### Request Example { "customer": "cus_cliente_abc", "cpfCnpj": "05666663755" } ### Response #### Success Response (200) - **success** (boolean) - Indica se a solicitação foi bem-sucedida. - **message** (string) - Mensagem de confirmação. - **data** (object) - Detalhes da consulta criada. - **requestId** (string) - ID da requisição. #### Response Example { "success": true, "message": "Consulta de crédito solicitada", "data": { "id": "6c5e73fa-9efd-4a75-b60c-1cafb8d1c7ed", "status": "PROCESSING", "cpfCnpj": "05666663755", "customer": "clx_customer", "dateCreated": "2026-05-31T10:00:00.000Z" }, "requestId": "req_abc" } ``` -------------------------------- ### GET /billings/get/{id} Source: https://docs.goatpay.com.br/openapi.yaml Retrieves details of a specific billing. ```APIDOC ## GET /billings/get/{id} ### Description Consultar cobrança avulsa. ### Method GET ### Endpoint /billings/get/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the billing. ``` -------------------------------- ### GET /coupons/get/{id} Source: https://docs.goatpay.com.br/openapi.yaml Retrieves details for a specific coupon. ```APIDOC ## GET /coupons/get/{id} ### Description Consultar cupom ### Method GET ### Endpoint /coupons/get/{id} ### Parameters #### Path Parameters - **id** (ResourceId) - Required - The unique identifier of the coupon. ``` -------------------------------- ### Listar clientes via cURL Source: https://docs.goatpay.com.br/api-reference/endpoint/customers/list Utilize este comando para recuperar a lista de clientes autenticando com sua chave de API. ```bash curl -X GET 'https://api.goatpay.com.br/v1/customers/list' \ -H 'X-API-Key: gp_live_SUA_CHAVE' ``` -------------------------------- ### GET /customers/list Source: https://docs.goatpay.com.br/openapi.yaml Lists customers with pagination and search capabilities. ```APIDOC ## GET /customers/list ### Description Lists customers with support for pagination and searching by name, e-mail, or document. ### Method GET ### Endpoint /customers/list ### Parameters #### Query Parameters - **search** (string) - Optional - Search term (max 120 chars). - **status** (string) - Optional - Filter by status (active/inactive/blocked). ### Response #### Success Response (200) - **StoreListSuccess** (object) - List of customers. ```