Introduction
The Mangopay Ruby SDK makes working with the Mangopay API easier in a Ruby environment.
The SDK package is available on RubyGems: mangopay4-ruby-sdk
Caution – Use only the mangopay4 package (late Nov 2025)Please ensure you use only the package with mangopay4 in the name (this is the package name and has no connection with the SDK version number).Any other package must not be used. You need to update your package manually.Since November 25, 2025, Mangopay’s official SDKs are no longer accessible on GitHub (with the exception of PHP for publication reasons).
PrerequisitesTo run the Mangopay Ruby SDK, you’ll need:
- A
ClientId and an API key – if you don’t have these, contact Sales to get access to the Mangopay Dashboard
- Ruby 1.9.2 or higher (tested from 1.9.2 up to 3.4.4)
Getting started
- Install the SDK
gem install mangopay4-ruby-sdk
- Initialize and configure the SDK
require 'mangopay'
MangoPay.configure do |c|
c.preproduction = true
c.client_id = 'your-mangopay-client-id'
c.client_apiKey = 'your-mangopay-api-key'
c.http_timeout = 30000
c.Http_open_timeout = 60000
c.Log_file = File.join('mypath', 'mangopay.log')
end
|
preproduction | boolean | false | Defines whether the SDK calls the Production or Sandbox endpoints. |
client_id | string | None | Your Mangopay ClientId – can be found in the Dashboard. |
client_apiKey | string | None | Your Mangopay API key – can be found in the Dashboard. |
http_timeout | int milliseconds | 30 | Specifies the amount of time until request failure because a chunk of data cannot be read. |
http_open_timeout | int milliseconds | 30 | Specifies the amount of time until request failure because a connection cannot be made. |
log_file | string | None | Enables logging. Results and responses are filtered so that confidential data is not saved in the log. |
uk_header_flag | boolean | false | Platforms that have contracted with Mangopay’s UK entity (MANGOPAY U.K. LIMITED) must include the following header in all requests. If you’re using an SDK, you need to set it to true. |
SDK usage
All endpoints are documented with the related Ruby SDK method throughout the Mangopay documentation. You should adjust the code examples provided for your usage.
Multi configurations
The Ruby SDK offers the option to create multiple configuration objects tailored to your specific needs:
config = MangoPay::Configuration.new
config.client_id = 'your-client-id'
config.client_apiKey = 'your-api-key'
config.preproduction = true
add_config method to add the new configuration:
MangoPay.add_config('config1', config)
get_config and apply_configuration methods:
MangoPay.get_config('config1').apply_configuration
page and per_page keys.
As a result, the answer will be paginated, and the total number of items and the total number of pages will be provided.
require 'mangopay'
# configuration
MangoPay.configure do |client|
client.preproduction = true
client.client_id = 'your-client-id'
client.client_apiKey = 'your-api-key'
end
def getAllUsers(parameters)
begin
response = MangoPay::User.fetch(parameters)
puts response
puts parameters
return response
rescue MangoPay::ResponseError => error
puts "Error details: #{error.details}"
end
end
pagination = {'page' => 1, 'per_page' => 8}
getAllUsers(pagination)
Filtering
For endpoints that support filtering, you can use an object containing the filtering parameters.
require 'mangopay'
# configuration
MangoPay.configure do |client|
client.preproduction = true
client.client_id = 'your-client-id'
client.client_apiKey = 'your-api-key'
end
def indexEvents(filters)
begin
response = MangoPay::Event.fetch(filters)
puts response
return response
rescue MangoPay::ResponseError => error
puts "Error details: #{error.details}"
end
end
myFilters = { 'BeforeDate': 1688020455, 'AfterDate': 1686378855 }
indexEvents(myFilters)
Error handling
As an alternative to logging, you can use the following example to surface errors returned by the Ruby SDK within your app.
begin
MangoPay::NaturalUser.create({})
rescue MangoPay::ResponseError => ex
ex # => #<MangoPay::ResponseError: One or several required parameters are missing or incorrect. [...] FirstName: The FirstName field is required. LastName: The LastName field is required. Nationality: The Nationality field is required.>
ex.details # => {
# "Message"=>"One or several required parameters are missing or incorrect. [...]",
# "Type"=>"param_error",
# "Id"=>"5c080105-4da3-467d-820d-0906164e55fe",
# "Date"=>1409048671.0,
# "errors"=>{
# "FirstName"=>"The FirstName field is required.",
# "LastName"=>"The LastName field is required.", ...},
# "Code"=>"400",
# "Url"=>"/v2/.../users/natural"
# }
end
Rate limiting
Along with each request, the rate limiting headers are automatically updated in the MangoPay object:
- X-RateLimit-Limit
- X-RateLimit-Remaining
- X-RateLimit-Reset
MangoPay.ratelimit
{
:limit=>["74", "74", "75", "908"],
:remaining=>["2226", "4426", "8725", "104692"],
:reset=>["1495615620", "1495616520", "1495618320", "1495701060"]
}
Error handling
The SDK provides the MangoPay::ResponseError exception object to wrap HTTP errors returned by the API.
You can wrap your function in a begin…rescue block to catch errors, and the ex.details hash to create specific logic, for example:
begin
MangoPay::Wallet.fetch(walletId, nil, {'ScaContext': 'USER_PRESENT'})
puts response
return response
rescue MangoPay::ResponseError => error
puts "Failed to fetch wallet: #{error.message}"
puts "Error details: #{error.details}"
return false
end
