Operations
Alert – The Operation object will change soon
Operations v2 is available in Sandbox only, introducing a change in structure for the Operation object. If you have any doubts about how to migrate, contact your Treezor Account Manager.
Retrieve operations
When requesting a list of operations, the following query parameters are required:
walletId
– Restrict to operations related to that walletdateTo
– Restrict to operations posterior to that datedateFrom
– Restrict to operations anterior to that date
Note – 3-month timeframe support
The dateTo
and dateFrom
fields must be less than 3 months apart.
To get the list of operations, use the following request (which supports cursor-based pagination). The dates are to be html encoded (e.g., 2024-01-11T11:25:36+01:00 becomes 2024-01-11T11:25:36%2B01:00
).
bash
curl -X GET {baseUrl}/core-connect/operations?walletId={walletId}&dateFrom={dateFrom}&dateTo={dateTo} \
--header 'Authorization: Bearer {accessToken}' \
Here is an example of a response. It returns an array of Operation objects along with a cursor and sorted by creation date.
json
{
"cursor": {
"prev": null,
"current": null,
"next": null
},
"data": [
{
"amount": {
"amount": 1000,
"currency": "EUR"
},
"walletId": 2647244,
"operationType": "bankDirectDebit",
"direction": "DEBIT",
"status": "SETTLED",
"objectId": "181212",
"label": "Alex Oak rlabel96 UMR: 65c32b8dc64xx",
"metadata": {
"payoutTag": "65c32b8dc64xx|lFCS7WW4OugijXXX",
"beneficiaryId": "429387",
"label": "rlabel96",
"codeStatus": "160005",
"informationStatus": "Remboursement par virement Validé",
"uniqueMandateReference": "65c32b8dc64xx",
"supportingFileLink": "",
"reasonCode": null,
"reasonDescription": null
},
"date": {
"creation": "2024-02-07T08:04:48+01:00",
"settlement": "2024-02-07T00:00:00+01:00"
},
"initialFlow": "payout"
}
]
}
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",
}
json
"metadata": {
"receiverId": "string",
"emitterId": "string",
"tag": "string",
"label": "string",
"codeStatus": "string",
"informationStatus": "string"
}
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",
}
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"
}
]
}
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
}
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
}
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
}
json
"metadata": {
"payinId": "string",
"codeStatus": "string",
"informationStatus": "string",
"reasonTms": "string",
}
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
}
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"
}
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
}
json
"metadata": {
"tag": "string",
"codeStatus": "string",
"informationStatus": "string",
"requestComment": "string",
"reasonCode": "string",
"refundDate": "string",
"refundComment": "string"
}
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"
}
json
"metadata": {
"payinId" : "string",
"payinrefundId": "string",
"transactionReference":"string"
}
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. | |
Cancelled Card Top Up | Indicates the type of operation, along with the top up label. | |
Chargeback on Card Top Up | Indicates the name of the cardholder and the card masked PAN. | Alex Oak 545454******5454 |
Bank Transfer | Indicates the IBAN full name, along with the messageToUser (custom field). | |
Bank Direct Debit (Payin) | ||
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 | ||
Check | Indicates the user's name, along with the messageToUser (custom field), and the CMC7 A. | |
Refund of a Check | ||
Transfer (wallet-to-wallet) | Indicates the name of the Wallet owner along with the operation id . | Alex Oak (65852369) |
Transfer (if fees or creditNote ) | Indicates the Transfer label (custom field). | |
Card Transaction |