{"id":19956582,"url":"https://github.com/astrotechlabs/asaas-sdk","last_synced_at":"2026-06-09T03:06:52.124Z","repository":{"id":212842253,"uuid":"725619903","full_name":"AstrotechLabs/asaas-sdk","owner":"AstrotechLabs","description":"Uma abstração a API do Asaas V3 para facilitar o uso dos serviços do Asaas","archived":false,"fork":false,"pushed_at":"2023-12-24T17:37:58.000Z","size":63,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-04-26T18:23:04.911Z","etag":null,"topics":["api-rest","asaas","asaas-api","integration","library","php"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AstrotechLabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-30T14:25:55.000Z","updated_at":"2024-01-07T16:14:08.000Z","dependencies_parsed_at":"2023-12-16T18:06:42.728Z","dependency_job_id":"db431cfe-4bb4-456f-bf1f-4ac2a3079534","html_url":"https://github.com/AstrotechLabs/asaas-sdk","commit_stats":null,"previous_names":["astrotechlabs/asaas-sdk"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AstrotechLabs%2Fasaas-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AstrotechLabs%2Fasaas-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AstrotechLabs%2Fasaas-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AstrotechLabs%2Fasaas-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AstrotechLabs","download_url":"https://codeload.github.com/AstrotechLabs/asaas-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241389109,"owners_count":19955106,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-rest","asaas","asaas-api","integration","library","php"],"created_at":"2024-11-13T01:34:53.064Z","updated_at":"2025-11-27T04:04:09.693Z","avatar_url":"https://github.com/AstrotechLabs.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Assas Pay SDK para PHP\n\nEste é um repositório que possui uma abstração a API do Asaas V3, facilitando a criação de PIX Copia e Cola como também outros serviços oferecidos\n\n## Instalação\n\nA forma mais recomendada de instalar este pacote é através do [composer](http://getcomposer.org/download/).\n\nPara instalar, basta executar o comando abaixo\n\n```bash\n$ php composer.phar require astrotechlabs/asaas-sdk\n```\n\nou adicionar esse linha\n\n```\n\"astrotechlabs/asaas-sdk\": \"^1.0\"\n```\n\nna seção `require` do seu arquivo `composer.json`.\n\n## COMO USAR?\n\n## Criação de um depósito via PIX\nCom o código abaixo você consegue fazer a criação de uma cobrança via PIX, onde serão retornadas os dados da **Chave Pix Cópia/Cola** (`copyPasteUrl`) como também já é retornado um **QRCode em base64** (`qrCode`) para você disponibilizar para o frontend da sua aplicação.\n\n```php\nuse AstrotechLabs\\AsaasSdk\\AssasGateway;\nuse AstrotechLabs\\AsaasSdk\\AssasGatewayParams;\nuse AstrotechLabs\\AsaasSdk\\Pix\\CreatePixCharge\\Dto\\PixData;\nuse AstrotechLabs\\AsaasSdk\\Pix\\Enum\\BillingTypes;\n\n$asaasGateway = new AssasGateway(new AssasGatewayParams(\n    apiKey: 'xxxxxxxxxx',\n    // isSandBox: true (opcional)\n));\n\n$pixChargeResponse = $asaasGateway-\u003ecreatePixCharge(new PixData(\n    customer: new CustomerData(\n        name: 'Joãozinho Barbosa',\n        phone: '999999999',\n        cpfCnpj: '01234567890'\n    ),\n    billingType: BillingTypes::PIX,\n    value: 100.00,\n    dueDate: \"2023-12-20\" // Deve ser informada uma data futura\n));\n\nprint_r($pixChargeResponse);\n```\n\n### Saída\n```\n[\n    'gatewayId': 'pay_kp6gqaovguxqr1od',\n    'paymentUrl': 'https://sandbox.asaas.com/i/kp6gqaovguxqr1od',\n    'copyPasteUrl': '00020101021226820014br.gov.bcb.pix2560qrpix-h.bradesco.com.br/xxxxxxxxx-xxxx......',\n    'details' =\u003e [\n        'object' =\u003e 'payment'\n        'id' =\u003e 'pay_kp6gqaovguxqr1od'\n        'dateCreated' =\u003e '2023-12-16'\n        'customer' =\u003e 'cus_000005797885'\n        'paymentLink' =\u003e 'https://sandbox.asaas.com/i/xxxxxxxxxxx',\n        ..............\n    ],\n    'qrCode' =\u003e 'data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAYsAAA......'\n]\n```\n\n### Webhook\nQuando é confirmada a transação via PIX o payload JSON abaixo é enviado para sua aplicação pela URL configurada no Backoffice do Asaas.\n\n```json\n{\n   \"event\":\"PAYMENT_RECEIVED\",\n   \"payment\":{\n      \"object\":\"payment\",\n      \"id\":\"pay_080225913252\",\n      \"dateCreated\":\"2021-01-01\",\n      \"customer\":\"cus_G7Dvo4iphUNk\",\n      \"subscription\":\"sub_VXJBYgP2u0eO\",  \n      \"installment\":\"2765d086-c7c5-5cca-898a-4262d212587c\",\n      \"paymentLink\":\"123517639363\",\n      \"dueDate\":\"2021-01-01\",\n      \"originalDueDate\":\"2021-01-01\",\n      \"value\":100,\n      \"netValue\":94.51,\n      \"originalValue\":null,\n      \"interestValue\":null,\n      \"nossoNumero\": null,\n      \"description\":\"Pedido 056984\",\n      \"externalReference\":\"056984\",\n      \"billingType\":\"CREDIT_CARD\",\n      \"status\":\"RECEIVED\",\n      \"pixTransaction\":null,\n      \"confirmedDate\":\"2021-01-01\",\n      \"paymentDate\":\"2021-01-01\",\n      \"clientPaymentDate\":\"2021-01-01\",\n      \"installmentNumber\": null,\n      \"creditDate\":\"2021-02-01\",\n      \"custody\": null,\n      \"estimatedCreditDate\":\"2021-02-01\",\n      \"invoiceUrl\":\"https://www.asaas.com/i/080225913252\",\n      \"bankSlipUrl\":null,\n      \"transactionReceiptUrl\":\"https://www.asaas.com/comprovantes/4937311816045162\",\n      \"invoiceNumber\":\"00005101\",\n      \"deleted\":false,\n      \"anticipated\":false,\n      \"anticipable\":false,\n      \"lastInvoiceViewedDate\":\"2021-01-01 12:54:56\",\n      \"lastBankSlipViewedDate\":null,\n      \"postalService\":false,\n      \"creditCard\":{\n         \"creditCardNumber\":\"8829\",\n         \"creditCardBrand\":\"MASTERCARD\",\n         \"creditCardToken\":\"a75a1d98-c52d-4a6b-a413-71e00b193c99\"\n      },\n      \"discount\":{\n         \"value\":0.00,\n         \"dueDateLimitDays\":0,\n         \"limitedDate\": null,\n         \"type\":\"FIXED\"\n      },\n      \"fine\":{\n         \"value\":0.00,\n         \"type\":\"FIXED\"\n      },\n      \"interest\":{\n         \"value\":0.00,\n         \"type\":\"PERCENTAGE\"\n      },\n      \"split\":[\n         {\n            \"walletId\":\"48548710-9baa-4ec1-a11f-9010193527c6\",\n            \"fixedValue\":20,\n            \"status\":\"PENDING\",\n            \"refusalReason\": null\n         },\n         {\n            \"walletId\":\"0b763922-aa88-4cbe-a567-e3fe8511fa06\",\n            \"percentualValue\":10,\n            \"status\":\"PENDING\",\n            \"refusalReason\": null\n         }\n      ],\n      \"chargeback\": {\n          \"status\": \"REQUESTED\",\n          \"reason\": \"PROCESS_ERROR\"\n      },\n      \"refunds\": null\n   }\n}\n```\n\nPara mais detalhes sobre o webhook veja a [documentação aqui.](https://docs.asaas.com/docs/webhook-para-cobrancas)\n\n## Criação de uma transferência\nCom o código abaixo você consegue fazer a criação de uma transferência via **PIX**\n\n```php\nuse AstrotechLabs\\AsaasSdk\\AssasGateway;\nuse AstrotechLabs\\AsaasSdk\\AssasGatewayParams;\nuse AstrotechLabs\\AsaasSdk\\Transfer\\CreateTransferCharge\\Dto\\TransferData;\nuse AstrotechLabs\\AsaasSdk\\Transfer\\Enum\\PixKeyTypes;\n\n$asaasGateway = new AssasGateway(new AssasGatewayParams(\n    apiKey: $_ENV['ASAAS_API_KEY'],\n    isSandBox: false\n));\n\n$transferChargeResponse = $asaasGateway-\u003ecreateTransferCharge(new TransferData(\n    value: 1,\n    pixAddressKey: 'xxxxxxxx-xxxxx-xxxxx-xxxx',\n    pixAddressKeyType: PixKeyTypes::RANDOM_KEY\n));\n\nprint_r($transferChargeResponse);\n```\n\n### Saída\n```\n[\n    'gatewayId' =\u003e 'fb408225-8d98-4afe-b193-894cbdf1db55'\n    'status' =\u003e 'PENDING'\n    'fee' =\u003e 0\n    'value' =\u003e 1\n    'authorized' =\u003e false\n    'details' =\u003e [\n        'object' =\u003e 'transfer'\n        'id' =\u003e 'fb408225-8d98-4afe-b193-894cbdf1db55'\n        'value' =\u003e 1.0,\n        ........\n    ]\n]\n```\n\n### Webhook\nQuando é confirmada a transação via de transferência o payload JSON abaixo é enviado para sua aplicação pela URL configurada no Backoffice do Asaas.\n\n```json\n{\n    \"event\": \"TRANSFER_CREATED\",\n    \"transfer\": {\n        \"object\": \"transfer\",\n        \"id\": \"777eb7c8-b1a2-4356-8fd8-a1b0644b5282\",\n        \"dateCreated\": \"2019-05-02\",\n        \"status\": \"PENDING\",\n        \"effectiveDate\": null,\n        \"endToEndIdentifier\": null,\n        \"type\": \"BANK_ACCOUNT\",\n        \"value\": 1000,\n        \"netValue\": 1000,\n        \"transferFee\": 0,\n        \"scheduleDate\": \"2019-05-02\",\n        \"authorized\": true,\n        \"failReason\": null,\n        \"transactionReceiptUrl\": null,\n        \"bankAccount\": {\n            \"bank\": {\n                \"ispb\": \"00000000\",\n                \"code\": \"001\",\n                \"name\": \"Banco do Brasil\"\n            },\n            \"accountName\": \"Conta Banco do Brasil\",\n            \"ownerName\": \"Marcelo Almeida\",\n            \"cpfCnpj\": \"***.143.689-**\",\n            \"agency\": \"1263\",\n            \"agencyDigit\": \"1\",\n            \"account\": \"26544\",\n            \"accountDigit\": \"1\",\n            \"pixAddressKey\": null\n        },\n        \"operationType\": \"TED\",\n        \"description\": null\n    }\n}\n```\n\nPara mais detalhes sobre o webhook veja a [documentação aqui.](https://docs.asaas.com/docs/webhook-para-transferencias)\n\n## Contribuição\n\nPull Request são bem-vindas. Para mudanças importantes, abra primeiro uma issue para discutir o que você gostaria de mudar.\n\nCertifique-se de atualizar os testes conforme apropriado.\n\n## Licença\n\nEste pacote é lançado sob a licença [MIT](https://choosealicense.com/licenses/mit/). Consulte o pacote [LICENSE](./LICENSE) para obter detalhes.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fastrotechlabs%2Fasaas-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fastrotechlabs%2Fasaas-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fastrotechlabs%2Fasaas-sdk/lists"}