# HUB2 Documentation

## Docs

- [Introduction](https://docs.hub2.io/integration/en/getting_started/introduction.md): A guide to help getting started with HUB2 API integration
- [API Operation](https://docs.hub2.io/integration/en/getting_started/api_operation.md)
- [Security](https://docs.hub2.io/integration/en/getting_started/security_considerations.md)
- [Understand errors](https://docs.hub2.io/integration/en/getting_started/understand_errors.md)
- [API keys](https://docs.hub2.io/integration/en/getting_started/api_keys.md)
- [Introduction](https://docs.hub2.io/integration/en/transfers/transfers_introduction.md)
- [Integration](https://docs.hub2.io/integration/en/transfers/transfers_integration.md)
- [Failure causes](https://docs.hub2.io/integration/en/transfers/transfers_failure_causes.md)
- [MSISDN - Blacklist](https://docs.hub2.io/integration/en/transfers/transfers_msisdn_blacklist.md)
- [Sandbox MSISDN](https://docs.hub2.io/integration/en/transfers/transfers_sandbox_msisdn.md)
- [Introduction](https://docs.hub2.io/integration/en/payments/payments_introduction.md)
- [Integration](https://docs.hub2.io/integration/en/payments/payments_integration.md)
- [Authentication](https://docs.hub2.io/integration/en/payments/payments_authentication.md)
- [List payments](https://docs.hub2.io/integration/en/payments/payments_list.md)
- [Object samples](https://docs.hub2.io/integration/en/payments/payments_examples.md)
- [Failure causes](https://docs.hub2.io/integration/en/payments/payments_failure_causes.md)
- [Sandbox MSISDN](https://docs.hub2.io/integration/en/payments/payments_sandbox_msisdn.md)
- [Introduction](https://docs.hub2.io/integration/en/webhooks/webhooks_overview.md)
- [Integration](https://docs.hub2.io/integration/en/webhooks/webhooks_integration.md)
- [List of available events](https://docs.hub2.io/integration/en/webhooks/webhooks_events_list.md)
- [Webhooks behavior](https://docs.hub2.io/integration/en/webhooks/webhooks_behavior.md)
- [Best practices](https://docs.hub2.io/integration/en/webhooks/webhooks_bestpractices.md)
- [Samples](https://docs.hub2.io/integration/en/webhooks/webhooks_examples.md)
- [Introduction](https://docs.hub2.io/integration/en/processing_only/processing_only_introduction.md): Learn about our Processing Only solution that acts as a gateway for merchants using their own provider accounts
- [Setup](https://docs.hub2.io/integration/en/processing_only/processing_only_setup.md): Learn how to set up your provider credentials for Processing Only mode.
- [Integration](https://docs.hub2.io/integration/en/processing_only/processing_only_integration.md): Learn how to integrate Processing Only mode into your application
- [Introduction](https://docs.hub2.io/integration/en/payment_links/payment-links_introduction.md): Discover our **Payment Links** solution that allows you to collect payments through a simple and secure payment link.
- [Configuration](https://docs.hub2.io/integration/en/payment_links/payment-links_setup.md): Learn how to configure your API for payment links.
- [Integration](https://docs.hub2.io/integration/en/payment_links/payment-links_integration.md): Learn how to integrate payment links into your application
- [Introduction](https://docs.hub2.io/integration/en/submerchants/submerchants_introduction.md): Discover our **submerchants** solution that allows you to onboard a new submerchant and generate their unique ID for payment processing and transfers.
- [Configuration](https://docs.hub2.io/integration/en/submerchants/submerchants_setup.md): Learn how to configure your API for submerchants.
- [Integration](https://docs.hub2.io/integration/en/submerchants/submerchants_integration.md): Learn how to create submerchants from our API
- [Balances](https://docs.hub2.io/integration/en/other_products/balances.md)
- [Refunds](https://docs.hub2.io/integration/en/other_products/refunds.md)
- [Account Provisioning](https://docs.hub2.io/integration/en/other_products/provisioning.md)
- [Public data](https://docs.hub2.io/integration/en/other_products/public_data.md)
- [Bank collection](https://docs.hub2.io/integration/en/other_products/bank_collection.md)
- [Recipients](https://docs.hub2.io/integration/en/other_products/recipients.md)
- [Payload signature](https://docs.hub2.io/integration/en/other_products/payload_signature.md)
- [Glossary](https://docs.hub2.io/documentation/en/glossary.md): Definition of useful terms used in HUB2's payment platform
- [Rate limits](https://docs.hub2.io/documentation/en/limits.md): Those are the limits applied on our API.
- [Policies](https://docs.hub2.io/documentation/en/policies.md)
- [Error management](https://docs.hub2.io/documentation/en/error_management.md)
- [Get countries](https://docs.hub2.io/api-reference/data/get-countries.md): Returns the list of countries where Hub2 is available
- [Get providers](https://docs.hub2.io/api-reference/data/get-providers.md): Returns the list of providers available with Hub2
- [Check Merchant Balance](https://docs.hub2.io/api-reference/balance/check-merchant-balance.md): Returns a summary of a merchant accounts balances (collection, transfer and transfer irt accounts) .
- [Get all webhooks](https://docs.hub2.io/api-reference/webhooks/get-all-webhooks.md)
- [Create a webhook](https://docs.hub2.io/api-reference/webhooks/create-a-webhook.md)
- [Get a webhook](https://docs.hub2.io/api-reference/webhooks/get-a-webhook.md)
- [Remove a webhook](https://docs.hub2.io/api-reference/webhooks/remove-a-webhook.md)
- [Update a webhook](https://docs.hub2.io/api-reference/webhooks/update-a-webhook.md)
- [Retrieve number of sms sent](https://docs.hub2.io/api-reference/sms/retrieve-number-of-sms-sent.md): Retrieve number of sms sent between two date
- [Get a list of sms sent](https://docs.hub2.io/api-reference/sms/get-a-list-of-sms-sent.md): Retrieve a list of sms sent between two date.
- [Send Sms](https://docs.hub2.io/api-reference/sms/send-sms.md): Send Sms to different destinations.
- [Retrieve a PaymentIntent collection](https://docs.hub2.io/api-reference/payments/retrieve-a-paymentintent-collection.md): 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.
- [Create a PaymentIntent object](https://docs.hub2.io/api-reference/payments/create-a-paymentintent-object.md): 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 retu…
- [Retrieve a PaymentIntent object](https://docs.hub2.io/api-reference/payments/retrieve-a-paymentintent-object.md): 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 uses a more permissive rate limit (10 requests per 5 seconds).
- [Attempt a payment on a PaymentIntent object](https://docs.hub2.io/api-reference/payments/attempt-a-payment-on-a-paymentintent-object.md): 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, ot…
- [Synchronously attempt a payment on a payment intent](https://docs.hub2.io/api-reference/payments/synchronously-attempt-a-payment-on-a-payment-intent.md): 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.
- [Authenticate the current payment](https://docs.hub2.io/api-reference/payments/authenticate-the-current-payment.md): 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.
- [Retrieve fees](https://docs.hub2.io/api-reference/payments/retrieve-fees.md): 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 configured URLs](https://docs.hub2.io/api-reference/payments/retrieve-configured-urls.md): 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 a PaymentIntent status](https://docs.hub2.io/api-reference/payments/retrieve-a-paymentintent-status.md): This endpoint allows you to fetch the status of 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 uses a more permissive rate limit (10 requests per 5 seconds).
- [Retrieve a Payments collection](https://docs.hub2.io/api-reference/payments/retrieve-a-payments-collection.md): Return a list of Payments, eventually filtered by criteria.
- [Retrieve the status payment object](https://docs.hub2.io/api-reference/payments/retrieve-the-status-payment-object.md)
- [Retrieve a Provisionings collection](https://docs.hub2.io/api-reference/provisioning/retrieve-a-provisionings-collection.md)
- [Create a Provisioning](https://docs.hub2.io/api-reference/provisioning/create-a-provisioning.md): Move funds from merchant's collection account to transfer account
- [Retrieve a Provisioning from given id](https://docs.hub2.io/api-reference/provisioning/retrieve-a-provisioning-from-given-id.md)
- [Retrieve a Receipt](https://docs.hub2.io/api-reference/receipt/retrieve-a-receipt.md): Retrieve a sucessful or failed transfer or payment receipt
- [Retrieve a Receipt as an HTML representation](https://docs.hub2.io/api-reference/receipt/retrieve-a-receipt-as-an-html-representation.md): Retrieve a sucessful or failed transfer or payment receipt as HTML
- [Execute payment](https://docs.hub2.io/api-reference/payment-on-terminal/execute-payment.md)
- [Retrieve a payment](https://docs.hub2.io/api-reference/payment-on-terminal/retrieve-a-payment.md)
- [Retrieve a IRT transfers collection](https://docs.hub2.io/api-reference/irt/retrieve-a-irt-transfers-collection.md): Return a list of IRT transfers, eventually filtered by criteria.
- [Create IRT transfer](https://docs.hub2.io/api-reference/irt/create-irt-transfer.md): Make an IRT transfer
- [Retrieve a Transfer collection](https://docs.hub2.io/api-reference/transfers/retrieve-a-transfer-collection.md): Return a list of Transfers, eventually filtered by criteria.
- [Create Transfer](https://docs.hub2.io/api-reference/transfers/create-transfer.md): This endpoint allows you to make a transfer (PAY-OUT)
- [Retrieve a Transfer](https://docs.hub2.io/api-reference/transfers/retrieve-a-transfer.md): This endpoint allows you to fetch an existing transfer from our database     by providing its 'id'
- [Retrieve a transfer's balance](https://docs.hub2.io/api-reference/transfers/retrieve-a-transfers-balance.md): Fetch balance before and after transfer
- [Retrieve a transfer's status](https://docs.hub2.io/api-reference/transfers/retrieve-a-transfers-status.md): Retrieve the status for a transfer
- [Retrieve refunds collection](https://docs.hub2.io/api-reference/refunds/retrieve-refunds-collection.md): This endpoint allows you to retrieve a list of refunds with filtering and pagination options.
- [Create a refund](https://docs.hub2.io/api-reference/refunds/create-refund.md): This endpoint allows you to create a refund for a successful transfer.
- [Retrieve a refund](https://docs.hub2.io/api-reference/refunds/retrieve-a-refund.md): This endpoint allows you to retrieve the details of a specific refund.
- [Retrieve a kyb by name](https://docs.hub2.io/api-reference/compliance/retrieve-a-kyb-by-name.md)
- [Update a kyb](https://docs.hub2.io/api-reference/compliance/update-a-kyb.md)
- [Delete a kyb](https://docs.hub2.io/api-reference/compliance/delete-a-kyb.md)
- [Fetch a kyb list](https://docs.hub2.io/api-reference/compliance/fetch-a-kyb-list.md)
- [Create a kyb](https://docs.hub2.io/api-reference/compliance/create-a-kyb.md)
- [Fetch a kyb transactions list](https://docs.hub2.io/api-reference/compliance/fetch-a-kyb-transactions-list.md)
- [Create a kyb transaction](https://docs.hub2.io/api-reference/compliance/create-a-kyb-transaction.md)
- [Retrieve a kyb transaction by reference](https://docs.hub2.io/api-reference/compliance/retrieve-a-kyb-transaction-by-reference.md)
- [Delete a kyb transaction](https://docs.hub2.io/api-reference/compliance/delete-a-kyb-transaction.md)
- [Get kyc information](https://docs.hub2.io/api-reference/compliance/get-kyc-information.md)
- [Create a new recipient](https://docs.hub2.io/api-reference/recipients/create-recipient.md)
- [Get a recipient by id](https://docs.hub2.io/api-reference/recipients/find-recipient.md)
- [Retrieve a list of recipients according to filters](https://docs.hub2.io/api-reference/recipients/list-recipients.md)
- [Delete a recipient by id](https://docs.hub2.io/api-reference/recipients/delete-recipient.md)
- [Create a delegated payment](https://docs.hub2.io/api-reference/processing-only/make-a-delegated-payment.md): This endpoint allows you to make a payment using your own provider credentials.
- [Create a delegated synchronous payment](https://docs.hub2.io/api-reference/processing-only/make-a-synchronous-delegated-payment.md): This endpoint allows you to make a synchronous payment using your own provider credentials.
- [Create a delegated Transfer](https://docs.hub2.io/api-reference/processing-only/make-a-delegated-transfer.md): This endpoint allows you to make a transfer (PAY-OUT) using your own provider credentials.
- [Create a delegated IRT transfer](https://docs.hub2.io/api-reference/processing-only/make-a-delegated-transfer-irt.md): Make an IRT transfer using your own provider credentials.
- [Create Payment Links](https://docs.hub2.io/api-reference/payment_links/create_payment_links.md): This endpoint allows you to generate a secure payment link for receiving payments from your customers.
- [List Payment Links](https://docs.hub2.io/api-reference/payment_links/list_payment_links.md): Retrieve a list of payment links with optional filtering
- [Get Payment Link with Attempts](https://docs.hub2.io/api-reference/payment_links/list_payment_links_with_attempts.md): Retrieve detailed information about a payment link including payment attempts
- [Close payment links](https://docs.hub2.io/api-reference/payment_links/close_payment_links.md)
- [Create a submerchant](https://docs.hub2.io/api-reference/submerchants/create_submerchants.md): This endpoint allows you to onboard a new submerchant and generate their unique ID for payment processing and transfers.
- [List submerchants](https://docs.hub2.io/api-reference/submerchants/list_submerchants.md)
- [Update a submerchant](https://docs.hub2.io/api-reference/submerchants/update-a-submerchant.md)

## OpenAPI Specs

- [docs-json](https://api.hub2.io/docs-json)
- [openapi](https://docs.hub2.io/api-reference/openapi.json)