Project

yield-sdk

0.0
The project is in a healthy, maintained state
The official Yield SDK for Ruby
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Runtime

~> 2.13
~> 3.24
 Project Readme

Yield SDK for Ruby Gem Version

The official Yield SDK for Ruby.

Documentation

Installation

gem install yield-sdk

Usage

require "yield/sdk"

# For security, don't save the actual key in your code or repo
client = Yield::SDK::Client.new(ENV.fetch("YIELD_API_KEY"))

# Fetch an existing order
order = client.order.fetch("ord_...")
p order.customer.registered_name

# Or create a new one
new_order = client.order.create({
  customer_id: "org_...",
  total_amount: "PHP 1234.50",
  note: "Test order from the Ruby SDK!"
})

For more details, check out our API reference.