HUB2 Documentation

HUB2

Integration

Intégration

Documentation

API Reference

Failure causes

Home

Accueil

A guide to help getting started with HUB2 API integration

Introduction

API Operation

Security

Understand errors

API keys

MSISDN - Blacklist

Authentication

List payments

Object samples

List of available events

Webhooks behavior

Best practices

Samples

Balances

Account Provisioning

Public data

Bank transfer compliance

Un guide pour commencer à intégrer l'API HUB2

Fonctionnement de l'API

Sécurité

Comprendre les erreurs

Clés API

Motifs d'échec

MSISDN - Liste noire

Authentification

Lister les paiements

Exemples d'objets

Liste des évènements disponibles

Comportement des webhooks

Les bonnes pratiques

Échantillons

Soldes

Approvisionnement de compte

Données publiques

Conformité transfert bancaire

Definition of useful terms used in HUB2's payment platform

Glossary

Rate limits

Policies

Error management

Glossaire

Ce sont les limites appliquées sur notre API.

Limites de flux

Règles

Gestion des erreurs

Returns the list of countries where Hub2 is available

Get countries

Returns the list of providers available with Hub2

Get providers

Returns a summary of a merchant accounts balances (collection, transfer and transfer irt accounts) .

Check Merchant Balance

Get all webhooks

Create a webhook

Get a webhook

Remove a webhook

Update a webhook

Retrieve number of sms sent between two date

Retrieve number of sms sent

Retrieve a list of sms sent between two date.

Get a list of sms sent

Send Sms

This endpoints is here to provide you an efficient way of retrieving multiple payment intents at the same time.
    Everything is provided in the request's headers to perform a proper pagination on the results.

Retrieve a PaymentIntent collection

This endpoint is the first entry point of the PAY-IN circuit.
    First of all, you must create a payment intent which describes your intention to collect an amount of money in a currency.
    Later on, you will perform payments associated with this payment intent.
    Please do save the fields returned by this endpoint, especially the field 'id' and 'token'.
    That will help you identity the payment intent in our platform whenever you want to retrieve it.

Create a PaymentIntent object

This endpoint allows you to fetch an existing payment intent from our database.
    You must either provide the "id" or the "token" for us to find that payment intent.
    Retrieving using the "token" is the fastest way and is not rate limited, depending on your needs, that's probably the best solution.

Retrieve a PaymentIntent object

This is the endpoint to use whenever you want to attempt a payment on a payment intent.
    It will create a payment object associated with the intent which will contains all the informations about the payment.
    Whenever a payment fails or don't have the appropriate amount to match the intent, other payments can be created on the same intent.

Attempt a payment on a PaymentIntent object

This is the same endpoint but the payment is handled synchronously, it means it will wait for the provider response before returning the status of the payment intent. This endpoint is not the favored way to integrate our api and is not available for all merchants and for all providers.

Synchronously attempt a payment on a payment intent

Some circuit have authentication restrictions which requires an extra step.
    This endpoint is here to allow you to make that extra steps. It happens after a payment has been requested and when that payment moved to the "action_required" state.

Authenticate the current payment

This endpoint allows you to retrieve the fees associated with a payment intent.
    Fees are applied per payment and this endpoints will group all the fees in an array.

Retrieve fees

This endpoint fetch the merchant's preference and return the redirection URL saved in there.
    This is mostly used for the Hub2 modal feature.
    You must provide the payment intent token for that.

Retrieve configured URLs

Return a list of Payments, eventually filtered by criteria.

Retrieve a Payments collection

Retrieve a Provisionings collection

Move funds from merchant's collection account to transfer account

Create a Provisioning

Retrieve a Provisioning from given id

Retrieve a sucessful or failed transfer or payment receipt

Retrieve a Receipt

Retrieve a sucessful or failed transfer or payment receipt as HTML

Retrieve a Receipt as an HTML representation

Execute payment

Retrieve a payment

Return a list of IRT transfers, eventually filtered by criteria.

Retrieve a IRT transfers collection

Create IRT transfer

Return a list of Transfers, eventually filtered by criteria.

Retrieve a Transfer collection

This endpoint allows you to make a transfer (PAY-OUT)

Create Transfer

This endpoint allows you to fetch an existing transfer from our database
    by providing its 'id'

Code	Description
`internal_error`	Payment failed. Internal error. Our technical team has been notified.
`service_unavailable`	Payment failed. Provider is currently unavailable.
`unknown_reason`	Payment failed. No reason was provided by the provider.
`unknown_reason_orange`	Payment failed. No reason was given by Orange.
`customer_account_locked`	Payment failed. The customer account is locked by provider.
`customer_insufficient_funds`	Payment failed. The customer doesn’t have enough funds.
`authentication_failed`	Payment failed. The customer failed to authenticate the payment.
`authentication_timeout`	Payment failed. The customer did not authenticate the payment in time.
`timeout`	Payment failed. The waiting period for payment execution has expired.
`bad_parameters`	Payment failed. Bad parameters.
`forbidden_by_provider`	Payment failed. The payment was forbidden by the provider.
`too_many_request`	Payment failed. Provider is overloaded. Please try again later.
`duplicate_request`	Payment failed. A similar operation has just been recorded. Please try again later.
`canceled_by_customer`	Payment failed. Canceled by the customer.
`canceled`	Payment failed. Canceled by the provider.
`fraud_suspicion`	Payment failed. Fraud suspicion detected by the provider.
`unsupported_currency`	Payment failed. This currency is not supported.
`payer_quota_exceeded`	Payment failed. Customer quota exceeded.
`invalid_payment_processor`	Payment failed. The selected provider does not allow to perform this operation.
`invalid_msisdn`	Payment failed. Incorrect phone number (MSISDN).
`wave_payment_expired`	Payment expired. Do not use the corresponding Wave’s payment link anymore.
`blacklisted_msisdn`	The MSISDN is temporarily banned.
`card_expired`	Payment failed. The card’s expiry date has passed.
`card_declined`	Payment failed. The card has been declined.
`card_stolen`	Payment failed. The card is reported as stolen.
`card_refused`	Payment failed. The card has been declined.
`card_invalid`	Payment failed. Invalid Credit Card.
`card_cvn_invalid`	Payment failed. The card security key is invalid.
`address_verification_failed`	Payment failed. Address does not match credit card.
`card_limit_reached`	Payment failed. The card limit has been reached.

Getting started

Transfers

Payments

Webhooks

Other

Failure causes

Important