BckbnPay - the Ruby gem for the Bckbn Pay API
API for Bckbn Pay services
This SDK is automatically generated by the OpenAPI Generator project:
To build the Ruby code into a gem:
gem build bckbn_pay.gemspec
Then either install the gem locally:
gem install ./bckbn_pay-0.5.1.gem
(for development, run gem install --dev ./bckbn_pay-0.5.1.gem to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'bckbn_pay', '~> 0.5.1'
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
gem 'bckbn_pay', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
Include the Ruby code directly using -I as follows:
ruby -Ilib script.rb
Please follow the installation procedure and then run the following code:
# Load the gem
require 'bckbn_pay'
# Setup authorization
BckbnPay.configure do |config|
# Configure API key authorization: ApiKeyAuth
config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
end
api_instance = BckbnPay::AccessKeysApi.new
x_api_version = 'x_api_version_example' # String |
id = 'id_example' # String |
begin
#Delete an access key by ID
api_instance.delete_access_key(x_api_version, id)
rescue BckbnPay::ApiError => e
puts "Exception when calling AccessKeysApi->delete_access_key: #{e}"
end
All URIs are relative to https://pay-sandbox.bckbn.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| BckbnPay::AccessKeysApi | delete_access_key | DELETE /access_keys/{id} | Delete an access key by ID |
| BckbnPay::AccessKeysApi | list_access_keys | GET /access_keys | List all access keys |
| BckbnPay::AccessKeysApi | roll_access_key | POST /access_keys/{id}/roll | Roll an access key by ID |
| BckbnPay::BalanceTransactionsApi | list_balance_transactions | GET /balance_transactions | List all balance transactions |
| BckbnPay::ChargesApi | get_charge | GET /charges/{id} | Retrieve a charge |
| BckbnPay::ChargesApi | list_charges | GET /charges | List all charges |
| BckbnPay::CustomersApi | create_customer | POST /customers | Create a new customer |
| BckbnPay::CustomersApi | get_customer | GET /customers/{id} | Retrieve a customer by ID |
| BckbnPay::CustomersApi | list_customers | GET /customers | List all customers |
| BckbnPay::EventsApi | get_event | GET /events/{id} | Retrieve a single event by ID |
| BckbnPay::EventsApi | list_events | GET /events | List all events |
| BckbnPay::MerchantConfigurationsApi | create_merchant_configurations | POST /merchant_configurations | Create merchant configurations |
| BckbnPay::MerchantConfigurationsApi | get_merchant_configurations | GET /merchant_configurations | Retrieve merchant configurations |
| BckbnPay::PaymentIntentsApi | cancel_payment_intent | POST /payment_intents/{id}/cancel | Cancel a payment intent |
| BckbnPay::PaymentIntentsApi | capture_payment_intent | POST /payment_intents/{id}/capture | Capture a payment intent |
| BckbnPay::PaymentIntentsApi | confirm_payment_intent | POST /payment_intents/{id}/confirm | Confirm a payment intent |
| BckbnPay::PaymentIntentsApi | create_payment_intent | POST /payment_intents | Create a new payment intent |
| BckbnPay::PaymentIntentsApi | get_payment_intent | GET /payment_intents/{id} | Retrieve a payment intent by ID |
| BckbnPay::PaymentIntentsApi | list_payment_intents | GET /payment_intents | List payment intents |
| BckbnPay::PaymentIntentsApi | update_payment_intent | PATCH /payment_intents/{id} | Update a payment intent |
| BckbnPay::PaymentMethodsApi | create_payment_method | POST /payment_methods | Create a payment method |
| BckbnPay::PaymentMethodsApi | get_payment_method | GET /payment_methods/{id} | Retrieve a payment method |
| BckbnPay::PaymentMethodsApi | list_payment_methods | GET /payment_methods | List all payment methods |
| BckbnPay::RefundsApi | cancel_refund | PUT /refunds/{id}/cancel | Cancel a refund |
| BckbnPay::RefundsApi | create_refund | POST /refunds | Create a refund |
| BckbnPay::RefundsApi | get_refund | GET /refunds/{id} | Get a refund by ID |
| BckbnPay::RefundsApi | list_refunds | GET /refunds | List refunds for a Charge |
| BckbnPay::SubMerchantsApi | create_sub_merchant | POST /sub_merchants | Create a sub_merchant |
| BckbnPay::SubMerchantsApi | get_sub_merchant | GET /sub_merchants/{id} | Retrieve a sub_merchant |
| BckbnPay::SubMerchantsApi | list_sub_merchants | GET /sub_merchants | List all sub-merchants |
| BckbnPay::WebhookEndpointsApi | create_webhook_endpoint | POST /webhook_endpoints | Create a webhook endpoint |
| BckbnPay::WebhookEndpointsApi | delete_webhook_endpoint | DELETE /webhook_endpoints/{id} | Delete a webhook endpoint by ID |
| BckbnPay::WebhookEndpointsApi | get_webhook_endpoint | GET /webhook_endpoints/{id} | Retrieve a webhook endpoint by ID |
| BckbnPay::WebhookEndpointsApi | list_webhook_endpoints | GET /webhook_endpoints | List all webhook endpoints |
| BckbnPay::WebhookEndpointsApi | update_webhook_endpoint | PATCH /webhook_endpoints/{id} | Update a webhook endpoint by ID |
| BckbnPay::WebhookRequestsApi | list_webhook_requests | GET /webhook_requests | List all webhook requests |
Authentication schemes defined for the API:
FAQs
Unknown package
We found that bckbn_pay demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.