bleumi_pay_sdk_ruby 1.0.2 → 1.0.3

data/docs/NetworkBalance.md

@@ -0,0 +1,29 @@
+# BleumiPay::NetworkBalance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mainnet** | [**Hash<String, WalletBalance>**](WalletBalance.md) | A dictionary which gives the token balances in MainNet | [optional] 
+**xdai** | [**Hash<String, WalletBalance>**](WalletBalance.md) | A dictionary which gives the token balances in xDAI | [optional] 
+**goerli** | [**Hash<String, WalletBalance>**](WalletBalance.md) | A dictionary which gives the token balances in Goerli TestNet | [optional] 
+**kovan** | [**Hash<String, WalletBalance>**](WalletBalance.md) | A dictionary which gives the token balances in Kovan TestNet | [optional] 
+**rinkeby** | [**Hash<String, WalletBalance>**](WalletBalance.md) | A dictionary which gives the token balances in Rinkeby TestNet | [optional] 
+**ropsten** | [**Hash<String, WalletBalance>**](WalletBalance.md) | A dictionary which gives the token balances in Ropsten TestNet | [optional] 
+**xdai_testnet** | [**Hash<String, WalletBalance>**](WalletBalance.md) | A dictionary which gives the token balances in xDAI TestNet | [optional] 
+
+## Example
+
+```json
+{
+    "xdai_testnet": {
+        "XDAIT": {
+            "balance": "1",
+            "token_decimals": 15,
+            "blockNum": "1698324",
+            "token_balance": "1000000000000000"
+        }
+    }
+}
+
+```

data/docs/PaginatedPaymentOperations.md

@@ -0,0 +1,29 @@
+# BleumiPay::PaginatedPaymentOperations
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<PaymentOperation>**](PaymentOperation.md) | List of operations of the payment in the current page | 
+**next_token** | **String** | Cursor to fetch next page of results, empty if no more results | [optional] 
+
+
+## Example
+
+```json
+{
+  "results": [
+    {
+      "txid": "1574502150086",
+      "chain": "xdai_testnet",
+      "funcName": "createAndRefundWallet",
+      "inputs": {
+        "addr": "0xbe1fa332f24ba568108ba55a25eccf93d882f54e",
+        "token": "XDAIT"
+      },
+      "status": true,
+      "hash": "0x79dca6990b9ef4b07db158dbae9969033d058954edaa24e0d52aef80ef05eca8"
+    }
+  ]
+}
+```

data/docs/PaginatedPayments.md

@@ -0,0 +1,68 @@
+# BleumiPay::PaginatedPayments
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<Payment>**](Payment.md) | List of payments in the current page | 
+**next_token** | **String** | Cursor to fetch next page of results, empty if no more results | [optional] 
+
+## Example
+
+```json
+{
+  "results": [
+    {
+      "id": "2",
+      "addresses": {
+        "ethereum": {
+          "ropsten": {
+            "addr": "0xbe02daaf993b29302c2e983b63eca1465c227245"
+          }
+        }
+      },
+      "balances": {
+        "ethereum": {
+          "ropsten": {
+            "0x84df8548086ec9025e9c93297058bed706e90ddd": {
+              "blockNum": "6831652",
+              "token_balance": "0",
+              "balance": "0",
+              "token_decimals": 18
+            }
+          }
+        }
+      },
+      "createdAt": 1574493797,
+      "updatedAt": 1574502335
+    },
+    {
+      "id": "1",
+      "addresses": {
+        "ethereum": {
+          "xdai_testnet": {
+            "addr": "0xbe1fa332f24ba568108ba55a25eccf93d882f54e"
+          },
+          "rinkeby": {
+            "addr": "0xbea2f9d56c3cc7f2c7e17d294200dd75708eecd8"
+          }
+        }
+      },
+      "balances": {
+        "ethereum": {
+          "xdai_testnet": {
+            "XDAIT": {
+              "blockNum": "1698324",
+              "token_balance": "1000000000000000",
+              "balance": "1",
+              "token_decimals": 15
+            }
+          }
+        }
+      },
+      "createdAt": 1574493617,
+      "updatedAt": 1574494588
+    }
+  ]
+}
+```

data/docs/PaginatedPayoutItems.md

@@ -0,0 +1,59 @@
+# BleumiPay::PaginatedPayoutItems
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<PayoutItem>**](PayoutItem.md) | List of payouts of the payment in the current page | 
+**next_token** | **String** | Cursor to fetch next page of results, empty if no more results | [optional] 
+
+## Example
+
+```json
+{
+  "results": [
+    {
+      "txid": "12345-6789-10",
+      "status": false,
+      "hash": "<N/A>",
+      "createdAt": 1574501464,
+      "updatedAt": 1574501769,
+      "inputs": {
+        "salt": "0x6f3b4b923b133a82dddef57139b6bbd622e7343128983518557cd13201c5462b",
+        "token": "0x84df8548086ec9025e9c93297058bed706e90ddd",
+        "payouts": [
+          {
+            "transferAddress": "0xD15BDD17175825742A5904b21008dd3A019a060E",
+            "amount": "15"
+          },
+          {
+            "amount": "21",
+            "transferAddress": "0x7Dc30B85084aA1608e5C1Ce39c804Be177e40A07"
+          }
+        ]
+      }
+    },
+    {
+      "txid": "12345-6789",
+      "status": true,
+      "hash": "0xbb7b393f61fdd8cf1337010003c46115fbf451b29e40098b9af1ff55ee9465b2",
+      "createdAt": 1574501339,
+      "updatedAt": 1574501659,
+      "inputs": {
+        "salt": "0x09d6f6e0c0c781a6c49153db62c72e4d8b159f742a42e8c4cfb18fc2b9c44224",
+        "token": "0x84df8548086ec9025e9c93297058bed706e90ddd",
+        "payouts": [
+          {
+            "transferAddress": "0xD15BDD17175825742A5904b21008dd3A019a060E",
+            "amount": "1"
+          },
+          {
+            "transferAddress": "0x7Dc30B85084aA1608e5C1Ce39c804Be177e40A07",
+            "amount": "1"
+          }
+        ]
+      }
+    }
+  ]
+}
+```

data/docs/Payment.md

@@ -0,0 +1,44 @@
+# BleumiPay::Payment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique ID identifying the payment; specified when it was created by your system | 
+**addresses** | [**PaymentAddresses**](PaymentAddresses.md) | A dictionary which gives the address of the wallet generated for each network | 
+**balances** | [**PaymentBalances**](PaymentBalances.md) | A dictionary which gives the token balances in each network | 
+**created_at** | **Integer** | UNIX timestamp when the payment was created | 
+**updated_at** | **Integer** | UNIX timestamp when the lastest operation was performed | 
+
+
+## Example
+
+```json
+{
+  "id": "1",
+  "addresses": {
+    "ethereum": {
+      "xdai_testnet": {
+        "addr": "0xbe1fa332f24ba568108ba55a25eccf93d882f54e"
+      },
+      "rinkeby": {
+        "addr": "0xbea2f9d56c3cc7f2c7e17d294200dd75708eecd8"
+      }
+    }
+  },
+  "balances": {
+    "ethereum": {
+      "xdai_testnet": {
+        "XDAIT": {
+          "balance": "1",
+          "token_decimals": 15,
+          "blockNum": "1698324",
+          "token_balance": "1000000000000000"
+        }
+      }
+    }
+  },
+  "createdAt": 1574493617,
+  "updatedAt": 1574494588
+}
+```

data/docs/PaymentAddresses.md

@@ -0,0 +1,22 @@
+# BleumiPay::PaymentAddresses
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ethereum** | [**Hash<String, WalletAddress>**](WalletAddress.md) | A dictionary which gives the address of the wallet generated for each network | [optional] 
+
+## Example
+
+```json
+{
+    "ethereum": {
+        "xdai_testnet": {
+        "addr": "0xbe1fa332f24ba568108ba55a25eccf93d882f54e"
+        },
+        "rinkeby": {
+        "addr": "0xbea2f9d56c3cc7f2c7e17d294200dd75708eecd8"
+        }
+    }
+}
+```

data/docs/PaymentBalances.md

@@ -0,0 +1,24 @@
+# BleumiPay::PaymentBalances
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ethereum** | [**Hash<String, NetworkBalance>**](NetworkBalance.md) | A dictionary which gives the token balances in each network | [optional] 
+
+## Example
+
+```json
+{
+    "ethereum": {
+        "xdai_testnet": {
+            "XDAIT": {
+                "balance": "1",
+                "token_decimals": 15,
+                "blockNum": "1698324",
+                "token_balance": "1000000000000000"
+            }
+        }
+    }
+}
+```

data/docs/PaymentOperation.md

@@ -0,0 +1,46 @@
+# BleumiPay::PaymentOperation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**txid** | **String** | Transaction ID of the operation | [optional] 
+**chain** | **String** | Network in which the operation was carried out | 
+**func_name** | **String** | Name of the function invoked on the Payment Processor.<br/><br/>Functions available:<br/> - createAndSettleWallet<br/> - createAndRefundWallet
+**status** | **Boolean** | <b>null</b> - operation in progress <br/> <b>true</b> - operation completed successfuly <br/> <b>false</b> - operation failed to process | 
+**inputs** | [**PaymentOperationInputs**](PaymentOperationInputs.md) | The inputs provided during this operation creation | 
+**hash** | **String** | Transaction hash of operation submitted to the network. This field is blank when operation is in progress. | 
+
+## Settle Opeation Example
+
+```json
+{
+      "txid": "1574828863297",
+      "chain": "ropsten",
+      "funcName": "createAndSettleWallet",
+      "inputs": {
+        "addr": "0xbec374e0acb4b7b6fde45b11287e61beb108e868",
+        "amount": "10",
+        "token": "0x115615dbd0f835344725146fa6343219315f15e5",
+        "token_amount": "10000000",
+        "token_decimals": 6
+      },
+      "status": true,
+      "hash": "0xc347fd450cd80da133401c3b290832e478236a7cbb98eda9e44c108ebc601bb9"
+}
+```
+
+## Refund Operation Example
+
+```json
+{
+  "chain": "xdai_testnet",
+  "funcName": "createAndRefundWallet",
+  "inputs": {
+    "addr": "0xbe1fa332f24ba568108ba55a25eccf93d882f54e",
+    "token": "XDAIT"
+  },
+  "status": true,
+  "hash": "0x79dca6990b9ef4b07db158dbae9969033d058954edaa24e0d52aef80ef05eca8"
+}
+```

data/docs/PaymentOperationInputs.md

@@ -0,0 +1,32 @@
+# BleumiPay::PaymentOperationInputs
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**addr** | **String** | Address of the wallet | 
+**amount** | **String** | Amount (Only for settle operation) | 
+**token** | **String** | <b>ETH</b> - for Ethereum  <br/> <b>XDAI</b> - for xDai <br/> <b>XDAIT</b> - for xDai Testnet <br/> <b> &lt;contract address of ERC-20 token&gt;</b> - for ERC-20 Tokens  | 
+**token_amount** | **String** | Token amount to be settled in network format (Only for settle operation) | 
+**token_decimals** | **Integer** | Token decimal places (Only for settle operation) | 
+
+## Settle Operation Example
+
+```json
+{
+    "addr": "0xbec374e0acb4b7b6fde45b11287e61beb108e868",
+    "amount": "10",
+    "token": "0x115615dbd0f835344725146fa6343219315f15e5",
+    "token_amount": "10000000",
+    "token_decimals": 6
+}
+```
+
+## Refund Operation Example
+
+```json
+{
+    "addr": "0xbe1fa332f24ba568108ba55a25eccf93d882f54e",
+    "token": "XDAIT"
+}
+```

data/docs/PaymentOperationResponse.md

@@ -0,0 +1,15 @@
+# BleumiPay::PaymentOperationResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**txid** | **String** | Unique identifier for the payment operation transaction | 
+
+## Example
+
+```json
+{
+  "txid": "1574502130940"
+}
+```

data/docs/PaymentRefundRequest.md

@@ -0,0 +1,16 @@
+# BleumiPay::PaymentRefundRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | [**Token**](Token.md) | <b>ETH</b> - for Ethereum  <br/> <b>XDAI</b> - for xDai <br/> <b>XDAIT</b> - for xDai Testnet <br/> <b> &lt;contract address of ERC-20 token&gt;</b> - for ERC-20 Tokens  | 
+
+
+## Example
+
+```json
+{
+    "token": "XDAIT"
+}
+```

data/docs/PaymentSettleRequest.md

@@ -0,0 +1,17 @@
+# BleumiPay::PaymentSettleRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | [**Token**](Token.md) | <b>ETH</b> - for Ethereum  <br/> <b>XDAI</b> - for xDai <br/> <b>XDAIT</b> - for xDai Testnet <br/> <b> &lt;contract address of ERC-20 token&gt;</b> - for ERC-20 Tokens  | 
+**amount** | **String** | Amount to be settled | 
+
+## Example
+
+```json
+{
+    "amount": "5",
+    "token": "0x84df8548086ec9025e9c93297058bed706e90ddd"
+}
+```

data/docs/PaymentsApi.md

@@ -0,0 +1,426 @@
+# BleumiPay::PaymentsApi
+
+
+## create_payment
+
+> CreatePaymentResponse create_payment(create_payment_request, opts)
+
+This method generates a unique wallet address in the specified network to accept payment.
+
+### Example
+
+```ruby
+# load the gem
+require 'bleumi_pay_sdk_ruby'
+# setup authorization
+BleumiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = '<YOUR_API_KEY>'
+end
+
+api_instance = BleumiPay::PayoutsApi.new
+create_payment_request = BleumiPay::CreatePaymentRequest.new # CreatePaymentRequest | 
+opts = {
+  chain: BleumiPay::Chain::ROPSTEN # Chain | Ethereum network in which payment is to be created.
+}
+
+begin
+  
+  create_payment_request.id = '<ID>'
+  create_payment_request.buyer_address = BleumiPay::EthAddress.new('<BUYER_ADDR>') # Replace <BUYER_ADDR> with the Buyer's Enthereum Network Address
+  create_payment_request.transfer_address = BleumiPay::EthAddress.new('<MERCHANT_ADDR>') # Replace <MERCHANT_ADDR> with the Merchant's Enthereum Network Address
+
+  #Create a payout.
+  result = api_instance.create_payment(create_payment_request, opts)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling PayoutsApi->create_payment: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_payment_request** | [**CreatePaymentRequest**](CreatePaymentRequest.md)| Specify checkout URL creation parameters. | 
+
+### Return type
+
+[**CreatePaymentResponse**](CreatePaymentResponse.md)
+
+Field | Type | Description
+----- | ----- | -----
+addr | string | Wallet address
+
+### 400 Errors
+
+The following table is a list of possible error codes that can be returned, along with additional information about how to resolve them for a response with 400 status code.
+
+errorCode <br> <i>errorMessage</i> | Description
+---- | ---- 
+ValidationError <br> <i>&lt;details&gt;</i> | Details on input which does not conform to the above schema
+ValidationError <br> <i>wallet_already_exists&#124;&lt;addr&gt;</i> | A wallet with address &lt;addr&gt; has already been created with the specified payment 'id' for the given network
+
+## get_payment
+
+> Payment get_payment(id)
+
+This method retrieves the wallet addresses & token balances for a given payment.
+
+### Example
+
+```ruby
+# load the gem
+require 'bleumi_pay_sdk_ruby'
+# setup authorization
+BleumiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = '<YOUR_API_KEY>'
+end
+
+api_instance = BleumiPay::PaymentsApi.new
+id = '<ID>' # String | Unique identifier of the payment (specified during create payment) to retrieve
+
+begin
+  #Retrieve the wallet addresses & token balances for a given payment
+  result = api_instance.get_payment(id)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling PaymentsApi->get_payment: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Unique identifier of the payment (specified during [Create a Payment](#create_payment)) to retrieve | 
+
+### Return type
+
+[**Payment**](Payment.md)
+
+Field | Type | Description
+----- | ----- | -----
+addresses | dictionary | A dictionary which gives the address of the wallet generated for each network
+balances | dictionary | A dictionary which gives the token balances in each network
+createdAt | integer | The created UNIX timestamp of the payment
+updatedAt | integer | The last updated UNIX timestamp of the payment
+
+### 400 Errors
+
+The following table is a list of possible error codes that can be returned, along with additional information about how to resolve them for a response with 400 status code.
+
+errorCode <br> <i>errorMessage</i> | Description
+---- | ----
+ValidationError <br> <i>&lt;details&gt;</i> | Details on input which does not conform to the above schema
+
+
+## list_payments
+
+> PaginatedPayments list_payments(opts)
+
+This method retrieves all payments created.
+
+### Pagination
+
+The list of payments is returned as an array in the 'results' field. The list is restricted to a maximum of 10 per page.
+
+If there are more than 10 payments, a cursor is returned in the 'nextToken' field. Passing this as the 'nextToken' query parameter will fetch the next page.
+
+When the value of 'nextToken' field is an empty string, there are no more payments.
+
+
+### Example
+
+```ruby
+# load the gem
+require 'bleumi_pay_sdk_ruby'
+# setup authorization
+BleumiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = '<YOUR_API_KEY>'
+end
+
+api_instance = BleumiPay::PaymentsApi.new
+opts = {
+  next_token: '', # String | Cursor to start results from
+  sort_by: '<SORT_BY>', # String | Sort wallets by (optional) | Eg. "createdAt"
+  start_at: '<START_TIMESTAMP>', # String | Get wallets from this timestamp (optional) | Eg. 1546300800 for 1-JAN-2019
+  end_at: '' # String | Get wallets till this timestamp (optional) 
+}
+
+begin
+  #Retrieve all payments created.
+  result = api_instance.list_payments(opts)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling PaymentsApi->list_payments: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **next_token** | **String**| Cursor to start results from | [optional] 
+ **sort_by** | **String**| Sort payments by | [optional] 
+ **start_at** | **String**| Get payments from this timestamp (unix) | [optional] 
+ **end_at** | **String**| Get payments till this timestamp (unix) | [optional] 
+
+### Return type
+
+[**PaginatedPayments**](PaginatedPayments.md)
+
+Parameter | Type | Description
+--------- | ------- | -----------
+nextToken |  | Cursor to fetch next set of results (if next set is available)
+results[] |  | Array of payments, output format is similar to the response of the [Retrieve a Payment](#get_payment) endpoint
+
+### 400 Errors
+
+The following table is a list of possible error codes that can be returned, along with additional information about how to resolve them for a response with 400 status code.
+
+errorCode <br> <i>errorMessage</i> | Description
+---- | ----
+MalformedRequest <br> <i>nextToken_invalid</i> | 'nextToken' value is invalid
+ValidationError <br> <i>&lt;details&gt;</i> | Details on input which does not conform to the above schema
+
+## settle_payment
+
+> PaymentOperationResponse settle_payment(id, payment_settle_request, opts)
+
+This method settles a specific amount of a token for a given payment to the transferAddress (specified during [Create a Payment](#create_payment)) and remaining balance (if any) will be refunded to the buyerAddress (specified during [Create a Payment](#create_payment)).
+
+
+### Example
+
+```ruby
+# load the gem
+require 'bleumi_pay_sdk_ruby'
+# setup authorization
+BleumiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = '<YOUR_API_KEY>'
+end
+
+api_instance = BleumiPay::PaymentsApi.new
+
+opts = {
+  chain: BleumiPay::Chain::ROPSTEN # Chain | Ethereum network in which payment is to be created.
+}
+
+begin
+  id = '<ID>' # String | Unique identifier of the payment (specified during create payment)
+  payment_settle_request = BleumiPay::PaymentSettleRequest.new # PaymentSettleRequest | Request body - used to specify the amount to settle.
+  payment_settle_request.amount = '<AMT>' # String | Replace <AMT> with settle amount
+  payment_settle_request.token = BleumiPay::Token.new('<TOKEN>') # String | Replace <TOKEN> with ETH or XDAI or XDAIT or ECR-20 token contract address
+  #Settle a specific amount of a token for a given payment to the transferAddress and remaining balance (if any) will be refunded to the buyerAddress
+  result = api_instance.settle_payment(id, payment_settle_request, opts)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling PaymentsApi->settle_payment: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Unique identifier of the payment (specified during [Create a Payment](#create_payment)) | 
+ **payment_settle_request** | [**PaymentSettleRequest**](PaymentSettleRequest.md)| Request body - used to specify the amount to settle. | 
+ **chain** | [**Chain**](.md)| Ethereum network in which payment is to be created. | [optional] 
+
+### Return type
+
+[**PaymentOperationResponse**](PaymentOperationResponse.md)
+
+### 400 Errors
+
+The following table is a list of possible error codes that can be returned, along with additional information about how to resolve them for a response with 400 status code.
+
+errorCode <br> <i>errorMessage</i> | Description
+---- | ----
+ValidationError <br> <i>&lt;details&gt;</i> | Details on input which does not conform to the above schema
+ValidationError <br> <i>no_gas_accounts</i> | No active gas accounts present in account, please activate atleast one account from the developer portal
+ValidationError <br> <i>prev_tx_inprogress</i> | A previous operation is still being processed for this wallet
+ValidationError <br> <i>invalid_token</i> | Provided token is not valid for the specified 'net' & 'chain'
+
+## refund_payment
+
+> PaymentOperationResponse refund_payment(id, payment_refund_request, opts)
+
+This method refunds the balance of a token for a given payment to the buyerAddress (specified during [Create a Payment](#create_payment)).
+
+### Example
+
+```ruby
+# load the gem
+require 'bleumi_pay_sdk_ruby'
+# setup authorization
+BleumiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = '<YOUR_API_KEY>'
+end
+
+api_instance = BleumiPay::PaymentsApi.new
+
+opts = {
+  chain: BleumiPay::Chain::ROPSTEN # Chain | Ethereum network in which payment is to be created.
+}
+
+begin
+  id = '<ID>' # String | Unique identifier of the payment (specified during create payment)
+  payment_refund_request = BleumiPay::PaymentRefundRequest.new # PaymentRefundRequest | Request body - used to specify the token to refund.
+  payment_refund_request.token = BleumiPay::Token.new('<TOKEN>') # String | Replace <TOKEN> with ETH or XDAI or XDAIT or ECR-20 token contract address
+
+  #Refund the balance of a token for a given payment to the buyerAddress
+  result = api_instance.refund_payment(id, payment_refund_request, opts)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling PaymentsApi->refund_payment: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Unique identifier of the payment (specified during [Create a Payment](#create_payment)) | 
+ **payment_refund_request** | [**PaymentRefundRequest**](PaymentRefundRequest.md)| Request body - used to specify the token to refund. | 
+ **chain** | [**Chain**](Chain.md)| Ethereum network in which payment is to be created. | [optional] 
+
+### Return type
+
+[**PaymentOperationResponse**](PaymentOperationResponse.md)
+
+
+Parameter | Type | Description
+--------- | ------- | -----------
+txid |  | Unique identifier for the refund operation
+
+### 400 Errors
+
+The following table is a list of possible error codes that can be returned, along with additional information about how to resolve them for a response with 400 status code.
+
+errorCode <br> <i>errorMessage</i> | Description
+---- | ----
+ValidationError <br> <i>&lt;details&gt;</i> | Details on input which does not conform to the above schema
+ValidationError <br> <i>no_gas_accounts</i> | No active gas accounts present in account, please activate atleast one account from the developer portal
+ValidationError <br> <i>prev_tx_inprogress</i> | A previous operation is still being processed for this wallet
+ValidationError <br> <i>invalid_token</i> | Provided address is not a valid ERC-20 token
+
+
+## get_payment_operation
+
+> PaymentOperation get_payment_operation(id, txid)
+
+This method retrieves a payment operation for a specific payment.
+
+### Example
+
+```ruby
+# load the gem
+require 'bleumi_pay_sdk_ruby'
+# setup authorization
+BleumiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = '<YOUR_API_KEY>'
+end
+
+api_instance = BleumiPay::PaymentsApi.new
+id = '<ID>' # String | Unique identifier of the payment (specified during create payment)
+txid = '<TXID>' # String | ID of a specific operation of the payment
+
+begin
+  #Retrieve a payment operation for a specific payment.
+  result = api_instance.get_payment_operation(id, txid)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling PaymentsApi->get_payment_operation: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Unique identifier of the payment (specified during [Create a Payment](#create_payment)) | 
+ **txid** | **String**| ID of a specific operation of the payment | 
+
+### Return type
+
+[**PaymentOperation**](PaymentOperation.md)
+
+
+## list_payment_operations
+
+> PaginatedPaymentOperations list_payment_operations(id, opts)
+
+This method retrieves all payment operations for a specific payment.
+
+### Pagination
+
+The list of operations is returned as an array in the 'results' field. The list is restricted to a maximum of 10 operations per page.
+
+If there are more than 10 operations for a wallet, a cursor is passed in the 'nextToken' field. Passing this as the 'nextToken' query parameter will fetch the next page. 
+
+When the value of 'nextToken' field is an empty string, there are no more operations.
+
+### Example
+
+```ruby
+# load the gem
+require 'bleumi_pay_sdk_ruby'
+# setup authorization
+BleumiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = '<YOUR_API_KEY>'
+end
+
+api_instance = BleumiPay::PaymentsApi.new
+id = '<ID>' # String | Unique identifier of the payment (specified during Create payment)
+opts = {
+  next_token: '' # String | Cursor to start results from
+}
+
+begin
+  #Retrieve all payment operations for a specific payment.
+  result = api_instance.list_payment_operations(id, opts)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling PaymentsApi->list_payment_operations: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Unique identifier of the payment (specified during [Create a Payment](#create_payment)) | 
+ **next_token** | **String**| Cursor to start results from | [optional] 
+
+### Return type
+
+[**PaginatedPaymentOperations**](PaginatedPaymentOperations.md)
+
+Parameter | Type | Description
+--------- | ------- | -----------
+nextToken |  | Cursor to fetch next set of results (if next set is available)
+results[] |  | Array of payment operations, output format is similar to the response of the [Retrieve a Payment Operation](#get_payment_operation) endpoint
+
+### 400 Errors
+
+The following table is a list of possible error codes that can be returned, along with additional information about how to resolve them for a response with 400 status code.
+
+errorCode <br> <i>errorMessage</i> | Description
+---- | ----
+MalformedRequest <br> <i>nextToken_invalid</i> | 'nextToken' value is invalid
+ValidationError <br> <i>&lt;details&gt;</i> | Details on input which does not conform to the above schema