Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.abacatepay.com/llms.txt

Use this file to discover all available pages before exploring further.

AbacatePay Ruby SDK

Repositório oficial — issues, changelog e contribuições.

​
Pré-requisitos

​
Instalação

# Adicione ao seu Gemfile:
gem 'abacatepay-ruby'
# Depois execute:
bundle install

​
Configuração

Armazene sua chave de API em uma variável de ambiente e nunca no código: 
# config/initializers/abacatepay.rb
AbacatePay.configure do |config|
  config.api_token   = ENV['ABACATEPAY_API_KEY']
  config.environment = :sandbox # ou :production
end

​
Primeira cobrança

billing_client = AbacatePay::Clients::BillingClient.new

billing = billing_client.create(
  AbacatePay::Resources::Billing.new(
    frequency: AbacatePay::Enums::Billing::Frequencies::ONE_TIME,
    methods:   [AbacatePay::Enums::Billing::Methods::PIX],
    products: [
      AbacatePay::Resources::Billing::Product.new(
        external_id: 'PRO-PLAN',
        name:        'Pro plan',
        quantity:    1,
        price:       1000, # em centavos
      )
    ],
    metadata: AbacatePay::Resources::Billing::Metadata.new(
      return_url:     'https://meusite.com/app',
      completion_url: 'https://meusite.com/pagamento/sucesso',
    ),
  )
)

puts billing.url # URL de pagamento para o cliente
Resposta: 
{
  "success": true,
  "error": null,
  "data": {
    "id": "bill_12345667",
    "url": "https://app.abacatepay.com/pay/bill_12345667",
    "amount": 1000,
    "status": "PENDING",
    "devMode": true,
    "createdAt": "2024-11-04T18:38:28.573Z"
  }
}

​
Próximos passos

Configurar webhooks

Receba notificações em tempo real sobre pagamentos confirmados.

Checkout Transparente

Aceite PIX e cartão diretamente na sua interface.

Criar clientes

Gerencie clientes vinculados às cobranças.

Referência completa

Todos os endpoints, status codes e formato de resposta.