Appearance
Introduction
Operations stand for banking operations originating from or targeting a Wallet (i.e., Card Transactions, Payins, Payouts, and Transfers) and their refunds. Each Operation summarizes the initial transaction with read-only information such as the nature, status, amount, origin, and destination.
Therefore, you may use Operations as a single source of information. They are what end users generally expect to see as a table or timeline when they log into their bank website/app.
Tip – Operations are available in CSV format
You can also export the information using the Reports feature.
Available operations (operationType
)
The operationType
attribute allows you to identify what kind of banking operation is concerned.
The following types are available:
operationType | Initial operation |
---|---|
bankDirectDebit | SEPA Direct Debit (SDD) |
bankTransfer | SEPA Transfer |
cardTopup | Incoming funds from Card |
cardTransaction | Outgoing Card payment |
check | Check |
creditNote | Wallet-to-wallet Transfers with a transferTypeId value of 4 . Such transfers allow you to handle reimbursement of charges. |
fees | Wallet-to-wallet Transfers with a transferTypeId value of 3 . Such transfers allow you to debit fees from end users wallets. They are identified as such in Account Statements. |
instantBankTransfer | Instant SEPA Transfer |
walletTransfer | Wallet-to-wallet Transfers |
Key attributes
Below are a few of the most important attributes.
Attribute | Type | Description |
---|---|---|
operationType | string | The type of bank operation, providing functional context about the initial operation. |
initialFlow | string | Provides technical context about the initial operation: payin , payinRefund , payout , payoutRefund , transfer , cardTransaction , chargeback . You can fetch the initial operation by making the corresponding request (using the objectId as a path parameter). |
amount | integer | The amount of the operation in cents (e.g., 100 stands for 1) |
walletId | integer | The unique identifier of the wallet associated with the operation. |
direction | string | Direction of the operation, which can either be:
|
objectId | string | The unique identifier of the object the operation relates to (e.g., the initial cardTransaction ). |
label | string | Information that you can expose to your end users. The label content differs depending on the context. |
metadata | object | Details about the initial operation. |
status | string | The status of the operation, which can be: AUTHORIZED DECLINED SETTLED CANCELED |
creation | string | The date and time at which the object the operation relates to was created. Format: RFC3339 standard. |
settlement | string | The date and time at which the object the operation relates to was settled on the Wallet. Format: RFC3339 standard. |
Swagger – Refer to endpoint documentation
For a complete list of Operation attributes, check the Operations endpoint in the Swagger.
Metadata
The metadata
object contains key information regarding the initial operation. This content differs depending on the operation.
Transfers
json
"metadata": {
"receiverId": "string", // Deprecated on Oct. 2024
"creditorWalletId": "string",
"creditorFirstName":"string", // Encrypted if cryptography is activated
"creditorLastName":"string", // Encrypted if cryptography is activated
"creditorLegalName":"string", // Encrypted if cryptography is activated
"creditorWalletEventName": "string",
"emitterId": "string", // Deprecated on Oct. 2024
"debtorWalletId": "string",
"debtorFirstName":"string", // Encrypted if cryptography is activated
"debtorLastName":"string", // Encrypted if cryptography is activated
"debtorLegalName":"string", // Encrypted if cryptography is activated
"debtorWalletEventName": "string",
"tag": "string || null",
"label": "string || null",
"codeStatus": "string",
"informationStatus": "string || null",
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
json
"metadata": {
"receiverId": "string",
"emitterId": "string",
"tag": "string",
"label": "string",
"codeStatus": "string",
"informationStatus": "string"
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
Card Transactions
json
"metadata": {
"maskedPan": "519872******4839", // Encrypted if cryptography is activated
"mcc": {
"code": 123456,
},
"mid": {
"value": "3256", // MerchantId, Encrypted if cryptography is activated
"name": "Merchant Name", // MerchantName, Encrypted if cryptography is activated
"city": "", // MerchantCity, Encrypted if cryptography is activated
"country": "",
"address": null
},
"localAmount": {
"amount": 1790,
"currency": "978"
},
"authorizationNote": "", // Encrypted if cryptography is activated
"authorisationResponseCode": {
"action": "Approved",
"description": "APPROVED",
"value": 08
},
"paymentLifeCycle": [ // for each Cardtransactions::PaymentStatus = S
{
"authorizationIssuerTime": "2024-04-16 08:23:20",
"valueDate": "string",
"paymentAmount": 0,
"paymentLocalAmount": 0,
"paymentCurrency": "string"
}
],
"paymentCountry": "FRA",
"cardId": "999997173",
"is3DS":"0",
"3dsExemptionType":"string || null",
"optimizedMerchantName":"string || null",
"merchantLogo":"string || null",
"merchantCategory":"string || null",
"transactionSubtype":"string || null",
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
json
"metadata": {
"mcc": {
"code": 12,
},
"mid": {
"value": "1231542UR",
"name": "string",
"city": "string",
"country": "string",
"address": "string"
},
"cardId": "string",
"localAmount": {
"amount": 100,
"currency": "DT"
},
"authorizationNote": "You spent too much money",
"authorizationResponseCode": {
"action": "string",
"description": "string",
"value": "string"
},
"paymentLifeCycle": [ // for each Cardtransactions::PaymentStatus = S
{
"authorizationIssuerTime": "string",
"valueDate": "string",
"paymentAmount": 0,
"paymentLocalAmount": 0,
"paymentCurrency": "string"
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
Payins
json
"metadata": {
"payinId": "string",
"payinTag": "string || null", // Encrypted if cryptography is activated
"messageToUser": "string || null", // Encrypted if cryptography is activated
"codeStatus": "string",
"informationStatus": "string || null",
"ibanFullName": "string || null",
"dbtrIBAN": "******1319", // Encrypted if cryptography is activated
"ibanTxEndToEndId": "string || null",
"mandateId": "string || null",
"debtorName": "string || null",
"uniqueMandateReference": "string || null",
"additionalData": ["string"], // Encrypted if cryptography is activated
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
json
"metadata": {
"messageToUser": "string",
"codeStatus": "string",
"informationStatus": "string",
"payinTag": "string",
"additionalData": "string",
"ibanFullname": "string", // SCT only
"dbtrIBAN": "string", // SCT only
"ibanTxEndToEndId": "string", // SCT only
"mandateId": "string" // SDD only
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
PayinRefunds
json
"metadata": {
"payinId": "string",
"payinTag": "string || null", // Encrypted if cryptography is activated
"messageToUser": "string || null", // Encrypted if cryptography is activated
"codeStatus": "string",
"informationStatus": "string || null",
"ibanFullName": "string || null",
"dbtrIBAN": "string || null", // Encrypted if cryptography is activated
"ibanTxEndToEndId": "string || null",
"mandateId": "string || null",
"debtorName": "string || null",
"uniqueMandateReference": "string || null",
"reasonTms":"string || null",
"additionalData": ["string"] // Encrypted if cryptography is activated
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
json
"metadata": {
"payinId": "string",
"codeStatus": "string",
"informationStatus": "string",
"reasonTms": "string",
}
1
2
3
4
5
6
2
3
4
5
6
Payouts
json
"metadata": {
"payoutTag": "string || null",
"beneficiaryId": "string",
"beneficiaryName": "string || null",
"label": "string || null",
"codeStatus": "string",
"informationStatus": "string || null",
"supportingFileLink": "string || null",
"reasonCode": "string || null",
"reasonDescription": "string || null",
"endToEndId": "string || null", // SCT only
"uniqueMandateReference": "string || null" // SDD only
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
json
"metadata": {
"payoutTag": "string",
"beneficiaryId": "string",
"label": "string",
"codeStatus": "string",
"informationStatus": "string",
"supportingFileLink": "string",
"uniqueMandateReference": "string", // SDD only
"endToEndId":"string", // SCT only
"reasonCode": "string",
"reasonDescription": "string"
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
PayoutRefunds
json
"metadata": {
"payoutId": "string || null",
"tag": "string || null",
"beneficiaryName": "string || null",
"label": "string || null",
"codeStatus": "string",
"informationStatus": "string || null",
"requestComment": "string || null",
"reasonCode": "string || null",
"refundDate": "string || null",
"refundComment": "string || null",
"endToEndId": "string || null", // SCT only
"uniqueMandateReference": "string || null" // SDD only
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
json
"metadata": {
"tag": "string",
"codeStatus": "string",
"informationStatus": "string",
"requestComment": "string",
"reasonCode": "string",
"refundDate": "string",
"refundComment": "string"
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
Chargebacks
Chargebacks of card top up payins.
json
"metadata": {
"payinId" : "string",
"payinTag": "string || null", // Encrypted if cryptography is activated
"payinrefundId": "string",
"additionalData": "string", // Encrypted if cryptography is activated
"chargebackReason": "string",
"transactionReference":"string"
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
json
"metadata": {
"payinId" : "string",
"payinrefundId": "string",
"transactionReference":"string"
}
1
2
3
4
5
2
3
4
5
Labels
You can expose the label
field values to your end users to provide more information.
The information displayed depends on the context and the table below relies on the latest version of the Operations feature.
Context | Exposed data | String example |
---|---|---|
Card Top Up | Indicates the name of the cardholder, along with the masked PAN of the card. | Alex Oak 553896XXXXXX8893 |
Cancelled Card Top Up | Indicates the name of the cardholder, along with the masked PAN of the card. | Alex Oak 553896XXXXXX8893 |
Chargeback on Card Top Up | Indicates the name of the cardholder and the card masked PAN. | Alex Oak 553896XXXXXX8893 |
Bank Transfer (Payin) | Indicates the IBAN full name, along with the messageToUser (custom field). | Alex Oak messageToUserExample |
Refund of Bank Transfer (Payin) | Indicates the IBAN full name, along with the messageToUser (custom field). | Alex Oak messageToUserExample |
Bank Transfer (Payout) | Indicates the Beneficiary name, along with the Payout label . | |
Refund of Bank Transfer (Payout) | Indicates the Beneficiary name, along with the Payout label . | |
Bank Direct Debit (Payin) | Indicates the debtor's name, along with the messageToUser (custom field), and the Unique Mandate Reference. | |
Refund of Bank Direct Debit (Payin) | Indicates the debtor's name, along with the messageToUser (custom field), and the Unique Mandate Reference. | |
Bank Direct Debit (Payout) | Indicates the Beneficiary name, the Payout label , and the Unique Mandate Reference. | Alex Oak rlabel96 UMR: 65c32b8dc64xx |
Refund of Bank Direct Debit (Payout) | Indicates the Beneficiary name, the Payout label , and the Unique Mandate Reference. | Alex Oak rlabel96 UMR: 65c32b8dc64xx |
Check | Indicates the user's name, along with the messageToUser (custom field), and the CMC7 A. | |
Refund of a Check | Indicates the user's name, along with the messageToUser (custom field), and the CMC7 A. | |
Transfer (wallet-to-wallet) | Indicates the user's name, along with the transfer label . | messageToUserExample Alex Oak |
Transfer (if fees or creditNote ) | Indicates the Transfer label (custom field). | |
Card Transaction | Indicates the merchant's name and the masked PAN. If the currency of the transaction differs from the Wallet currency, also indicates the paymentLocalAmount . | Tree Cie(978 91.78) Card 734837******9403 |
Operation object
json
{
"operationType": "bankTransfer",
"initialFlow": "payout",
"amount": {
"amount": 6300,
"currency": "EUR",
},
"walletId": 630632,
"direction": "DEBIT",
"objectId": "408265455",
"label": "Theo West Virement de M Alex Oak",
"metadata": {
"payoutTag": "VO - 1234554321",
"beneficiaryId": "404897",
"label": "Virement de M Alex Oak",
"codeStatus": "140005",
"informationStatus": "",
"supportingFileLink": "",
},
"status": "AUTHORIZED",
"date": {
"creation": "2023-08-19T06:08:23+02:00",
"settlement": null
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
Endpoints
Endpoint | Scope |
---|---|
/core-connect/operations Search Operations | read_only |
/core-connect/operations/{walletId}/report Create a Report | read_only |
/core-connect/operations/{walletId}/report Get a Report | read_only |
/simulation/operations Simulate operations | read_write |