abacatepay-nodejs-sdk
TypeScript icon, indicating that this package has built-in type declarations

1.4.1 • Public • Published

AbacatePay SDK AbacatePay SDK

 

npm version Build Status Test Coverage

AbacatePay Node.js SDK

Official AbacatePay SDK - Accept payments in seconds with a simple integration.

Installation

npm install abacatepay-nodejs-sdk

Quick Usage

import AbacatePay from 'abacatepay-nodejs-sdk';

// Initialize the SDK with your API key
const abacate = AbacatePay('your_api_key');

Creating a Payment

// Create a one-time payment
const billing = await abacate.billing.create({
  frequency: "ONE_TIME",
  methods: ["PIX"],
  products: [
    {
      externalId: "PRO-PLAN",
      name: "Pro plan",
      quantity: 1,
      price: 1000 // Amount in cents
    }
  ],
  returnUrl: "https://yoursite.com/app",
  completionUrl: "https://yoursite.com/payment/success",
  customer: {
    email: 'customer@example.com'
  }
});

Response

{
  id: 'bill_12345667',
  url: 'https://abacatepay.com/pay/bill_12345667', // Payment URL for your customer
  amount: 1000,
  status: 'PENDING',
  devMode: true,
  methods: ['PIX'],
  frequency: 'ONE_TIME',
  nextBilling: null,
  customer: {
    id: 'cust_12345',
    metadata: {
      email: 'customer@example.com'
    }
  },
  createdAt: '2024-11-04T18:38:28.573',
  updatedAt: '2024-11-04T18:38:28.573',
}

Payment Methods

Currently supported payment methods:

  • PIX (Brazilian instant payment system)

License

This project is licensed under the terms of the MIT License.

Package Sidebar

Install

npm i abacatepay-nodejs-sdk

Weekly Downloads

205

Version

1.4.1

License

MIT

Unpacked Size

65.4 kB

Total Files

27

Last publish

Collaborators

  • christopy