# imoje RESTful API ## Description This is version `1.5.0` of this API documentation. Last update on Mar 16, 2026. # Technical documentation for integration with the imoje transaction system # Introduction Instructions for integration using the RESTful API with the imoje payment gateway. You can find the Polish version [here](https://bump.sh/pgw/doc/imoje-api/). See also our [FRONT API](https://bump.sh/pgw/doc/imoje-paywall-en/) integration. ## Data required for integration * `Merchant ID` - merchantId * `Shop ID` - serviceId * `Shop key` - serviceKey * `Authorization token` - Bearer token ## Where to find data for integration After logging into the [imoje administration panel](https://imoje.ing.pl), go to the `Shops` tab, select the appropriate shop and go to its `Details`. Then go to the `Data for integration` tab. Here you will find: `Merchant ID`, `Shop ID`, `Shop key` and `Authorisation token`. > [Administration panel](https://sandbox.imoje.ing.pl) for the sandbox test environment ## Contact Email address: kontakt.tech@imoje.pl Tel: +48 32 319 35 70 ## Servers - Production environment: https://api.imoje.pl/v1/merchant (Production environment) - Test environment: https://sandbox.api.imoje.pl/v1/merchant (Test environment) ## Topics - [Authentication](https://bump.sh/pgw/doc/imoje-api-en/authentication.md) - [RESTful API Methods](https://bump.sh/pgw/doc/imoje-api-en/topic/topic-restful-api-methods.md) - [Transaction methods and channels](https://bump.sh/pgw/doc/imoje-api-en/topic/topic-transaction-methods-and-channels.md) - [Transaction and payment link statuses](https://bump.sh/pgw/doc/imoje-api-en/topic/topic-transaction-and-payment-link-statuses.md) - [HTTP response codes](https://bump.sh/pgw/doc/imoje-api-en/topic/topic-http-response-codes.md) - [Notifications](https://bump.sh/pgw/doc/imoje-api-en/topic/topic-notifications.md) - [Transaction pre-authorisation](https://bump.sh/pgw/doc/imoje-api-en/topic/topic-transaction-pre-authorisation.md) - [OneClick and recurring card payments](https://bump.sh/pgw/doc/imoje-api-en/topic/topic-oneclick-and-recurring-card-payments.md) - [Google Pay and Apple Pay 0 level payments](https://bump.sh/pgw/doc/imoje-api-en/topic/topic-google-pay-and-apple-pay-0-level-payments.md) - [Multipayout](https://bump.sh/pgw/doc/imoje-api-en/topic/topic-multipayout.md) - [ING Księgowość](https://bump.sh/pgw/doc/imoje-api-en/topic/topic-ing-ksiegowosc.md) - [ING Lease Now](https://bump.sh/pgw/doc/imoje-api-en/topic/topic-ing-lease-now.md) - [Handling card transaction codes](https://bump.sh/pgw/doc/imoje-api-en/topic/topic-handling-card-transaction-codes.md) - [Minimum and maximum values of transaction amounts](https://bump.sh/pgw/doc/imoje-api-en/topic/topic-minimum-and-maximum-values-of-transaction-amounts.md) - [Sandbox](https://bump.sh/pgw/doc/imoje-api-en/topic/topic-sandbox.md) ## Endpoints and operations ### [transaction](https://bump.sh/pgw/doc/imoje-api-en/group/endpoint-transaction.md) - [Creating a transaction](https://bump.sh/pgw/doc/imoje-api-en/operation/operation-post-parameter-transaction.md) - [Downloading transaction data](https://bump.sh/pgw/doc/imoje-api-en/operation/operation-get-parameter-transaction-parameter.md) - [Transaction capture](https://bump.sh/pgw/doc/imoje-api-en/operation/operation-post-parameter-transaction-parameter-capture.md) - [Transaction rejection](https://bump.sh/pgw/doc/imoje-api-en/operation/operation-post-parameter-transaction-parameter-void.md) ### [payment](https://bump.sh/pgw/doc/imoje-api-en/group/endpoint-payment.md) - [Creating a payment link](https://bump.sh/pgw/doc/imoje-api-en/operation/operation-post-parameter-payment.md) - [Downloading payment link data](https://bump.sh/pgw/doc/imoje-api-en/operation/operation-get-parameter-payment-parameter.md) - [Payment link cancellation.](https://bump.sh/pgw/doc/imoje-api-en/operation/operation-post-parameter-payment-cancel.md) ### [refund](https://bump.sh/pgw/doc/imoje-api-en/group/endpoint-refund.md) - [Creation of a refund](https://bump.sh/pgw/doc/imoje-api-en/operation/operation-post-parameter-transaction-parameter-refund.md) - [Obtaining information about the possibility of making a return](https://bump.sh/pgw/doc/imoje-api-en/operation/operation-post-parameter-transaction-parameter-can-refund.md) ### [service](https://bump.sh/pgw/doc/imoje-api-en/group/endpoint-service.md) - [Downloading service data](https://bump.sh/pgw/doc/imoje-api-en/operation/operation-get-parameter-service-parameter.md) ### [services](https://bump.sh/pgw/doc/imoje-api-en/group/endpoint-services.md) - [Downloading services data](https://bump.sh/pgw/doc/imoje-api-en/operation/operation-get-parameter-services.md) ### [profile](https://bump.sh/pgw/doc/imoje-api-en/group/endpoint-profile.md) - [OneClick or recurring profile debiting](https://bump.sh/pgw/doc/imoje-api-en/operation/operation-post-parameter-transaction-profile.md) - [Retrieving profile information based on cid](https://bump.sh/pgw/doc/imoje-api-en/operation/operation-get-parameter-profile-cid-parameter.md) - [Retrieving profile information based on profile ID](https://bump.sh/pgw/doc/imoje-api-en/operation/operation-get-parameter-profile-id-parameter.md) - [Deactivating your OneClick or recurring profile](https://bump.sh/pgw/doc/imoje-api-en/operation/operation-delete-parameter-profile-id-parameter.md) - [Deactivating your OneClick or recurring profile](https://bump.sh/pgw/doc/imoje-api-en/operation/operation-post-parameter-profile-deactivate.md) ### [ips](https://bump.sh/pgw/doc/imoje-api-en/group/endpoint-ips.md) - [Downloading the list of trusted IP addresses](https://bump.sh/pgw/doc/imoje-api-en/operation/operation-get-parameter-settings-ips.md) - [Setting up a list of trusted IP addresses](https://bump.sh/pgw/doc/imoje-api-en/operation/operation-put-parameter-settings-ips.md) ### [get-payment-methods](https://bump.sh/pgw/doc/imoje-api-en/group/endpoint-get-payment-methods.md) - [Downloading available payment methods](https://bump.sh/pgw/doc/imoje-api-en/operation/operation-post-parameter-service-parameter-get-payment-methods.md) [Powered by Bump.sh](https://bump.sh)