Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

yapstone-payments

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

yapstone-payments

  • 1.0.0
  • Rubygems
  • Socket score

Version published
Maintainers
1
Created
Source

yapstone-payments

Yapstone - the Ruby gem for the Payments Orchestrator

"REST API for Payments Orchestrator"

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.6.4-SNAPSHOT
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build yapstone-payments.gemspec

Then either install the gem locally:

gem install ./yapstone-payments-1.0.0.gem

(for development, run gem install --dev ./yapstone-payments-1.0.0.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 'yapstone-payments', '~> 1.0.0'

Install from Git

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 'yapstone-payments', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'yapstone-payments'

api_instance = Yapstone::AuthenticationApi.new
grant_type = 'client_credentials' # String | To do OAuth2 authentication, you must indicate the grant type, then adhere to it structurally. Yapstone API endpoints authenticate with OAuth2 and the grant type client credentials. This type of authentication is used to access resources on your own system rather than access a user's resources. 
authorization = 'Basic SGxkdU5OcU1xMzBUZ0djYUpDWVpIWVRsejJjQUJlSHo6YkdIeWNpWXVibzNVTXZLRA==' # String | Provide client_id:client_secret as base64 encoded basic auth. 

begin
  #Authenticate Partner
  result = api_instance.authenticate_partner(grant_type, authorization)
  p result
rescue Yapstone::ApiError => e
  puts "Exception when calling AuthenticationApi->authenticate_partner: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api-prod-sandbox.yapstone.com

ClassMethodHTTP requestDescription
Yapstone::AuthenticationApiauthenticate_partnerPOST /v1/oauth2/client_credential/accesstokenAuthenticate Partner
Yapstone::DisbursementsApidisburse_payment_by_idPUT /v2/disbursements/payment/{paymentId}Change payment from "Hold payout" state to be ready for disbursement
Yapstone::DisbursementsApidisburse_transaction_by_idPUT /v2/disbursements/transaction/{transactionId}Change transaction from "Hold payout" state to be ready for disbursement (payout)
Yapstone::PaymentsApicancel_paymentDELETE /v2/payments/payment/{paymentId}Cancel Payment by payment Id
Yapstone::PaymentsApicancel_transactionDELETE /v2/payments/transaction/{transactionId}Cancel Transaction by TransactionId
Yapstone::PaymentsApicapture_paymentPATCH /v2/payments/payment/{paymentId}Capture a prior authorized payment
Yapstone::PaymentsApicreate_paymentPOST /v2/payments/paymentProcess Payment
Yapstone::PaymentsApiget_paymentGET /v2/payments/payment/{paymentId}Get with Payment Id
Yapstone::PaymentsApiget_transactionGET /v2/payments/transaction/{transactionId}Get Transaction by Transaction Id
Yapstone::PaymentsApiverify_payment_instrumentPOST /v2/payments/instrument/verifyVerify payment instrument
Yapstone::RefundsApicancel_refundDELETE /v2/refunds/refund/{refundId}Cancel Payment by payment Id
Yapstone::RefundsApicreate_payment_refundPOST /v2/refunds/paymentCreate a refund
Yapstone::RefundsApicreate_transaction_refundPOST /v2/refunds/transactionCreate a refund
Yapstone::RefundsApiget_by_originaltransaction_idGET /v2/refunds/transaction/{transactionId}Get master Transaction details including all refund details by transaction Id
Yapstone::RefundsApiget_refundGET /v2/refunds/refund/{refundId}Get master payment details including all refund detail by refund ID.
Yapstone::RefundsApiget_refund_by_payment_idGET /v2/refunds/payment/{paymentId}Get master payment details including all refund details by Payment Id.
Yapstone::SearchApisearch_by_payment_idGET /v2/search/payment/{paymentId}Search with Payment Id
Yapstone::SearchApisearch_by_transaction_idGET /v2/search/transaction/{transactionId}Search with transaction id
Yapstone::TokenApicreate_tokenPOST /v2/tokenCreate a Token
Yapstone::TokenApilookup_tokenPOST /v2/token/lookupLookup a Token

Documentation for Models

Documentation for Authorization

Bearer

  • Type: Bearer authentication (JWT)

FAQs

Package last updated on 19 Jul 2019

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc