# Partial Returns Guide
Documentation version 1.01, 12.09.2025
The current document contains information on how partial returns can be performed for Hire Purchase or Pay in parts / Split into parts contracts via Inbank API. The process description can be found in the [API Request Flow](#requestflow) chapter. Note that unlike most of other Inbank API endpoints, the endpoints for the partial returns process include `v3` and not `v2` in the request URL.
Please note, that the current document is applicable to partial returns only, if you would like to implement full contact withdrawal, refer to [Contract Withdrawal](/api/full-api-flow/#operation/postMerchantWithdrawal).
To test in the demo environment, please let us know as extra steps are needed from our side to ensure the return will work for your tests.
There are two preconditions for partial returns:
- The return is possible starting from the next day of when the contract was made.
- The contract should be paid out.
For any questions regarding the partial return integration process, contact Inbank at:
- Estonia: integration@inbank.ee
- Latvia: integration@inbank.lv
- Poland: integration@inbank.pl
- Czechia: integration@inbank.cz
- Lithuania: integration@inbank.lt
# URLs
Estonia:
|Environment|API|Partner Portal|
| :- | :- | :- |
|Test|https://demo-api.inbank.ee/partner/v3/|https://demo-partner.inbank.ee/|
|Production|https://api.inbank.ee/partner/v3/|https://partner.inbank.ee/|
Latvia:
|Environment|API|Partner Portal|
| :- | :- | :- |
|Test|https://demo-api.inbank.lv/partner/v3/|https://demo-partner.inbank.lv/|
|Production|https://api.inbank.lv/partner/v3/|https://partner.inbank.lv/|
Poland:
|Environment|API|Partner Portal|
| :- | :- | :- |
|Test|https://demo-api.inbank.pl/partner/v3/|https://demo-partner.inbank.pl/|
|Production|https://api.inbank.pl/partner/v3/|https://partner.inbank.pl/|
Czechia:
|Environment|API|Partner Portal|
| :- | :- | :- |
|Test|https://demo-api.inbank.cz/partner/v3/|https://demo-partner.inbank.cz/|
|Production|https://api.inbank.cz/partner/v3/|https://partner.inbank.cz/|
Lithuania:
|Environment|API|Partner Portal|
| :- | :- | :- |
|Test|https://demo-api.inbank.lt/partner/v3/|https://demo-partner.inbank.lt/|
|Production|https://api.inbank.lt/partner/v3/|https://partner.inbank.lt/|
# API Request Flow
*Note that steps number 3 and 5 can be skipped if needed.
## Servers
Demo environment
```
https://demo-api.inbank.ee
```
Live environment
```
https://api.inbank.ee
```
## Security
### bearerAuth
Type: http
Scheme: bearer
## Download OpenAPI description
[Partial Returns Guide](https://docs.inbank.eu/_bundle/api/partial-return-flow.yaml)
## Other
### Check if a partial return is available
- [GET /partner/v3/shops/{shopUuid}/contracts/{contractUuid}/change-options](https://docs.inbank.eu/api/partial-return-flow/other/getchangeoptions.md): GET /partner/v3/shops/{shopUuid}/contracts/{contractUuid}/change-options
The endpoint returns the information on whether a partial return is possible and if so also the amount range within which the return can be submitted.
### Create new draft contract
- [POST /partner/v3/shops/{shopUuid}/contracts/{contractUuid}/versions](https://docs.inbank.eu/api/partial-return-flow/other/postcontractversion.md): POST /partner/v3/shops/{shopUuid}/contracts/{contractUuid}/versions
Using this endpoint a partial return can be submitted to Inbank, which in turn creates a new contract version that needs to be reviewed using the Review updated payment schedule API request and, if all is fine, then confirmed using the Confirm the updated contract API request.
### Review updated payment schedule
- [GET /partner/v3/shops/{shopUuid}/contracts/{contractUuid}/payment-schedules/{paymentScheduleUuid}](https://docs.inbank.eu/api/partial-return-flow/other/getpaymentschedule.md): GET /partner/v3/shops/{shopUuid}/contracts/{contractUuid}/payment-schedules/{paymentScheduleUuid}
If the updated payment schedule needs to be reviewed prior to activating the contact with the updated amount, it can be retrieved using this endpoint.
Please note, that this endpoint is optional in the preces, so if you do not have the need to review the payment schedule, this step can be skipped.
### Confirm the updated contract
- [PATCH /partner/v3/shops{shopUuid}/contracts/{contractUuid}/versions/{versionUuid}/activate](https://docs.inbank.eu/api/partial-return-flow/other/patchnewversion.md): PATCH /partner/v3/shops/{shopUuid}/contracts/{contractUuid}/versions/{versionUuid}/activate
For the partial return to take effect, the updated contract needs to be confirmed. Please note, that after this request is sent, the updates will be instantly applied.
### Review the contract update history
- [GET /partner/v3/shops{shopUuid}/contracts/{contractUuid}/versions](https://docs.inbank.eu/api/partial-return-flow/other/getcontractversions.md): GET /partner/v3/shops/{shopUuid}/contracts/{contractUuid}/versions
The endpoint returns the change history for the contract, with UUIDS to the payment schedules and dates of the change.