Xendit API Ruby Library
This library is the abstraction of Xendit API for access from applications written with Ruby/Rails.
- API Documentation
- Requirements
- Installation
- Usage
- Invoice Service
API Documentation
Please check Xendit API Reference.
Requirements
- Ruby 2.5+.
Installation
Add this line to your application’s Gemfile:
gem 'xendit'
And then execute:
$ bundle
Access the library in Ruby/Rails project:
require 'xendit'
Usage
First, start by setting up with your account's secret key obtained from your Xendit Dashboard. Once done, you are ready to use all services provided in this library.
require 'xendit'
# Provide api key
Xendit.api_key = 'xnd_...'
Invoice Service
Refer to Xendit API Reference for more info about methods' parameters
Create an invoice
# setup invoice details
invoice_params = {
external_id: 'demo_147580196270',
payer_email: 'sample_email@xendit.co',
description: 'Trip to Bali',
amount: 10_000_000
}
# create an invoice
created_invoice = Xendit::Invoice.create invoice_params
Get an invoice
# get an invoice
invoice = Xendit::Invoice.get '5efda8a20425db620ec35f43'
Get all invoices
# setup filters
filter_params = {
limit: 3
}
# get invoices
invoices = Xendit::Invoice.get_all filter_params
Expire an invoice
# expire an invoice
expired_invoice = Xendit::Invoice.expire '5efda8a20425db620ec35f43'