Skip to main content
API docs by Redocly

Operations API (v1)

Download OpenAPI specification:Download

API for cash deposit, payment, cash withdrawal, etc. (v1.0.154)

CashDeposits

InitializeCashDeposit

Initializes a cash deposit operation on specified wallet

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

Request Body schema:
required

Request with operation details

idempotencyKey
required
string = 32 characters

Idempotency key used to avoid double queue of a single operation (in case of retries)

amount
required
number <double> > 0

Total original amount of cash deposit operation. NOTE: fees will be subtracted from this amount (ex: customer deposits 100 eur cash, and 2 eur of fees are applyed, then 98 eur will be charged on customer's wallet)

storeId
required
string <uuid> non-empty

Identifier of store where cash deposit is executed

operationGroupId
required
string or null <uuid>

Binding Operation Group Id

required
object

Tags for extra data on operations

Responses

Request samples

Content type
{
  • "idempotencyKey": "stringstringstringstringstringst",
  • "amount": 0.1,
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "operationGroupId": "48e5fbc1-3ae3-4ebb-ba74-23a77d81c46b",
  • "tags": {
    }
}

Response samples

Content type
No sample

ConfirmCashDeposit

Confirms a cash deposit operation using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

operationId
required
string <uuid>

Operation to confirm

Responses

Response samples

Content type
No sample

CancelCashDeposit

Cancels a cash deposit operation using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

operationId
required
string <uuid>

Operation to cancel

Responses

Response samples

Content type
No sample

TerminateCashDeposit

Terminates a cash deposit operation using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

operationId
required
string <uuid>

Operation to terminate

Responses

Response samples

Content type
No sample

SimulateCashDeposit

Simulates a cash deposit operation on wallet and retuns applied fees and final amounts

path Parameters
walletId
required
string <uuid>

Wallet where operation is simulated

Request Body schema:
required

Data for simulation

amount
number <double> > 0

Total original amount of cash deposit operation. NOTE: fees will be subtracted from this amount (ex: customer deposits 100 eur cash, and 2 eur of fees are applyed, then 98 eur will be charged on customer's wallet)

storeId
required
string <uuid> non-empty

Identifier of store where cash deposit is executed

Responses

Request samples

Content type
{
  • "amount": 0.1,
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c"
}

Response samples

Content type
No sample

CashWithdrawals

InitializeCashWithdrawal

Initializes a cash withdrawal operation on specified wallet

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

Request Body schema:
required

Request with operation details

idempotencyKey
required
string = 32 characters

Idempotency key used to avoid double queue of a single operation (in case of retries)

amount
number <double> > 0

Total original amount of cash withdrawal operation. NOTE: fees will be added to this amount (ex: customer withdraws 50 eur cash, and 2 eur of fees are applyed, then 52 eur will be subtracted from customer's wallet)

storeId
required
string <uuid> non-empty

Identifier of store where cash withdrawal is executed

operationGroupId
string or null <uuid>

Binding Operation Group Id

Responses

Request samples

Content type
{
  • "idempotencyKey": "stringstringstringstringstringst",
  • "amount": 0.1,
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "operationGroupId": "48e5fbc1-3ae3-4ebb-ba74-23a77d81c46b"
}

Response samples

Content type
No sample

ConfirmCashWithdrawal

Confirms a withdrawal operation using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

operationId
required
string <uuid>

Operation to confirm

Responses

Response samples

Content type
No sample

CancelCashWithdrawal

Cancels a withdrawal operation using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

operationId
required
string <uuid>

Operation to cancel

Responses

Response samples

Content type
No sample

TerminateCashWithdrawal

Terminates a withdrawal operation using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

operationId
required
string <uuid>

Operation to Terminate

Responses

Response samples

Content type
No sample

SimulateCashWithdrawal

Simulates a cash withdrawal operation on wallet and returns applied fees and final amounts

path Parameters
walletId
required
string <uuid>

Wallet where operation is simulated

Request Body schema:
required

Data for simulation

amount
number <double> > 0

Total original amount of cash withdrawal operation. NOTE: fees will be added to this amount (ex: customer withdraws 50 eur cash, and 2 eur of fees are applyed, then 52 eur will be subtracted from customer's wallet)

storeId
required
string <uuid> non-empty

Identifier of store where cash withdrawal is executed

Responses

Request samples

Content type
{
  • "amount": 0.1,
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c"
}

Response samples

Content type
No sample

LoyaltyDeposits

InitializeLoyaltyDeposit

Initializes a loyalty deposit operation on specified wallet

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

Request Body schema:
required

Request with operation details

idempotencyKey
required
string = 32 characters

Idempotency key used to avoid double queue of a single operation (in case of retries)

amount
required
number <double> > 0

Total original amount of loyalty deposit operation. NOTE: fees will be subtracted from this amount (ex: customer deposits 100 eur cash, and 2 eur of fees are applyed, then 98 eur will be charged on customer's wallet)

storeId
required
string <uuid> non-empty

StoreId associated to the payment

operationGroupId
required
string or null <uuid>

Binding Operation Group Id

required
object

Tags for extra data on operations

Responses

Request samples

Content type
{
  • "idempotencyKey": "stringstringstringstringstringst",
  • "amount": 0.1,
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "operationGroupId": "48e5fbc1-3ae3-4ebb-ba74-23a77d81c46b",
  • "tags": {
    }
}

Response samples

Content type
No sample

ConfirmLoyaltyDeposit

Confirms a loyalty deposit operation using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

operationId
required
string <uuid>

Operation to confirm

Responses

Response samples

Content type
No sample

CancelLoyaltyDeposit

Cancels a loyalty deposit operation using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

operationId
required
string <uuid>

Operation to cancel

Responses

Response samples

Content type
No sample

TerminateLoyaltyDeposit

Terminates a loyalty deposit operation using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

operationId
required
string <uuid>

Operation to terminate

Responses

Response samples

Content type
No sample

SimulateLoyaltyDeposit

Simulates a loyalty deposit operation on wallet and retuns applied fees and final amounts

path Parameters
walletId
required
string <uuid>

Wallet where operation is simulated

Request Body schema:
required

Data for simulation

amount
number <double> > 0

Total original amount of loyalty deposit operation. NOTE: fees will be subtracted from this amount (ex: customer deposits 100 eur cash, and 2 eur of fees are applyed, then 98 eur will be charged on customer's wallet)

storeId
required
string <uuid> non-empty

StoreId associated to the simulated operation

Responses

Request samples

Content type
{
  • "amount": 0.1,
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c"
}

Response samples

Content type
No sample

OnlineToIssuer

ExecutePayment

Execute payment operation on specified wallet

Request Body schema:
required

Request with operation details

idempotencyKey
required
string non-empty
amount
number <double> > 0
walletId
required
string <uuid> non-empty
storeId
required
string <uuid> non-empty
object or null

Responses

Request samples

Content type
{
  • "idempotencyKey": "string",
  • "amount": 0.1,
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "metadata": {
    }
}

Response samples

Content type
No sample

OperationGroups

GetPendingOperationGroup

Gets the pending Operation Group (if any) on provided wallet

path Parameters
walletId
required
string <uuid>

Wallet identifier

Responses

Response samples

Content type
No sample

GetWalletOperationGroups

Get paginated operation groups available on provided wallet

path Parameters
walletId
required
string <uuid>

Wallet identifier

query Parameters
fromDate
string <date-time>

From date range filter

toDate
string <date-time>

To date range filter

pageSize
integer <int32>
Default: 50

Number of Transactions per page

pageNumber
integer <int32>
Default: 0

Zero-based page number

Responses

Response samples

Content type
No sample

GetWalletOperationGroupDetails

Get the selected OperationGroup with its details

path Parameters
walletId
required
string <uuid>

Wallet identifier

operationGroupId
required
string <uuid>

OperationGroup identifier

Responses

Response samples

Content type
No sample

InitializeOperationGroup

Initialize Operation Group on provided wallet

path Parameters
walletId
required
string <uuid>

Wallet identifier

Request Body schema:
required

Request with operation details

idempotencyKey
required
string = 32 characters

Idempotency key used to avoid double queue of a single operation (in case of retries)

Responses

Request samples

Content type
{
  • "idempotencyKey": "stringstringstringstringstringst"
}

Response samples

Content type
No sample

ConfirmOperationGroup

Confirms the given Operation Group on provided wallet

path Parameters
walletId
required
string <uuid>

Wallet identifier

operationGroupId
required
string <uuid>

Operation group identifier

Responses

Response samples

Content type
No sample

CancelOperationGroup

Cancels the given Operation Group on provided wallet

path Parameters
walletId
required
string <uuid>

Wallet identifier

operationGroupId
required
string <uuid>

Operation group identifier

Responses

Response samples

Content type
No sample

Operations

GetOperationTypes

Return the list of the valid types

Responses

Response samples

Content type
No sample

GetOperationById

Gets an operation by id

path Parameters
walletId
required
string <uuid>

Identifier of the wallet

operationId
required
string <uuid>

Identifies of the wallet

Responses

Response samples

Content type
No sample

GetWalletOperationStates

Get list of possible states of Wallet Operations.

Responses

Response samples

Content type
No sample

GetPartnerOperations

Gets paginated operations by partner

query Parameters
fromDate
string <date-time>

From date range filter

toDate
string <date-time>

To date range filter

pageSize
integer <int32>
Default: 50

Number of Transactions per page

pageNumber
integer <int32>
Default: 0

Zero-based page number

operationType
string

(Optional) filter for a given operation type

operationStatus
string

(Optional) filter for a given operation status ("Pending", "Confirmed", "Completed", "Expired", "Terminated" and "Cancelled")

Responses

Response samples

Content type
No sample

CountPartnerOperations

Get count of operations available on partner

query Parameters
fromDate
string <date-time>

From date range filter

toDate
string <date-time>

To date range filter

operationType
string

(Optional) filter for a given operation type

operationStatus
string

(Optional) filter for a given operation status

Responses

Response samples

Content type
No sample

GetPartnerOperationsByTags

Gets an operation by Tags and Type. NOTE: All tags specified must be contained in the Operation

query Parameters
fromDate
string <date-time>

From date range filter

toDate
string <date-time>

To date range filter

pageSize
integer <int32>
Default: 50

Number of Transactions per page

pageNumber
integer <int32>
Default: 0

Zero-based page number

operationType
string

(Optional) filter for a given operation type

operationStatus
string

(Optional) filter for a given operation status

Request Body schema:
required

Request containging Tags

required
object

Operation tags for storing extra information

property name*
additional property
string or null

Responses

Request samples

Content type
{
  • "tags": {
    }
}

Response samples

Content type
No sample

CountPartnerOperationsByTags

Counts total operations with all specified tags on partner. NOTE: All tags specified must be contained in the Operation

query Parameters
fromDate
string <date-time>

From date range filter

toDate
string <date-time>

To date range filter

operationType
string

(Optional) filter for a given operation type

operationStatus
string

(Optional) filter for a given operation status

Request Body schema:
required

Request containging Tags

required
object

Operation tags for storing extra information

property name*
additional property
string or null

Responses

Request samples

Content type
{
  • "tags": {
    }
}

Response samples

Content type
No sample

GetPartnerOperationsByBankNotification

Gets paginated operations by partner associated to a given BankNotification

query Parameters
bankNotificationId
required
string <uuid>

(Required) BankNotification identifier

fromDate
string <date-time>

From date range filter

toDate
string <date-time>

To date range filter

pageSize
integer <int32>
Default: 50

Number of Transactions per page

pageNumber
integer <int32>
Default: 0

Zero-based page number

operationType
string

(Optional) filter for a given operation type

operationStatus
string

(Optional) filter for a given operation status ("Pending", "Confirmed", "Completed", "Expired", "Terminated" and "Cancelled")

Responses

Response samples

Content type
No sample

CountPartnerOperationsByBankNotification

Counts operations by partner associated to a given BankNotification

query Parameters
bankNotificationId
required
string <uuid>

(Required) BankNotification identifier

fromDate
string <date-time>

From date range filter

toDate
string <date-time>

To date range filter

operationType
string

(Optional) filter for a given operation type

operationStatus
string

(Optional) filter for a given operation status ("Pending", "Confirmed", "Completed", "Expired", "Terminated" and "Cancelled")

Responses

Response samples

Content type
No sample

SearchOperations

Gets paginated operations by partner containing the specified metadata.

Request Body schema:
required

Requests contining metadata to search

required
object

Operation Metadata

property name*
additional property
any or null

Responses

Request samples

Content type
{
  • "metadata": {
    }
}

Response samples

Content type
No sample

GetDealerOperations

Gets paginated operations by dealer

path Parameters
dealerKey
required
string

Identifier of the dealer

query Parameters
fromDate
string <date-time>

From date range filter

toDate
string <date-time>

To date range filter

pageSize
integer <int32>
Default: 50

Number of Transactions per page

pageNumber
integer <int32>
Default: 0

Zero-based page number

operationType
string

(Optional) filter for operation type

operationStatus
string

(Optional) filter for operation status

Responses

Response samples

Content type
No sample

CountDealerOperations

Get count of operations available for a dealer

path Parameters
dealerKey
required
string

Dealer identifier

query Parameters
fromDate
string <date-time>

From date range filter

toDate
string <date-time>

To date range filter

operationType
string

(Optional) filter for a given operation type

operationStatus
string

(Optional) filter for operation status

Responses

Response samples

Content type
No sample

GetWalletOperations

Get paginated operations available on provided wallet

path Parameters
walletId
required
string <uuid>

Wallet identifier

query Parameters
fromDate
string <date-time>

From date range filter

toDate
string <date-time>

To date range filter

pageSize
integer <int32>
Default: 50

Number of Transactions per page

pageNumber
integer <int32>
Default: 0

Zero-based page number

operationType
string

(Optional) filter for a given operation type

operationStatus
string

(Optional) filter for operation status

Responses

Response samples

Content type
No sample

CountWalletOperations

Get count of operations on a provided wallet

path Parameters
walletId
required
string <uuid>

Wallet identifier

query Parameters
fromDate
string <date-time>

From date range filter

toDate
string <date-time>

To date range filter

operationType
string

(Optional) filter for a given operation type

operationStatus
string

(Optional) filter for operation status

Responses

Response samples

Content type
No sample

GetStoreOperations

Get paginated operations available on provided store

path Parameters
storeId
required
string <uuid>

Store identifier

query Parameters
fromDate
string <date-time>

From date range filter

toDate
string <date-time>

To date range filter

pageSize
integer <int32>
Default: 50

Number of Transactions per page

pageNumber
integer <int32>
Default: 0

Zero-based page number

operationType
string

(Optional) filter for a given operation type

operationStatus
string

(Optional) filter for operation status

Responses

Response samples

Content type
No sample

CountStoreOperations

Get count of operations on a provided store

path Parameters
storeId
required
string <uuid>

Store identifier

query Parameters
fromDate
string <date-time>

From date range filter

toDate
string <date-time>

To date range filter

operationType
string

(Optional) filter for a given operation type

operationStatus
string

(Optional) filter for operation status

Responses

Response samples

Content type
No sample

GetStoreOperationSummaryOperations

Get the total amount of operations completed or confirmed grouped by status and reconciliationcode for a given store and operation type

path Parameters
storeId
required
string <uuid>

Store identifier

query Parameters
fromDate
string <date-time>

From date range filter

toDate
string <date-time>

To date range filter

operationType
required
string

Filter for a given operation type

Responses

Response samples

Content type
No sample

GetPartnerOperationsOverview

Gets an overview of operations (total items, min/max date), sliced by type and status

Responses

Response samples

Content type
No sample

Payments

InitializePayment

Initializes a payment operation on specified wallet

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

Request Body schema:
required

Request with operation details

idempotencyKey
required
string = 32 characters

Idempotency key used to avoid double queue of a single operation (in case of retries)

amount
number <double> > 0

Total amount of payment operation. NOTE: fees will be added to this amount when the payment is completed (ex: customer buys groceries for 80 eur. From his wallet will be subtracted 81 eur, because 1 eur of fees are applyed)

storeId
required
string <uuid> non-empty

Identifier of store where payment is executed

operationGroupId
string or null <uuid>

Binding Operation Group Id

Responses

Request samples

Content type
{
  • "idempotencyKey": "stringstringstringstringstringst",
  • "amount": 0.1,
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "operationGroupId": "48e5fbc1-3ae3-4ebb-ba74-23a77d81c46b"
}

Response samples

Content type
No sample

ConfirmPayment

Confirms a payment operation using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

operationId
required
string <uuid>

Operation to confirm

Responses

Response samples

Content type
No sample

CancelPayment

Cancels a payment operation using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

operationId
required
string <uuid>

Operation to cancel

Responses

Response samples

Content type
No sample

TerminatePayment

Terminates a payment operation using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

operationId
required
string <uuid>

Operation to Terminate

Responses

Response samples

Content type
No sample

SimulatePayment

Simulates a payment operation on wallet and retuns applied fees and final amounts

path Parameters
walletId
required
string <uuid>

Wallet where operation is simulated

Request Body schema:
required

Data for simulation

amount
number <double> > 0

Total amount of payment operation. NOTE: fees will be added to this amount when the payment is completed (ex: customer buys groceries for 80 eur. From his wallet will be subtracted 81 eur, because 1 eur of fees are applyed)

storeId
required
string <uuid> non-empty

Identifier of store where cash deposit is executed

Responses

Request samples

Content type
{
  • "amount": 0.1,
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c"
}

Response samples

Content type
No sample

RemainderDeposits

InitializeRemainderDeposit

Initializes a remainder deposit operation on specified wallet

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

Request Body schema:
required

Request with operation details

amount
required
number <double> > 0

Total original amount of cash deposit operation. NOTE: fees will be subtracted from this amount (ex: customer deposits 100 eur cash, and 2 eur of fees are applyed, then 98 eur will be charged on customer's wallet)

idempotencyKey
required
string = 32 characters

Idempotency key used to avoid double queue of a single operation (in case of retries)

storeId
required
string <uuid> non-empty

Identifier of store where cash deposit is executed

operationGroupId
required
string or null <uuid>

Binding Operation Group Id

required
object

Tags for extra data on operations

Responses

Request samples

Content type
{
  • "amount": 0.1,
  • "idempotencyKey": "stringstringstringstringstringst",
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "operationGroupId": "48e5fbc1-3ae3-4ebb-ba74-23a77d81c46b",
  • "tags": {
    }
}

Response samples

Content type
No sample

ConfirmRemainderDeposit

Confirms a remainder deposit operation using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

operationId
required
string <uuid>

Operation to confirm

Responses

Response samples

Content type
No sample

CancelRemainderDeposit

Cancels a remainder deposit operation using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

operationId
required
string <uuid>

Operation to cancel

Responses

Response samples

Content type
No sample

TerminateRemainderDeposit

Terminates a remainder deposit operation using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

operationId
required
string <uuid>

Operation to terminate

Responses

Response samples

Content type
No sample

SimulateRemainderDeposit

Simulates a remainder deposit operation on wallet and returns applied fees and final amounts

path Parameters
walletId
required
string <uuid>

Wallet where operation is simulated

Request Body schema:
required

Data for simulation

amount
number <double> > 0

Total original amount of remainder deposit operation.

storeId
required
string <uuid> non-empty

Identifier of store where remainder deposit is executed

Responses

Request samples

Content type
{
  • "amount": 0.1,
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c"
}

Response samples

Content type
No sample

SctWithdrawals

InitializeSctWithdrawal

Initializes a sct withdrawal operation on specified wallet

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

Request Body schema:
required

Request with operation details

idempotencyKey
required
string = 32 characters

Idempotency key used to avoid double queue of a single operation (in case of retries)

amount
number <double> > 0

Total original amount of sct withdrawal operation. NOTE: fees will be added to this amount (ex: customer withdraws 50 eur sct, and 2 eur of fees are applyed, then 52 eur will be subtracted from customer's wallet)

Responses

Request samples

Content type
{
  • "idempotencyKey": "stringstringstringstringstringst",
  • "amount": 0.1
}

Response samples

Content type
No sample

ConfirmSctWithdrawal

Confirms a withdrawal operation using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

operationId
required
string <uuid>

Operation to confirm

Responses

Response samples

Content type
No sample

CancelSctWithdrawal

Cancels a withdrawal operation using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

operationId
required
string <uuid>

Operation to cancel

Responses

Response samples

Content type
No sample

TerminateSctWithdrawal

Terminates a withdrawal operation using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

operationId
required
string <uuid>

Operation to terminate

Responses

Response samples

Content type
No sample

SimulateSctWithdrawal

Simulates a sct withdrawal operation on wallet and returns applied fees and final amounts

path Parameters
walletId
required
string <uuid>

Wallet where operation is simulated

Request Body schema:
required

Data for simulation

amount
number <double> > 0

Total original amount of sct withdrawal operation. NOTE: fees will be added to this amount (ex: customer withdraws 50 eur sct, and 2 eur of fees are applyed, then 52 eur will be subtracted from customer's wallet)

Responses

Request samples

Content type
{
  • "amount": 0.1
}

Response samples

Content type
No sample

Sdd

GetSedaMandate

Get information about the current (if present) SEDA mandate on specific wallet

path Parameters
walletId
required
string <uuid>

Wallet identifier

Responses

Response samples

Content type
No sample

InitializeSedaMandate

Initializes a new SEDA mandate for provided wallet

path Parameters
walletId
required
string <uuid>

Wallet identifier

Request Body schema:
required

Request for create mandate document

amount
number <double> [ 10 .. 250 ]

Amount requested for mandate

frequency
string or null

Frequency of request of money (Weekly/Monthly)

Responses

Request samples

Content type
{
  • "amount": 10,
  • "frequency": "string"
}

Response samples

Content type
No sample

DisableSedaMandate

Disables a SEDA mandate active on provided wallet or cancels it if it was never requested activation.

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

Responses

Response samples

Content type
No sample

GetSedaMandateById

Gets information about a specific SEDA mandate using its identifier

path Parameters
sedaMandateId
required
string <uuid>

Mandate identifier

Responses

Response samples

Content type
No sample

GetSedaMandates

Gets list of SEDA mandates given the provided filters

query Parameters
fromDate
string <date-time>

(Optional default 90 days ago) from date filter

toDate
string <date-time>

(Optional default now) to date filter

status
string

(Optional) status filter

walletId
string <uuid>

(Optional) Wallet identifier filter

pageSize
integer <int32>
Default: 50

(Optional default 50) page size filter

pageNumber
integer <int32>
Default: 0

(Optional default 0) page number filter

Responses

Response samples

Content type
No sample

FillSedaMandateDocument

Fills the Pdf file for SEDA Mandate with Mandate and Wallet data

path Parameters
walletId
required
string <uuid>

Wallet identifier

Responses

Response samples

Content type
No sample

SignSedaMandateDocument

Signs the Pdf file for SEDA Mandate and requests activation

path Parameters
walletId
required
string <uuid>

Wallet identifier

Responses

Response samples

Content type
No sample

GetSedaMandateDocument

Gets the Pdf file for the current SEDA Mandate

path Parameters
walletId
required
string <uuid>

Wallet identifier

Responses

Response samples

Content type
No sample

UpdateSedaMandateDepositDate

Updates the next deposit date for the active SEDA Mandate associated to the Wallet.

To avoid requesting a deposit too early only dates AFTER the currently scheduled deposit date are considered valid.

path Parameters
walletId
required
string <uuid>

Wallet identifier

newDepositDate
required
string <date>

New deposit date for the next deposit (cannot be Saturday or Sunday)

Responses

Response samples

Content type
No sample

GetSedaMandateStates

Get list of possible states of SedaMandate

Responses

Response samples

Content type
No sample

WelfareDeposits

InitializeWelfareDeposit

Initializes a welfare deposit operation on specified wallet

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

Request Body schema:
required

Request with operation details

dealerKey
required
string non-empty

Dealer identifier

idempotencyKey
required
string = 32 characters

Idempotency key used to avoid double queue of a single operation (in case of retries)

amount
required
number <double> > 0

Total original amount of loyalty deposit operation. NOTE: fees will be subtracted from this amount (ex: customer deposits 100 eur cash, and 2 eur of fees are applyed, then 98 eur will be charged on customer's wallet)

required
object

Operation tags for storing extra information

Responses

Request samples

Content type
{
  • "dealerKey": "string",
  • "idempotencyKey": "stringstringstringstringstringst",
  • "amount": 0.1,
  • "tags": {
    }
}

Response samples

Content type
No sample

ConfirmWelfareDeposit

Confirms a welfare deposit operation using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

operationId
required
string <uuid>

Operation to confirm

Responses

Response samples

Content type
No sample

CancelWelfareDeposit

Cancels a welfare deposit operation using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

operationId
required
string <uuid>

Operation to cancel

Responses

Response samples

Content type
No sample

TerminateWelfareDeposit

Terminates a welfare deposit operation using provided identifier

path Parameters
walletId
required
string <uuid>

Wallet where operation is initialized

operationId
required
string <uuid>

Operation to terminate

Responses

Response samples

Content type
No sample

SimulateWelfareDeposit

Simulates a welfare deposit operation on wallet and returns applied fees and final amounts

path Parameters
walletId
required
string <uuid>

Wallet where operation is simulated

Request Body schema:
required

Data for simulation

amount
number <double> > 0

Total original amount of welfare deposit operation. NOTE: fees may be subtracted from this amount (ex: customer deposits 100 eur cash, and 2 eur of fees are applyed, then 98 eur will be charged on customer's wallet)

dealerKey
required
string non-empty

DealerKey of the Welfare deposit

object or null

Operation tags for storing extra information

Responses

Request samples

Content type
{
  • "amount": 0.1,
  • "dealerKey": "string",
  • "tags": {
    }
}

Response samples

Content type
No sample