Skip to main content
API docs by Redocly

Partner Management API (v1)

Download OpenAPI specification:Download

API for manage partners, dealers and stores (v1.162.0)

Dealers

GetAllDealers

Returns a list containing all available Dealers to the Partner

Responses

Response samples

Content type
[
  • {
    }
]

GetDealer

Returns a specific Dealer to the Partner

path Parameters
dealerKey
required
string

Key that identifies the specific Dealer

Responses

Response samples

Content type
{
  • "key": "string",
  • "name": "string"
}

GetAllStores

Returns a list of Stores for a specific Dealer of the Partner

path Parameters
dealerKey
required
string

Key that identifies the specific Dealer

query Parameters
pageSize
integer <int32>
Default: 50

Size of the page

pageNumber
integer <int32>
Default: 0

Number of page (0-based)

Responses

Response samples

Content type
{
  • "totalCount": 0,
  • "limitCount": 0,
  • "items": [
    ]
}

CreateStore

Adds a new Store for a specific Dealer of the Partner

path Parameters
dealerKey
required
string

Key that identifies the specific Dealer

Request Body schema:
required

Request containing the Store information

name
required
string non-empty

Name of the store

type
string or null <= 255 characters

store tipology

city
required
string non-empty

City where the store is located

address
required
string non-empty

Address of the store

ownerIban
string or null <= 255 characters

IBAN that belongs to the owner of the store (the one that will receive the store funds)

ownerName
string or null <= 255 characters

Name that belongs to the owner of the store (the one that will receive the store funds)

email
required
string non-empty ^(?!.*\.\.)(?!.*\+$)[a-zA-Z0-9!#$%&'*\/=?^_`{...

Email address

phoneNumber
required
string non-empty

Phone number

code
required
string non-empty

Code of the store. (Optional)

Must be unique for the composed key Partner-Dealer.

latitude
number or null <double>

Latitude of the store (optional)

longitude
number or null <double>

Longitude of the store (optional)

object or null

Store metadata

Responses

Request samples

Content type
{
  • "name": "string",
  • "type": "string",
  • "city": "string",
  • "address": "string",
  • "ownerIban": "string",
  • "ownerName": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "code": "string",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "metadata": {
    }
}

Response samples

Content type
{
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "dealerKey": "string",
  • "partnerKey": "string",
  • "name": "string",
  • "type": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "city": "string",
  • "address": "string",
  • "accountId": "string",
  • "ownerIban": "string",
  • "ownerName": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "code": "string",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "isActive": true,
  • "lastUpdateDate": "2019-08-24T14:15:22Z",
  • "metadata": {
    }
}

GetStore

Returns a specific Store for a specific Dealer of the Partner

path Parameters
dealerKey
required
string

Key that identifies the specific Dealer

storeId
required
string <uuid>

Store identifier

Responses

Response samples

Content type
{
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "dealerKey": "string",
  • "partnerKey": "string",
  • "name": "string",
  • "type": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "city": "string",
  • "address": "string",
  • "accountId": "string",
  • "ownerIban": "string",
  • "ownerName": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "code": "string",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "isActive": true,
  • "lastUpdateDate": "2019-08-24T14:15:22Z",
  • "metadata": {
    }
}

UpdateStore

Updates a Store of a specific Dealer

path Parameters
dealerKey
required
string

Key that identifies the specific Dealer

storeId
required
string <uuid>

Identifier of the Store to update

Request Body schema:
required

Request containing the Store information to update

name
required
string non-empty

Name of the store

type
string or null <= 255 characters

Store typology

city
required
string non-empty

City where the store is located

address
required
string non-empty

Address of the store

ownerIban
string or null <= 255 characters

IBAN that belongs to the owner of the store (the one that will receive the store funds)

ownerName
string or null <= 255 characters

Name that belongs to the owner of the store (the one that will receive the store funds)

email
required
string non-empty ^(?!.*\.\.)(?!.*\+$)[a-zA-Z0-9!#$%&'*\/=?^_`{...

Email address

phoneNumber
required
string non-empty

Phone number

code
required
string non-empty

Code of the store. (Optional)

Must be unique for the composed key Partner-Dealer.

latitude
number or null <double>

Latitude of the store (optional)

longitude
number or null <double>

Longitude of the store (optional)

isActive
required
boolean

Is this an active store?

object or null

Store metadata

Responses

Request samples

Content type
{
  • "name": "string",
  • "type": "string",
  • "city": "string",
  • "address": "string",
  • "ownerIban": "string",
  • "ownerName": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "code": "string",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "isActive": true,
  • "metadata": {
    }
}

Response samples

Content type
{
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "dealerKey": "string",
  • "partnerKey": "string",
  • "name": "string",
  • "type": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "city": "string",
  • "address": "string",
  • "accountId": "string",
  • "ownerIban": "string",
  • "ownerName": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "code": "string",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "isActive": true,
  • "lastUpdateDate": "2019-08-24T14:15:22Z",
  • "metadata": {
    }
}

DeleteStore

Deletes a Store of a specific Dealer

path Parameters
dealerKey
required
string

Key that identifies the specific Dealer

storeId
required
string <uuid>

Identifier of the Store to delete

Responses

Response samples

Content type
{
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "dealerKey": "string",
  • "partnerKey": "string",
  • "name": "string",
  • "type": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "city": "string",
  • "address": "string",
  • "accountId": "string",
  • "ownerIban": "string",
  • "ownerName": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "code": "string",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "isActive": true,
  • "lastUpdateDate": "2019-08-24T14:15:22Z",
  • "metadata": {
    }
}

GetStoreByCode

Returns a specific store using dealer and code for a partner

path Parameters
dealerKey
required
string

Key that identifies the specific Dealer

code
required
string

Store code

Responses

Response samples

Content type
{
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "dealerKey": "string",
  • "partnerKey": "string",
  • "name": "string",
  • "type": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "city": "string",
  • "address": "string",
  • "accountId": "string",
  • "ownerIban": "string",
  • "ownerName": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "code": "string",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "isActive": true,
  • "lastUpdateDate": "2019-08-24T14:15:22Z",
  • "metadata": {
    }
}

CreateStoreMandate

Updates a Store of a specific Dealer

path Parameters
dealerKey
required
string

Key that identifies the specific Dealer

storeId
required
string <uuid>

Identifier of the Store to update

Responses

Response samples

Content type
{
  • "mandateId": "d4dbf0da-b5aa-43ae-b9db-c2aff331d3ad",
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "type": "string",
  • "partnerKey": "string",
  • "mandateUniqueReference": "string",
  • "debtorName": "string",
  • "debtorIban": "string",
  • "amount": 0.1,
  • "frequency": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "fillDate": "2019-08-24T14:15:22Z",
  • "activationRequestDate": "2019-08-24T14:15:22Z",
  • "activationDate": "2019-08-24T14:15:22Z",
  • "disableRequestDate": "2019-08-24T14:15:22Z",
  • "disabledDate": "2019-08-24T14:15:22Z",
  • "rejectionDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "nextDepositRequestDate": "2019-08-24",
  • "lastDepositRequestedDate": "2019-08-24T14:15:22Z",
  • "addressStreet": "string",
  • "city": "string",
  • "lastError": "string",
  • "lastFailureDate": "2019-08-24T14:15:22Z",
  • "nextDepositDate": "2019-08-24",
  • "lastDepositDate": "2019-08-24T14:15:22Z"
}

GetStoreWalletingMandate

Get information about the current (if present) Mmandate on specific store

path Parameters
dealerKey
required
string

Key that identifies the specific Dealer

storeId
required
string <uuid>

Store identifier

Responses

Response samples

Content type
{
  • "mandateId": "d4dbf0da-b5aa-43ae-b9db-c2aff331d3ad",
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "type": "string",
  • "partnerKey": "string",
  • "mandateUniqueReference": "string",
  • "debtorName": "string",
  • "debtorIban": "string",
  • "amount": 0.1,
  • "frequency": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "fillDate": "2019-08-24T14:15:22Z",
  • "activationRequestDate": "2019-08-24T14:15:22Z",
  • "activationDate": "2019-08-24T14:15:22Z",
  • "disableRequestDate": "2019-08-24T14:15:22Z",
  • "disabledDate": "2019-08-24T14:15:22Z",
  • "rejectionDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "nextDepositRequestDate": "2019-08-24",
  • "lastDepositRequestedDate": "2019-08-24T14:15:22Z",
  • "addressStreet": "string",
  • "city": "string",
  • "lastError": "string",
  • "lastFailureDate": "2019-08-24T14:15:22Z",
  • "nextDepositDate": "2019-08-24",
  • "lastDepositDate": "2019-08-24T14:15:22Z"
}

GetStoresByIds

Returns a list of Stores using their id

Request Body schema:
required
Array
string <uuid>

Responses

Request samples

Content type
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

Content type
[
  • {
    }
]

Partners

GetAllPartners

Returns a list containing all available partners

Responses

Response samples

Content type
[
  • {
    }
]