bleumi_pay_sdk_ruby 1.0.2 → 1.0.7

data/docs/CreatePayoutResponse.md

@@ -0,0 +1,15 @@
+# BleumiPay::CreatePayoutResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**salt** | **String** | Unique id generated for the given txid | 
+
+## Example
+
+```json
+{
+  "addr": "0xbea2f9d56c3cc7f2c7e17d294200dd75708eecd8"
+}
+```

data/docs/EthereumBalance.md

@@ -0,0 +1,30 @@
+# BleumiPay::EthereumBalance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mainnet** <br>(Optional) | [**Hash&lt;String, WalletBalance&gt;**](WalletBalance.md) | A dictionary which gives the token balances in Ethereum MainNet |
+**goerli** <br>(Optional) | [**Hash&lt;String, WalletBalance&gt;**](WalletBalance.md) | A dictionary which gives the token balances in Ethereum Goerli TestNet |
+**xdai** <br>(Optional) | [**Hash&lt;String, WalletBalance&gt;**](WalletBalance.md) | A dictionary which gives the token balances in xDAI | 
+**xdai_testnet** <br>(Optional) | [**Hash&lt;String, WalletBalance&gt;**](WalletBalance.md) | A dictionary which gives the token balances in xDAI TestNet |
+
+## Example - Goerli - TestNet
+
+```json
+{
+    "balances": {
+        "ethereum": {
+            "goerli": {
+                "0x115615dbd0f835344725146fa6343219315f15e5": {
+                    "blockNum": "2049977",
+                    "token_balance": "10000000",
+                    "balance": "10",
+                    "safety": "high",
+                    "token_decimals": 6
+                }
+            }
+        }
+    }
+}
+```

data/docs/EthereumWalletAddress.md

@@ -0,0 +1,23 @@
+# BleumiPay::EthereumWalletAddress
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**addr** | **String** | Wallet address for the payment in the network |
+**inputs** | [**EthereumWalletInputs**](EthereumWalletInputs.md) | Inputs used for the wallet creation |
+
+## Example
+
+```json
+{
+    "addr": "0xbe7b6dd3a81b9ae6b27b9a4690af39690095c791",
+    "inputs": {
+        "buyer": "0x713883bf69b786f0a7ab6e2248a70c50577f6b34",
+        "merchant": "0x5db2d6542d55b2aec1f10d0c0df3b0169bf41e41",
+        "salt": "0x5fca1a8d4c6e8786f915a57a9bdde2be9d643b93f366ffa713384fe75762e4aa",
+        "walletLibrary": "0xb33893fdf59b634653fcbed27b5d38d86710fc40",
+        "walletProxy": "0xfaac6b338f79cfd8a53dfec95263f12ef046a049"
+    }
+}
+```

data/docs/EthereumWalletInputs.md

@@ -0,0 +1,23 @@
+# BleumiPay::EthereumWalletInputs
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**buyer** | **String** | Buyer Address |
+**merchant** | **String** | Merchant Address |
+**salt** | **String** | Salt |
+**wallet_library** | **String** | Wallet Library |
+**wallet_proxy** | **String** | Wallet Proxy |
+
+## Example
+
+```json
+{
+    "buyer": "0x713883bf69b786f0a7ab6e2248a70c50577f6b34",
+    "merchant": "0x5db2d6542d55b2aec1f10d0c0df3b0169bf41e41",
+    "salt": "0x5fca1a8d4c6e8786f915a57a9bdde2be9d643b93f366ffa713384fe75762e4aa",
+    "walletLibrary": "0xb33893fdf59b634653fcbed27b5d38d86710fc40",
+    "walletProxy": "0xfaac6b338f79cfd8a53dfec95263f12ef046a049"
+}
+```

data/docs/HostedCheckoutsApi.md

@@ -0,0 +1,197 @@
+# BleumiPay::HostedCheckoutsApi
+
+
+## create_checkout_url
+
+> CreateCheckoutUrlResponse create_checkout_url(create_checkout_url_request)
+
+This method generates a unique checkout URL 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::HostedCheckoutsApi.new
+create_checkout_url_request = BleumiPay::CreateCheckoutUrlRequest.new # CreateCheckoutUrlRequest | Specify checkout URL creation parameters.
+
+begin
+
+  create_checkout_url_request = BleumiPay::CreateCheckoutUrlRequest.new # CreatePayoutRequest | Specify payout creation parameters.
+  create_checkout_url_request.id = '<ID>' # Eg. 1
+  create_checkout_url_request.currency = "<CURRENCY>" # Eg. USD
+  create_checkout_url_request.amount = "<AMOUNT>" # Eg. 10
+  create_checkout_url_request.success_url = "<SUCCESS_URL>" # Eg. https://demo.store/api/completeOrder
+  create_checkout_url_request.cancel_url = "<CANCEL_URL>" # Eg. https://demo.store/api/cancelOrder
+  create_checkout_url_request.token = '<TOKEN>' # Replace <TOKEN>  by anyone of the following values: 'ETH' or 'XDAI' or 'XDAIT' or ECR-20 Contract Address or 'RBTC' or RSK ECR-20 Contract Address or 'Asset ID' of Algorand Standard Asset. | Optional
+  create_checkout_url_request.chain = BleumiPay::Chain::GOERLI # Replace with any Chain as required
+
+  #Generate a unique checkout URL to accept payment.
+  result = api_instance.create_checkout_url(create_checkout_url_request)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling HostedCheckoutsApi->create_checkout_url: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_checkout_url_request** | [**CreateCheckoutUrlRequest**](CreateCheckoutUrlRequest.md)| Specify checkout URL creation parameters. | 
+
+### Return type
+
+[**CreateCheckoutUrlResponse**](CreateCheckoutUrlResponse.md)
+
+Field | Type | Description
+----- | ----- | -----
+id | string | Unique identifier generated for this checkout URL
+url | string | URL for buyer to complete payment
+
+Format - hmac_input GET parameter passed in successUrl
+
+The hmac_input GET parameter passed to successUrl contains payment parameters as a pipe ('|') separated string in the following order,
+<ul style="font-weight: 500">
+        <li><b>Chain</b> - Please refer documentation for <a href="https://pay.bleumi.com/docs/#supported-networks" target="_blank">Supported Networks</a> </li>
+        <li><b>Wallet Address</b></li>
+        <li><b>Token</b><br> 
+            <i>ETH</i> - for Ethereum<br> 
+            <i>XDAI</i> - for xDai<br> 
+            <i>XDAIT</i> - for xDai Testnet<br> 
+            <i>ALGO</i> - for Algo <br> 
+            <i>RBTC</i> - for R-BTC <br> 
+            <i>&lt;asset id&gt;</i> - for Algorand Standard Asset <br> 
+            <i>&lt;contract address of ERC-20 token&gt;</i> - for ERC-20; Please refer to <a href="https://pay.bleumi.com/docs/#erc-20" target="_blank">ERC-20 Tokens</a> for contract address;<br> 
+            <i>&lt;contract address of RSK ERC-20 token&gt;</i> - for RSK ERC-20; Please refer to <a href="https://pay.bugnet.work/docs/#rsk-tokens-erc-20" target="_blank">RSK ERC-20 Tokens</a> for contract address;<br> 
+        </li>
+        <li><b>Amount</b> - Token amount for the payment</li>
+        <li><b>Number of block confirmations</b><br> 
+        </li>
+    </li>
+</ul>
+
+Call [Validate a Checkout Payment](#validate_checkout_payment) method to validate the GET parameters passed in successUrl and then cross-check the payment parameters of hmac.input GET parameter with your database.
+
+
+### 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_tokens_defined</i> | Please configure tokens for the Hosted Checkout in your account in the <a href="https://pay.bleumi.com/app/" target="_blank">Bleumi Pay Dashboard</a>
+ValidationError <br> <i>no_tokens_defined_for_currency</i> | No tokens have been defined in your account for the specified currency
+ValidationError <br> <i>invalid_token</i> | The token provided is not valid for the specified currency
+
+
+## list_tokens
+
+> Array&lt;CheckoutToken&gt; list_tokens
+
+Retrieve all tokens configured for the Hosted Checkout in your account in the [Bleumi Pay Dashboard](https://pay.bleumi.com/app/).
+
+### 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::HostedCheckoutsApi.new
+
+begin
+  #Retrieve all tokens configured for the Hosted Checkout in your account in the [Bleumi Pay Dashboard](https://pay.bleumi.com/app/).
+  result = api_instance.list_tokens
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling HostedCheckoutsApi->list_tokens: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;CheckoutToken&gt;**](CheckoutToken.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>no_tokens_defined</i> | No tokens have been defined in your account
+
+
+## validate_checkout_payment
+
+> ValidateCheckoutResponse validate_checkout_payment(validate_checkout_request)
+
+Validate the GET parameters passed by Hosted Checkout in successUrl upon successfully completing 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::HostedCheckoutsApi.new
+
+begin
+  validate_checkout_request = BleumiPay::ValidateCheckoutRequest.new # ValidateCheckoutRequest | Specify validation of checkout parameters.
+  validate_checkout_request.hmac_alg = '<ALD>' # Eg. HMAC-SHA256-HEX
+  validate_checkout_request.hmac_input = '<INPUT>' # Eg. goerli|0xbeaea438bc2e19d097906b597219c288e8eb7b2e|0x115615dbd0f835344725146fa6343219315f15e5|10|12
+  validate_checkout_request.hmac_key_id = '<VER>' # Eg. v1
+  validate_checkout_request.hmac_value = '<HMAC_VALUE>' # Eg. bdf82eb42efac09150d62ac1bcadd2fd0f64852ded2b571567c905217adf246a
+  #Validate the GET parameters passed by Hosted Checkout in successUrl upon successfully completing payment.
+  result = api_instance.validate_checkout_payment(validate_checkout_request)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling HostedCheckoutsApi->validate_checkout_payment: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **validate_checkout_request** | [**ValidateCheckoutRequest**](ValidateCheckoutRequest.md)| Specify validation of checkout parameters. | 
+
+### Return type
+
+[**ValidateCheckoutResponse**](ValidateCheckoutResponse.md)
+
+Field | Type | Description
+----- | ----- | -----
+valid | boolean | <b>true</b> - The data has been generated by Bleumi Pay <br> <b>false</b> - The data has not been generated by Bleumi Pay, the payment must be treated as unpaid
+
+### 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

data/docs/PaginatedPaymentOperations.md

@@ -0,0 +1,28 @@
+# BleumiPay::PaginatedPaymentOperations
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<PaymentOperation>**](PaymentOperation.md) | List of operations of the payment in the current page | 
+**next_token** <br> (Optional) | **String** | Cursor to fetch next page of results, empty if no more results |
+
+## 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,95 @@
+# BleumiPay::PaginatedPayments
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<Payment>**](Payment.md) | List of payments in the current page | 
+**next_token** <br> (Optional) | **String** | Cursor to fetch next page of results, empty if no more results |
+
+## Example
+
+```json
+{
+  "results": [
+ {
+      "id": "1412",
+      "addresses": {
+        "algorand": {
+          "alg_testnet": {
+            "inputs": {
+              "merchant": "CQRMTAHZJA3SIEOTEMZXCAIZKUWE2CCLBCFYQI4NINU43IOTEWT4LOT4IY",
+              "salt": "b1929e6dd3956e0a3abeedb2bd53adc6sHQp0Ksuc4Zyf3Elzdgogqah2hA80y/61+rgF3vRE3YWu/JFPJfM8w==",
+              "gas": "ZGXGUNO47C2E7EUO2B3UAY6DETVBI5E2RFDKT4KC3VTWNENE7IVF2F43WY",
+              "programBytes": "ASYGIBQiyYD5SDckEdMjM3EBGVUsTQhLCIuII41Dac2h0yWnIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAIMmuajXc+LRPko7Qd0BjwyTqFHSaiUap8ULdZ2aRpPoqA3BheQVheGZlciASpk2P8CvJS+NGPcbU9eXjbT2KyTUtTvztmxRR3ShmODEHKBIxBygSETEJKRIxCSgSMQkoEhExCSoSEREQMQ8rEhAxFCgSMRQoEhExFSkSMRUoEjEVKBIRERAxDycEEhARMQUBJwUSEDEUMQASEQ==",
+              "buyer": "CQRMTAHZJA3SIEOTEMZXCAIZKUWE2CCLBCFYQI4NINU43IOTEWT4LOT4IY"
+            },
+            "addr": "BE4XD5QRRXOSAMWJRFHUVZ6DHIP2GQ6YHOHNEP3V3OPEM7SQ4PZMT6WTD4"
+          }
+        }
+      },
+      "balances": {
+        "algorand": {
+          "alg_testnet": {
+            "127647": {
+              "blockNum": "5388041",
+              "token_balance": "10000000",
+              "balance": "10",
+              "safety": "high",
+              "token_decimals": 6
+            },
+            "ALGO": {
+              "blockNum": "5388035",
+              "token_balance": "209000",
+              "balance": "0.209",
+              "safety": "high",
+              "token_decimals": 6
+            }
+          }
+        }
+      },
+      "createdAt": 1583731367,
+      "updatedAt": 1583731695
+    },
+    {
+      "id": "1411",
+      "addresses": {
+        "ethereum": {
+          "goerli": {
+            "inputs": {
+              "walletLibrary": "0xb33893fdf59b634653fcbed27b5d38d86710fc40",
+              "merchant": "0x5db2d6542d55b2aec1f10d0c0df3b0169bf41e41",
+              "salt": "0xc866b93db0433948f8a47ecb98aac4690999112f8da7ee31a2106cfdd789c2d0",
+              "walletProxy": "0xfaac6b338f79cfd8a53dfec95263f12ef046a049",
+              "buyer": "0x5db2d6542d55b2aec1f10d0c0df3b0169bf41e41"
+            },
+            "addr": "0xbe22e5c3347b25d16918a841fada2bd76a70d9ac"
+          }
+        }
+      },
+      "balances": {
+        "ethereum": {
+          "goerli": {
+            "0x84df8548086ec9025e9c93297058bed706e90ddd": {
+              "balance": "4",
+              "token_decimals": 18,
+              "blockNum": "2313213",
+              "safety": "high",
+              "token_balance": "4000000000000000000"
+            },
+            "0x115615dbd0f835344725146fa6343219315f15e5": {
+              "balance": "9",
+              "token_decimals": 6,
+              "blockNum": "2313213",
+              "safety": "high",
+              "token_balance": "9000000"
+            }
+          }
+        }
+      },
+      "createdAt": 1583730573,
+      "updatedAt": 1583730823
+    }
+  ]
+}
+```

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** (Optional) | **String** | Cursor to fetch next page of results, empty if no more results |  
+
+## 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"
+          }
+        ]
+      }
+    }
+  ]
+}
+```