Fintecture
Fintecture is connected with most European banks and enables a user to initiate a payment directly from their bank account. This results to a bank transfer sent from the user's bank account directly to your bank account, skipping all intermediaries. Within the SEPA region, transfers take between 10 seconds to 1 business day to arrive on your bank account. No hidden fees. Check out our website.
Installation
Add this line to your application's Gemfile:
gem 'fintecture'And then execute:
$ bundle
Or install it yourself as:
$ gem install fintecture
Usage
Get started by subscribing to a free developer account. Join today to get access to our sandbox by registering on the developer console by creating your first sets of API Keys. When creating an account, specify you are an ECOMMERCE. When you’re ready to deploy to production, just go through the Activation Form in your console. Once the Fintecture Team activates your account, you’ll be ready to start receiving real bank transfers directly on the bank account specified during activation.
By default sandbox is the initial environment, but you can change to production when initializing your PIS or AIS client:
Initialize your PIS client
pis_client = Fintecture::PisClient.new({
environment: 'sandbox', # => ["sandbox", "test", "production"]
app_id: 'your_app_id',
app_secret: 'your_app_secret',
private_key: %q(your_private_key)
})Initialize your AIS client
ais_client = Fintecture::AisClient.new({
environment: 'sandbox', # => ["sandbox", "test", "production"]
app_id: 'your_app_id',
app_secret: 'your_app_secret',
private_key: %q(your_private_key)
})PIS
PIS client properties
pis_client.app_id
pis_client.app_secret
pis_client.private_key
pis_client.environment
pis_client.token
pis_client.token_expires_inAccess token
This method return the token and store it in the client for future requests
pis_client.generate_tokenPOST /connect
Creates a connect session for a PSU to initiate a payment.
Documentation:
# connect (payload, state, redirect_uri = nil, origin_uri = nil, with_virtualbeneficiary: false)
# payload: {}
# state: string
# redirect_uri: string
# origin_uri: string
response = pis_client.connect payload, "my-state", "https://www.my-redirect-uri.fr", "https://www.my-origine-uri.fr", with_virtualbeneficiary: trueGET /payments
Get the details of all transfers or of a specific transfer, with virtual beneficiary information if required.
Documentation:
- Get all payments: https://doc.fintecture.com/reference/getpisv2payments
- Get a specific payment: https://doc.fintecture.com/reference/getpaymentsession
# payments (session_id = nil, with_virtualbeneficiary: false)
# session_id: string
response = pis_client.payments
# OR
response = pis_client.payments "7f47d3675f5d4964bc416b43af63b06e"
# OR
response = pis_client.payments "7f47d3675f5d4964bc416b43af63b06e", with_virtualbeneficiary: truePOST /refund
Initiates a refund. If the amount is not specified, refunds the total.
Documentation:
# refund (session_id, amount = nil, user_id = nil))
# session_id: string
# amount: number
# user_id: string
response = pis_client.refund "7f47d3675f5d4964bc416b43af63b06e", 5.75, "8886aaa4-527d-4253-8951-a07d8bf4cf52"POST /request-to-pay
Creates a request to pay that merchant can then share by link, mail or sms to a customer for asynchronous payment.
Documentation:
# refund (payload, x_language, redirect_uri = nil)
# payload: {}
# x_language: string
# redirect_uri: string
response = pis_client.request_to_pay payload, 'fr', "https://www.my-redirect-uri.fr"GET /settlements
Get the details of all settlements or of a specific settlement.
Documentation:
- Get all settlements: https://doc.fintecture.com/reference/getpisv2settlements
- Get a specific settlement: https://doc.fintecture.com/reference/getpisv2settlement
# settlements (settlement_id = nil, include_payments = false)
# settlement_id: string
# include_payments: boolean
response = pis_client.settlements
OR
response = pis_client.settlements "127335fdeb073e0eb2313ba0bd71ad44"
OR
response = pis_client.settlements "127335fdeb073e0eb2313ba0bd71ad44", trueAIS
AIS client properties
ais_client.app_id
ais_client.app_secret
ais_client.private_key
ais_client.environment
ais_client.token
ais_client.refresh_token
ais_client.token_expires_inGET /connect
Get a connect session for a PSU to create a connection that will enable access to AIS features.
Documentation:
# connect (state, redirect_uri, scope = nil)
# state: string
# redirect_uri: string
# scope: string
response = ais_client.connect "my-state", "https://www.my-redirect-uri.fr"When you follow the returned url, you'll be redirect with "customer_id" & "code" parameters
customer_id = "fa51058b5f8306f1e048f1adda5488a9"
code = "f66ec660b0bbd2797bf6847fb4b98454"Access token
Returns the token and store it in the client for future requests.
Documentation:
ais_client.generate_token codeRefresh token
Returns the token and store it in the client for future requests. If you do not pass the refreshtoken as a parameter, the client refreshtoken will be used.
Documentation:
# generate_refresh_token (refresh_token = nil)
# refresh_token: string
ais_client.generate_refresh_tokenGET /authorize
Authenticates your customer to their Bank for AIS access
Documentation:
# authorize (app_id_auth: false, provider_id:, redirect_uri:, state: nil, x_psu_id: nil, x_psu_ip_address: nil)
# app_id_auth: boolean
# provider_id: string
# redirect_uri: string
# state: string
# x_psu_id: string
# x_psu_ip_address: string
response = ais_client.authorize app_id_auth: false, provider_id: "agfbfr", redirect_uri: "https://www.google.fr", state: "ok", x_psu_id: "123456", x_psu_ip_address: "192.168.1.1"GET /accounts
Get all accounts linked to a specific AIS connection.
Documentation:
# accounts (customer_id:, account_id: nil, remove_nulls: nil, withBalances: nil)
# customer_id: string
# account_id: string
# remove_nulls: boolean
# withBalances: boolean
response = ais_client.accounts customer_id: customer_id, account_id: nil, remove_nulls: nil, withBalances: nilGET /transactions
Get all transactions linked to a specific AIS connection for a specific account.
Documentation:
# transactions (customer_id:, account_id:, remove_nulls: nil, convert_dates: nil, filters: nil)
# customer_id: string
# account_id: string
# remove_nulls: boolean
# convert_dates: boolean
# filters: {}
transactions_filters = {
"filter[date_to]": "2020-01-01",
'filter[date_from]': "max" # Date or 'max'
}
response = ais_client.transactions customer_id: customer_id, account_id: "b71722204d1a3f5ecd895", remove_nulls: true, convert_dates: true, filters: transactions_filtersGET /accountholders
Retrieves all personal information of the client such as name, address and contact details for all the beneficiary owners.
Documentation:
# account_holders (customer_id:, remove_nulls: nil)
# customer_id: string
# remove_nulls: boolean
response = ais_client.account_holders customer_id: customer_id, remove_nulls: trueDELETE /customer
Deletes all active access tokens and all PSU data linked to requested connection.
Documentation:
# account_holders (customer_id:)
# customer_id: string
response = ais_client.delete_customer customer_id: customer_idRESSOURCES
Use the PIS client to get ressources. The "generate_token" step is not needed for this calls
GET /providers
Documentation:
# providers (provider_id: nil, paramsProviders: nil)
# provider_id: string
# paramsProviders: string
paramsProviders = {
'filter[country]': 'FR',
'filter[pis]': 'SEPA',
'filter[ais]': 'Accounts',
'filter[psu_type]': 'retail',
'filter[auth_model]': 'redirect',
'sort[name]': 'DESC',
'sort[full_name]': 'DESC',
'sort[country]': 'DESC',
'sort[provider_id]': 'DESC'
}
response = pis_client.providers provider_id: 'agfbfr', paramsProviders: paramsProvidersGET /applications
Documentation:
# applications ()
response = pis_client.applicationsAPI Errors handling
Hash version
begin
pis_client.refund "7f47d3675f5d4964bc416b43af63b06e", 1
rescue => e
error = JSON.parse e.to_s
puts error
end{
"type"=>"Fintecture api",
"status"=>401,
"errors"=>[
{
"code"=>"invalid_token",
"title"=>"Invalid Token",
"message"=>"The token is either invalid or expired."
}
],
"error_string"=>"\nFintecture server errors : \n status: 401 \n code: unauthorized\n id : 3006ddbf-2f97-44d8-9f63-35711b78e8a6\n\n code: invalid_token\n title: Invalid Token\n message: The token is either invalid or expired.\n\n"
}Text version
begin
pis_client.refund "7f47d3675f5d4964bc416b43af63b06e", 1
rescue => e
error = JSON.parse e.to_s
puts error['error_string']
endFintecture server errors :
status: 401
code: unauthorized
id : 2adb9e35-ff0d-4477-959e-b1b1a7d7c812
code: invalid_token
title: Invalid Token
message: The token is either invalid or expired.Development
After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/Fintecture/fintecture-sdk-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the GPL-3.0 License.
Code of Conduct
Everyone interacting in the Fintecture project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.