Skip to main content
API docs by Redocly

Business Router API (v1)

Download OpenAPI specification:Download

API for force push of business events (v1.162.0)

Bypass

ForceWalletCreated

Force push of a business event message "WalletCreated" on business bus

Request Body schema:
required

Request containing the business event

walletId
string <uuid>

Wallet identifier

partnerKey
string or null

Partner key

taxId
string or null

Tax id of owner of wallet

firstName
string or null

Owner first name

lastName
string or null

Owner last name

phoneNumber
string or null

Owner phone number

email
string or null

Owner e-mail

creationDate
string <date-time>

Creation date of wallet

lastUpdateDate
string <date-time>

Last update of wallet

lastUsageDate
string or null <date-time>

Last usage of wallet

closureDate
string or null <date-time>

Date of closure of wallet

suspensionDate
string or null <date-time>

Date of suspension of wallet

reactivationDate
string or null <date-time>

Date of reactivation of wallet

originatingDealerKey
string or null

Responsible dealer for wallet creation

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "partnerKey": "string",
  • "taxId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "phoneNumber": "string",
  • "email": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "lastUpdateDate": "2019-08-24T14:15:22Z",
  • "lastUsageDate": "2019-08-24T14:15:22Z",
  • "closureDate": "2019-08-24T14:15:22Z",
  • "suspensionDate": "2019-08-24T14:15:22Z",
  • "reactivationDate": "2019-08-24T14:15:22Z",
  • "originatingDealerKey": "string",
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceWalletUpdated

Force push of a business event message "WalletUpdated" on business bus

Request Body schema:
required

Request containing the business event

walletId
string <uuid>

Wallet identifier

partnerKey
string or null

Partner key

taxId
string or null

Owner tax id

firstName
string or null

Owner first name

lastName
string or null

Owner last name

iban
string or null

Owner IBAN

phoneNumber
string or null

Owner phone number

email
string or null

Owner email

creationDate
string <date-time>

Creation date of wallet

closureDate
string or null <date-time>

Closure date of wallet

lastUpdateDate
string <date-time>

Last update of wallet

lastUsageDate
string or null <date-time>

Last usage of wallet

suspensionDate
string or null <date-time>

Date of suspension of wallet

reactivationDate
string or null <date-time>

Date of reactivation of wallet

originatingDealerKey
string or null

Responsible dealer for wallet creation

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "partnerKey": "string",
  • "taxId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "iban": "string",
  • "phoneNumber": "string",
  • "email": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "closureDate": "2019-08-24T14:15:22Z",
  • "lastUpdateDate": "2019-08-24T14:15:22Z",
  • "lastUsageDate": "2019-08-24T14:15:22Z",
  • "suspensionDate": "2019-08-24T14:15:22Z",
  • "reactivationDate": "2019-08-24T14:15:22Z",
  • "originatingDealerKey": "string",
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceWalletIbanDeleted

Force push of a business event message "IbanDeleted" on business bus

Request Body schema:
required

Request containing the business event

walletId
string <uuid>

Wallet identifier

partnerKey
string or null

Partner key

taxId
string or null

Owner tax id

firstName
string or null

Owner first name

lastName
string or null

Owner last name

phoneNumber
string or null

Owner phone number

email
string or null

Owner email

creationDate
string <date-time>

Creation date of wallet

lastUpdateDate
string <date-time>

Last update of wallet

lastUsageDate
string or null <date-time>

Last usage of wallet

closureDate
string or null <date-time>

Date of closure of wallet

suspensionDate
string or null <date-time>

Date of suspension of wallet

reactivationDate
string or null <date-time>

Date of reactivation of wallet

originatingDealerKey
string or null

Responsible dealer for wallet creation

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "partnerKey": "string",
  • "taxId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "phoneNumber": "string",
  • "email": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "lastUpdateDate": "2019-08-24T14:15:22Z",
  • "lastUsageDate": "2019-08-24T14:15:22Z",
  • "closureDate": "2019-08-24T14:15:22Z",
  • "suspensionDate": "2019-08-24T14:15:22Z",
  • "reactivationDate": "2019-08-24T14:15:22Z",
  • "originatingDealerKey": "string",
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceWalletAttributesUpdated

Force push of a business event message "WalletAttributesUpdated" on business bus

Request Body schema:
required

Request containing the business event

walletId
string <uuid>

Wallet identifier

partnerKey
string or null

Partner key

taxId
string or null

Tax id of owner of wallet

firstName
string or null

Owner first name

lastName
string or null

Owner last name

iban
string or null

Owner IBAN

phoneNumber
string or null

Owner phone number

email
string or null

Owner e-mail

creationDate
string <date-time>

Creation date of wallet

closureDate
string or null <date-time>

Closure date of wallet

lastUpdateDate
string <date-time>

Last update of wallet

lastUsageDate
string or null <date-time>

Last usage of wallet

suspensionDate
string or null <date-time>

Date of suspension of wallet

reactivationDate
string or null <date-time>

Date of reactivation of wallet

originatingDealerKey
string or null

Responsible dealer for wallet creation

addressStreet
string or null

Street of residence

addressNumber
string or null

Street number

zipCode
string or null

City postal code

city
string or null

City of residence

province
string or null

Province of residence

country
string or null

Country of residence

hasResidenceDataChanged
boolean

If true at least one residence data field was updated

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "partnerKey": "string",
  • "taxId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "iban": "string",
  • "phoneNumber": "string",
  • "email": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "closureDate": "2019-08-24T14:15:22Z",
  • "lastUpdateDate": "2019-08-24T14:15:22Z",
  • "lastUsageDate": "2019-08-24T14:15:22Z",
  • "suspensionDate": "2019-08-24T14:15:22Z",
  • "reactivationDate": "2019-08-24T14:15:22Z",
  • "originatingDealerKey": "string",
  • "addressStreet": "string",
  • "addressNumber": "string",
  • "zipCode": "string",
  • "city": "string",
  • "province": "string",
  • "country": "string",
  • "hasResidenceDataChanged": true,
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceTransactionConfirmed

Force push of a business event message "TransactionConfirmed" on business bus

Request Body schema:
required

Request containing the business event

partnerKey
required
string or null

Key of partner associated with transaction

dealerKey
required
string or null

Key of dealer associated with transaction

walletId
required
string <uuid>

Reference to wallet

storeId
required
string or null <uuid>

Optional identifier of store where transaction is executed

operationType
required
string or null

Type of operation (deposit, payment, fee, etc)

amount
required
number <double>

Amount of transaction

income
required
boolean

Is income operation ("true" => money that increment wallet amount, "false" => money that decrement)

operationId
required
string <uuid>

Identifier of operation (inside CoreWalleting) associated with current transaction

transactionId
required
integer <int64>

Transaction Id

transactionType
required
string or null

Type of operation (deposit, payment, fee, etc)

required
Array of objects or null (OperationFeeDto)

List of fees associated to the transaction

confirmationDate
required
string <date-time>

Date/time (UTC) of confirm of operation (ex. when a deposit is confirmed by customer)

initializationDate
required
string <date-time>
Deprecated

Date/time (UTC) of initialization of operation (ex. when a deposit is requested by customer)

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "partnerKey": "string",
  • "dealerKey": "string",
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "operationType": "string",
  • "amount": 0.1,
  • "income": true,
  • "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",
  • "transactionId": 0,
  • "transactionType": "string",
  • "fees": [
    ],
  • "confirmationDate": "2019-08-24T14:15:22Z",
  • "initializationDate": "2019-08-24T14:15:22Z",
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceTransactionCompleted

Force push of a business event message "TransactionCompleted" on business bus

Request Body schema:
required

Request containing the business event

completionDate
string <date-time>

Date/time (UTC) of completion of operation (ex. when a deposit is completed in core banking)

transferId
required
string or null

Identifier of transfer between the two "P1" accounts

transferCompletionDate
required
string or null <date>

Date (only) of Accounting when transfer is executed

transferCreditorAccountNumber
required
string or null
transferDebtorAccountNumber
required
string or null
transferTransactionReference
required
string or null
externalReference
required
string or null
Deprecated

External reference used for register P1 transaction on core banking

accountingId
required
string or null
Deprecated

Identifier of transaction on remote core banking (ex. when Temenos gives us its operation identifier that is completed on NTR)

accountBookingDate
required
string <date-time>
Deprecated

Date/time of accounting on core banking

accountId
required
string or null
Deprecated

AccountId of core banking (ex. Temenos) where this transaction is credited

creditAccountId
required
string or null
Deprecated

AccountId of core banking (ex. Temenos) where this transaction is credited

debitAccountId
required
string or null
Deprecated

AccountId of core banking (ex. Temenos) where this transaction is charged

accountingDate
required
string <date-time>
Deprecated

Date/time of accounting on core banking

accountValueDate
required
string <date-time>
Deprecated

Date/time of accounting on core banking

partnerKey
required
string or null

Key of partner associated with transaction

dealerKey
required
string or null

Key of dealer associated with transaction

walletId
required
string <uuid>

Reference to wallet

storeId
required
string or null <uuid>

Optional identifier of store where transaction is executed

operationType
required
string or null

Type of operation (deposit, payment, fee, etc)

amount
required
number <double>

Amount of transaction

income
required
boolean

Is income operation ("true" => money that increment wallet amount, "false" => money that decrement)

operationId
required
string <uuid>

Identifier of operation (inside CoreWalleting) associated with current transaction

transactionId
required
integer <int64>

Transaction Id

transactionType
required
string or null

Type of operation (deposit, payment, fee, etc)

required
Array of objects or null (OperationFeeDto)

List of fees associated to the transaction

confirmationDate
required
string <date-time>

Date/time (UTC) of confirm of operation (ex. when a deposit is confirmed by customer)

initializationDate
required
string <date-time>
Deprecated

Date/time (UTC) of initialization of operation (ex. when a deposit is requested by customer)

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "completionDate": "2019-08-24T14:15:22Z",
  • "transferId": "string",
  • "transferCompletionDate": "2019-08-24",
  • "transferCreditorAccountNumber": "string",
  • "transferDebtorAccountNumber": "string",
  • "transferTransactionReference": "string",
  • "externalReference": "string",
  • "accountingId": "string",
  • "accountBookingDate": "2019-08-24T14:15:22Z",
  • "accountId": "string",
  • "creditAccountId": "string",
  • "debitAccountId": "string",
  • "accountingDate": "2019-08-24T14:15:22Z",
  • "accountValueDate": "2019-08-24T14:15:22Z",
  • "partnerKey": "string",
  • "dealerKey": "string",
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "operationType": "string",
  • "amount": 0.1,
  • "income": true,
  • "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",
  • "transactionId": 0,
  • "transactionType": "string",
  • "fees": [
    ],
  • "confirmationDate": "2019-08-24T14:15:22Z",
  • "initializationDate": "2019-08-24T14:15:22Z",
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceStoreCreated

Force push of a business event message "StoreCreated" on business bus

Request Body schema:
required

Request containing the business event

storeId
string <uuid>

Store identifier

dealerKey
string or null

Dealer key

partnerKey
string or null

Partner key

name
string or null

Name of store

type
string or null

Store type

city
string or null

City where store is located

address
string or null

Address of store

accountId
string or null
Deprecated

Account id on core banking for store

ownerIban
string or null

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

ownerName
string or null

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

email
string or null

Email for contact store

phoneNumber
string or null

Phone number for contact store

code
string or null

Code of store (for external reference)

latitude
number or null <double>

Latitude of the store (optional)

longitude
number or null <double>

Longitude of the store (optional)

isActive
boolean

Is store active

creationDate
string <date-time>

Date/time of creation

lastUpdateDate
string <date-time>

Date/time of last update

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "dealerKey": "string",
  • "partnerKey": "string",
  • "name": "string",
  • "type": "string",
  • "city": "string",
  • "address": "string",
  • "accountId": "string",
  • "ownerIban": "string",
  • "ownerName": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "code": "string",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "isActive": true,
  • "creationDate": "2019-08-24T14:15:22Z",
  • "lastUpdateDate": "2019-08-24T14:15:22Z",
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceStoreUpdated

Force push of a business event message "StoreUpdated" on business bus

Request Body schema:
required

Request containing the business event

storeId
string <uuid>

Store identifier

dealerKey
string or null

Dealer key

partnerKey
string or null

Partner key

name
string or null

Name of store

type
string or null

Store type

city
string or null

City where store is located

address
string or null

Address of store

accountId
string or null
Deprecated

Account id on core banking for store

ownerIban
string or null

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

ownerName
string or null

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

email
string or null

Email for contact store

phoneNumber
string or null

Phone number for contact store

code
string or null

Code of store (for external reference)

latitude
number or null <double>

Latitude of the store (optional)

longitude
number or null <double>

Longitude of the store (optional)

isActive
boolean

Is store active

creationDate
string <date-time>

Date/time of creation

lastUpdateDate
string <date-time>

Date/time of last update

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "dealerKey": "string",
  • "partnerKey": "string",
  • "name": "string",
  • "type": "string",
  • "city": "string",
  • "address": "string",
  • "accountId": "string",
  • "ownerIban": "string",
  • "ownerName": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "code": "string",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "isActive": true,
  • "creationDate": "2019-08-24T14:15:22Z",
  • "lastUpdateDate": "2019-08-24T14:15:22Z",
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceStoreDeleted

Force push of a business event message "StoreDeleted" on business bus

Request Body schema:
required

Request containing the business event

storeId
string <uuid>

Store identifier

dealerKey
string or null

Dealer key

partnerKey
string or null

Partner key

name
string or null

Name of store

type
string or null

Store type

city
string or null

City where store is located

address
string or null

Address of store

accountId
string or null
Deprecated

Account id on core banking for store

ownerIban
string or null

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

ownerName
string or null

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

email
string or null

Email for contact store

phoneNumber
string or null

Phone number for contact store

code
string or null

Code of store (for external reference)

latitude
number or null <double>

Latitude of the store (optional)

longitude
number or null <double>

Longitude of the store (optional)

isActive
boolean

Is store active

creationDate
string <date-time>

Date/time of creation

lastUpdateDate
string <date-time>

Date/time of last update

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "dealerKey": "string",
  • "partnerKey": "string",
  • "name": "string",
  • "type": "string",
  • "city": "string",
  • "address": "string",
  • "accountId": "string",
  • "ownerIban": "string",
  • "ownerName": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "code": "string",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "isActive": true,
  • "creationDate": "2019-08-24T14:15:22Z",
  • "lastUpdateDate": "2019-08-24T14:15:22Z",
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceOperationGroupInitialized

Force push of a business event message "OperationGroupInitialized" on business bus

Request Body schema:
required

Request containing the business event

operationGroupId
string <uuid>

Operation group identifier

walletId
string <uuid>

Wallet identifier

partnerKey
string or null

Partner key

dealerKey
string or null

Dealer key

creationDate
string <date-time>

Date/time of creation

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "operationGroupId": "48e5fbc1-3ae3-4ebb-ba74-23a77d81c46b",
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "partnerKey": "string",
  • "dealerKey": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceOperationGroupConfirmed

Force push of a business event message "OperationGroupConfirmed" on business bus

Request Body schema:
required

Request containing the business event

operationGroupId
string <uuid>

Operation group identifier

walletId
string <uuid>

Wallet identifier

partnerKey
string or null

Partner key

dealerKey
string or null

Dealer key

creationDate
string <date-time>

Date/time of creation

confirmationDate
string <date-time>

Date/time of confirmation

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "operationGroupId": "48e5fbc1-3ae3-4ebb-ba74-23a77d81c46b",
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "partnerKey": "string",
  • "dealerKey": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "confirmationDate": "2019-08-24T14:15:22Z",
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceOperationGroupCancelled

Force push of a business event message "OperationGroupCancelled" on business bus

Request Body schema:
required

Request containing the business event

operationGroupId
string <uuid>

Operation group identifier

walletId
string <uuid>

Wallet identifier

partnerKey
string or null

Partner key

dealerKey
string or null

Dealer key

creationDate
string <date-time>

Date/time of creation

cancellationDate
string or null <date-time>

Date/time of cancellation

expiryDate
string or null <date-time>

Date/time of expiration

terminationDate
string or null <date-time>

Date/time of termination

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "operationGroupId": "48e5fbc1-3ae3-4ebb-ba74-23a77d81c46b",
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "partnerKey": "string",
  • "dealerKey": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "cancellationDate": "2019-08-24T14:15:22Z",
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "terminationDate": "2019-08-24T14:15:22Z",
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceWalletSuspended

Force push of a business event message "WalletSuspended" on business bus

Request Body schema:
required

Request containing the business event

walletId
string <uuid>

Wallet identifier

partnerKey
string or null

Partner key

taxId
string or null

Owner tax id

firstName
string or null

Owner first name

lastName
string or null

Owner last name

iban
string or null

Owner IBAN

phoneNumber
string or null

Owner phone number

email
string or null

Owner email

creationDate
string <date-time>

Creation date of wallet

lastUpdateDate
string <date-time>

Last update of wallet

lastUsageDate
string or null <date-time>

Last usage of wallet

closureDate
string or null <date-time>

Date of closure of wallet

suspensionDate
string or null <date-time>

Date of suspension of wallet

reactivationDate
string or null <date-time>

Date of reactivation of wallet

originatingDealerKey
string or null

Responsible dealer for wallet creation

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "partnerKey": "string",
  • "taxId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "iban": "string",
  • "phoneNumber": "string",
  • "email": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "lastUpdateDate": "2019-08-24T14:15:22Z",
  • "lastUsageDate": "2019-08-24T14:15:22Z",
  • "closureDate": "2019-08-24T14:15:22Z",
  • "suspensionDate": "2019-08-24T14:15:22Z",
  • "reactivationDate": "2019-08-24T14:15:22Z",
  • "originatingDealerKey": "string",
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceWalletReactivated

Force push of a business event message "WalletReactivated" on business bus

Request Body schema:
required

Request containing the business event

walletId
string <uuid>

Wallet identifier

partnerKey
string or null

Partner key

taxId
string or null

Owner tax id

firstName
string or null

Owner first name

lastName
string or null

Owner last name

iban
string or null

Owner IBAN

phoneNumber
string or null

Owner phone number

email
string or null

Owner email

creationDate
string <date-time>

Creation date of wallet

lastUpdateDate
string <date-time>

Last update of wallet

lastUsageDate
string or null <date-time>

Last usage of wallet

closureDate
string or null <date-time>

Date of closure of wallet

suspensionDate
string or null <date-time>

Date of suspension of wallet

reactivationDate
string or null <date-time>

Date of reactivation of wallet

originatingDealerKey
string or null

Responsible dealer for wallet creation

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "partnerKey": "string",
  • "taxId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "iban": "string",
  • "phoneNumber": "string",
  • "email": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "lastUpdateDate": "2019-08-24T14:15:22Z",
  • "lastUsageDate": "2019-08-24T14:15:22Z",
  • "closureDate": "2019-08-24T14:15:22Z",
  • "suspensionDate": "2019-08-24T14:15:22Z",
  • "reactivationDate": "2019-08-24T14:15:22Z",
  • "originatingDealerKey": "string",
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceWalletClosed

Force push of a business event message "WalletClosed" on business bus

Request Body schema:
required

Request containing the business event

walletId
string <uuid>

Wallet identifier

partnerKey
string or null

Partner key

taxId
string or null

Tax id of owner of wallet

firstName
string or null

Owner first name

lastName
string or null

Owner last name

iban
string or null

Owner IBAN

phoneNumber
string or null

Owner phone number

email
string or null

Owner e-mail

creationDate
string <date-time>

Creation date of wallet

closureDate
string or null <date-time>

Closure date of wallet

lastUpdateDate
string <date-time>

Last update of wallet

lastUsageDate
string or null <date-time>

Last usage of wallet

suspensionDate
string or null <date-time>

Date of suspension of wallet

reactivationDate
string or null <date-time>

Date of reactivation of wallet

originatingDealerKey
string or null

Responsible dealer for wallet creation

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "partnerKey": "string",
  • "taxId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "iban": "string",
  • "phoneNumber": "string",
  • "email": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "closureDate": "2019-08-24T14:15:22Z",
  • "lastUpdateDate": "2019-08-24T14:15:22Z",
  • "lastUsageDate": "2019-08-24T14:15:22Z",
  • "suspensionDate": "2019-08-24T14:15:22Z",
  • "reactivationDate": "2019-08-24T14:15:22Z",
  • "originatingDealerKey": "string",
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceWalletReopened

Force push of a business event message "WalletReopened" on business bus

Request Body schema:
required

Request containing the business event

walletId
string <uuid>

Wallet identifier

partnerKey
string or null

Partner key

taxId
string or null

Owner tax id

firstName
string or null

Owner first name

lastName
string or null

Owner last name

iban
string or null

Owner IBAN

phoneNumber
string or null

Owner phone number

email
string or null

Owner email

creationDate
string <date-time>

Creation date of wallet

lastUpdateDate
string <date-time>

Last update of wallet

lastUsageDate
string or null <date-time>

Last usage of wallet

closureDate
string or null <date-time>

Date of closure of wallet

suspensionDate
string or null <date-time>

Date of suspension of wallet

reopeningDate
string or null <date-time>

Date of reopening of wallet

originatingDealerKey
string or null

Responsible dealer for wallet creation

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "partnerKey": "string",
  • "taxId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "iban": "string",
  • "phoneNumber": "string",
  • "email": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "lastUpdateDate": "2019-08-24T14:15:22Z",
  • "lastUsageDate": "2019-08-24T14:15:22Z",
  • "closureDate": "2019-08-24T14:15:22Z",
  • "suspensionDate": "2019-08-24T14:15:22Z",
  • "reopeningDate": "2019-08-24T14:15:22Z",
  • "originatingDealerKey": "string",
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceWireTransferCompleted

Force push of a business event message "WireTransferCompleted" on business bus

Request Body schema:
required

Request containing the business event

partnerKey
string or null

Key of partner

dealerKey
string or null

Key of dealer

accountingId
string or null

Identifier of transaction on core banking

accountId
string or null

Account identier that is used to credit money (ex. "wallets account" in case of CashDeposit, "store account" in case of Payment, etc.)

endToEndReference
string or null

Identifier used to connect P1 operation with core banking movements of funds

completionDate
string <date-time>

Date/time of completion of move funds on core banking

debitCurrency
string or null

Currency used

beneficiaryIBAN
string or null

Credit IBAN

executionDate
string <date-time>

Date of execution of the payment

debitAccountId
string or null

Debit account

accountWithBankBIC
string or null

BIC of the credit IBAN

orderingCustomerBic
string or null

BIC of the ordering account

debitAccountIBAN
string or null

Debtor IBAN

beneficiaryName
string or null

Name associated to the credit IBAN

transactionAmount
string or null

Amount sent

paymentCurrency
string or null

Currency used for the payment

paymentOrderProductId
string or null

Product identifier associated to the payment

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "partnerKey": "string",
  • "dealerKey": "string",
  • "accountingId": "string",
  • "accountId": "string",
  • "endToEndReference": "string",
  • "completionDate": "2019-08-24T14:15:22Z",
  • "debitCurrency": "string",
  • "beneficiaryIBAN": "string",
  • "executionDate": "2019-08-24T14:15:22Z",
  • "debitAccountId": "string",
  • "accountWithBankBIC": "string",
  • "orderingCustomerBic": "string",
  • "debitAccountIBAN": "string",
  • "beneficiaryName": "string",
  • "transactionAmount": "string",
  • "paymentCurrency": "string",
  • "paymentOrderProductId": "string",
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceWireTransferFailed

Force push of a business event message "WireTransferFailed" on business bus

Request Body schema:
required

Request containing the business event

partnerKey
string or null

Key of partner

dealerKey
string or null

Key of dealer

endToEndReference
string or null

Identifier used to connect P1 operation with core banking movements of funds

beneficiaryIBAN
string or null

Credit IBAN

orderingCustomerBic
string or null

BIC of the ordering account

debitAccountIBAN
string or null

Debtor IBAN

beneficiaryName
string or null

Name associated to the credit IBAN

transactionAmount
number <double>

Amount sent

paymentCurrency
string or null

Currency used for the payment

statusCode
string
Enum: "Continue" "SwitchingProtocols" "Processing" "EarlyHints" "OK" "Created" "Accepted" "NonAuthoritativeInformation" "NoContent" "ResetContent" "PartialContent" "MultiStatus" "AlreadyReported" "IMUsed" "MultipleChoices" "MovedPermanently" "Found" "SeeOther" "NotModified" "UseProxy" "Unused" "RedirectKeepVerb" "PermanentRedirect" "BadRequest" "Unauthorized" "PaymentRequired" "Forbidden" "NotFound" "MethodNotAllowed" "NotAcceptable" "ProxyAuthenticationRequired" "RequestTimeout" "Conflict" "Gone" "LengthRequired" "PreconditionFailed" "RequestEntityTooLarge" "RequestUriTooLong" "UnsupportedMediaType" "RequestedRangeNotSatisfiable" "ExpectationFailed" "MisdirectedRequest" "UnprocessableEntity" "Locked" "FailedDependency" "UpgradeRequired" "PreconditionRequired" "TooManyRequests" "RequestHeaderFieldsTooLarge" "UnavailableForLegalReasons" "InternalServerError" "NotImplemented" "BadGateway" "ServiceUnavailable" "GatewayTimeout" "HttpVersionNotSupported" "VariantAlsoNegotiates" "InsufficientStorage" "LoopDetected" "NotExtended" "NetworkAuthenticationRequired"

Status code of the failed response

reasonPhrase
string or null

Reason of the failure as described by the Core Banking

failureDate
string <date-time>

Date of the failure

body
string or null

Raw body sent back from the Core Banking

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "partnerKey": "string",
  • "dealerKey": "string",
  • "endToEndReference": "string",
  • "beneficiaryIBAN": "string",
  • "orderingCustomerBic": "string",
  • "debitAccountIBAN": "string",
  • "beneficiaryName": "string",
  • "transactionAmount": 0.1,
  • "paymentCurrency": "string",
  • "statusCode": "Continue",
  • "reasonPhrase": "string",
  • "failureDate": "2019-08-24T14:15:22Z",
  • "body": "string",
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceOperationConfirmed

Force push of a business event message "OperationConfirmed" on business bus

Request Body schema:
required

Request containing the business event

partnerKey
string or null

Partner key

dealerKey
string or null

Dealer key

walletId
string <uuid>

Wallet identifier

operationId
string <uuid>

Unique identifier of operation

storeId
string or null <uuid>

Store (required only for operations in stores)

operationType
string or null

Type of operation

operationCreationDate
string <date-time>

Creation date of operation (required)

operationConfirmationDate
string <date-time>

Date/time of confirmation

operationGroupId
string or null <uuid>

Binding Operation Group Id

amount
number <double>

Amount of operation

Array of objects or null (OperationFeeDto)

List of applied fees (required)

walletAvailableBalance
number <double>

Available balance on wallet;

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "partnerKey": "string",
  • "dealerKey": "string",
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "operationType": "string",
  • "operationCreationDate": "2019-08-24T14:15:22Z",
  • "operationConfirmationDate": "2019-08-24T14:15:22Z",
  • "operationGroupId": "48e5fbc1-3ae3-4ebb-ba74-23a77d81c46b",
  • "amount": 0.1,
  • "fees": [
    ],
  • "walletAvailableBalance": 0.1,
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceOperationCancelled

Force push of a business event message "OperationCancelled" on business bus

Request Body schema:
required

Request containing the business event

partnerKey
string or null

Partner (required)

dealerKey
string or null

Dealer (required)

walletId
string <uuid>

Wallet (required)

storeId
string or null <uuid>

Store (required only for operations in stores)

operationId
string <uuid>

Unique identifier of operation (required)

operationType
string or null

Type of operation

amount
number <double>

Amount of operation (required)

Array of objects or null (OperationFeeDto)

List of applied fees

walletAvailableBalance
number <double>

Available balance on wallet;

operationGroupId
string or null <uuid>

Binding Operation Group Id

operationCreationDate
string <date-time>

Creation date of operation (required)

operationCancellationDate
string or null <date-time>

Date of cancellation

operationExpirationDate
string or null <date-time>

Date of expiration

operationTerminationDate
string or null <date-time>

Date of termination

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "partnerKey": "string",
  • "dealerKey": "string",
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",
  • "operationType": "string",
  • "amount": 0.1,
  • "fees": [
    ],
  • "walletAvailableBalance": 0.1,
  • "operationGroupId": "48e5fbc1-3ae3-4ebb-ba74-23a77d81c46b",
  • "operationCreationDate": "2019-08-24T14:15:22Z",
  • "operationCancellationDate": "2019-08-24T14:15:22Z",
  • "operationExpirationDate": "2019-08-24T14:15:22Z",
  • "operationTerminationDate": "2019-08-24T14:15:22Z",
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceOperationCompleted

Force push of a business event message "OperationCompleted" on business bus

Request Body schema:
required

Request containing the business event

partnerKey
string or null

Partner (required)

dealerKey
string or null

Dealer (required)

walletId
string <uuid>

Wallet (required)

storeId
string or null <uuid>

Store (required only for operations in stores)

walletAvailableBalance
number <double>

Available balance on wallet;

operationId
string <uuid>

Unique identifier of operation (required)

operationType
string or null

Type of operation

amount
number <double>

Amount of operation (required)

operationGroupId
string or null <uuid>

Binding Operation Group Id

operationCreationDate
string <date-time>

Creation date of operation (required)

operationCompletionDate
string or null <date-time>

Date of completion

Array of objects or null (OperationFeeDto)

List of applied fees

transferId
string or null

Identifier of transfer between the two "P1" accounts

transferCompletionDate
string or null <date>

Date (only) of Accounting when transfer is executed

outgoingPaymentId
string or null

Identifier of outgoing payment (if is available)

object or null

Custom tags to be used for other purposes. These tags are not predefined and can be set by the sender of the event. They can be used to include additional information about the operation that may be relevant for processing or analysis, such as categorization, source system, or any other metadata that does not fit into the predefined properties of the event.

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "partnerKey": "string",
  • "dealerKey": "string",
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "walletAvailableBalance": 0.1,
  • "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",
  • "operationType": "string",
  • "amount": 0.1,
  • "operationGroupId": "48e5fbc1-3ae3-4ebb-ba74-23a77d81c46b",
  • "operationCreationDate": "2019-08-24T14:15:22Z",
  • "operationCompletionDate": "2019-08-24T14:15:22Z",
  • "fees": [
    ],
  • "transferId": "string",
  • "transferCompletionDate": "2019-08-24",
  • "outgoingPaymentId": "string",
  • "tags": {
    },
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceOperationInitialized

Force push of a business event message "OperationInitialized" on business bus

Request Body schema:
required

Request containing the business event

partnerKey
string or null

Partner key

walletId
string <uuid>

Wallet id

operationId
string <uuid>

Operation id

operationType
string or null

Operation type

operationGroupId
string or null <uuid>

Operation group id

dealerKey
string or null

Dealer key

storeId
string or null <uuid>

Store id (optional)

amount
number <double>

Amount

operationCreationDate
string <date-time>

Creation date

Array of objects or null (OperationFeeDto)

Associated fees

externalIban
string or null

External IBAN for SCT and SDD operations

incomingReference
string or null

Incoming reference (SCT/SDD/Reconciliations)

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "partnerKey": "string",
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",
  • "operationType": "string",
  • "operationGroupId": "48e5fbc1-3ae3-4ebb-ba74-23a77d81c46b",
  • "dealerKey": "string",
  • "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",
  • "amount": 0.1,
  • "operationCreationDate": "2019-08-24T14:15:22Z",
  • "fees": [
    ],
  • "externalIban": "string",
  • "incomingReference": "string",
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceBucketCreated

Force push of a business event message "BucketCreated" on business bus

Request Body schema:
required

Request containing the business event

bucketId
string <uuid>

Bucket identifier

partnerKey
string or null

Partner key

walletId
string <uuid>

Wallet that owns the Bucket

availableBalance
number <double>

Available balance on the Bucket

creationDate
string <date-time>

Creation date

lastIncomingDate
string <date-time>

Date of last incoming amount (i.e. IN Operations) to the Bucket

lastOutgoingDate
string or null <date-time>

Date of last outgoing amount (i.e. OUT Operations) to the Bucket

isWithdrawable
boolean

Marks if the balance of the Bucket can be Withdrawn

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "bucketId": "1980377d-7926-47e0-9e64-a9d0c746404d",
  • "partnerKey": "string",
  • "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
  • "availableBalance": 0.1,
  • "creationDate": "2019-08-24T14:15:22Z",
  • "lastIncomingDate": "2019-08-24T14:15:22Z",
  • "lastOutgoingDate": "2019-08-24T14:15:22Z",
  • "isWithdrawable": true,
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceBankingEventReceived

Force push of a business event message "BankingEventReceived" on business bus

Request Body schema:
required

Request containing the business event

eventType
string
Enum: "IncomingSctStandard" "IncomingSctInstant" "IncomingReconciliation" "IncomingSdd"

Type of banking event that can be received

partnerKey
required
string or null

Partner key associated with event (could be null if partner was not identified)

required
object or null

Custom data

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "eventType": "IncomingSctStandard",
  • "partnerKey": "string",
  • "data": {
    },
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

ForceBankNotificationSendBackCompleted

Force push of a business event message "BankNotificationSendBackCompleted" on business bus

Request Body schema:
required

Request containing the business event

partnerKey
required
string or null

Partner key

bankNotificationId
required
string <uuid>

Bank notification id

creditorIban
required
string or null

Creditor IBAN on notification

creditorName
required
string or null

Creditor name on notification

debtorIban
required
string or null

Debtor IBAN on notification

debtorName
required
string or null

Debtor name on notification

amount
required
number <double>

Amount sent back

reason
required
string or null

Original reason on notification

messageVersion
integer <int32>

Version of current event message (ex. 1)

messagePublisher
string or null

Publisher name (ex. "P1")

id
string <uuid>
messageCreationDate
string <date-time>
messagePublishDate
string <date-time>
isLastRetry
boolean

Responses

Request samples

Content type
{
  • "partnerKey": "string",
  • "bankNotificationId": "7640ad94-efcd-4d56-a6ee-5a52bae50855",
  • "creditorIban": "string",
  • "creditorName": "string",
  • "debtorIban": "string",
  • "debtorName": "string",
  • "amount": 0.1,
  • "reason": "string",
  • "messageVersion": 0,
  • "messagePublisher": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "messageCreationDate": "2019-08-24T14:15:22Z",
  • "messagePublishDate": "2019-08-24T14:15:22Z",
  • "isLastRetry": true
}

Response samples

Content type
{
  • "errorCode": "string",
  • "errorDescription": "string",
  • "errorProperties": {
    }
}

Diagnostics

GetDiagnosticsInfo

Get current platform diagnostics data

Responses

Response samples

Content type
{
  • "applicationName": "string",
  • "applicationVersion": "string",
  • "environment": "string",
  • "properties": {
    }
}