Transactions
"Transactions" represent the financial operations linked to the registrations in your environment (payments, refunds, cancellations). They are named "transactions" in the API. |  |
Transaction: transaction/get
 | Retrieves information about a transaction in your environment. |
Request
Example of request call content for information on a transaction:
{
"id": "I2Oa5s9JDCGvE7BtvUfxrg%3d%3d"
}Field descriptions
Name | Required | Comments/description |
| id | X | Unique identifier of the transaction. |
Response
Example of response call content for information on a transaction:
{
"id": "I2Oa5s9JDCGvE7BtvUfxrg%3d%3d",
"billingID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"billingReferenceNumber": 123,
"billingFamily" : 1,
"transactionDate": "2025-11-11T13:05:29.963",
"priceName": "Tarif public",
"currency": "cdn",
"basePrice": 50.0,
"subscribeDiscountPercent": 10.0,
"lotPurchaseDiscountPercent": 0.0,
"quantity": 1,
"totalPrice": 52.49,
"paymentMethodID": 5,
"paymentMethodType": 0,
"transactionType": 1,
"comment": "Mon commentaire",
"onlineTransactionID": "mtp198yt",
"billToName": "Fraise Laframboise",
"billingAddress": "690, Saint-Joseph Est",
"billingAddress2": "bur. 400",
"billingPostalCode": "G1K 3B9",
"billingCity": "Quebec",
"billingCountryID": 37,
"billingStateID": 11,
"balance": 0.0,
"authorizationStatus": 0,
"paymentStatus": 0,
"billingType": 1,
"userID": "RXsZEdyhO7LrjXr1%2bw1ySQ%3d%3d",
"providerId": "RXsZEdyhO7LrjXr1%2bw1ySQ%3d%3d",
"workspaceId": "RXsZEdyhO7LrjXr1%2bw1ySQ%3d%3d",
"workspaceInstanceId": "RXsZEdyhO7LrjXr1%2bw1ySQ%3d%3d",
"cohortId": "0ZmJHkU8UY9k2si1sOPcGg%3d%3d",
"programId": "0ZmJHkU8UY9k2si1sOPcGg%3d%3d",
"onlinePaymentType": "",
"taxes": {"TPS":2.5,"TVQ":4.99},
"promoCodes":
[
{
"id": "O%2f9dsKKECyJSUWkOK37D8g%3d%3d",
"amount": 32.1
}
] ,
"shoppingCartTransactionID": "",
"isExternal": false,
"paymentTransactionID": "V3nIrMZqmh"
}Field descriptions
Name | Comments/description |
id | Unique identifier of the transaction. A transaction is linked to a registration (billingID). |
billingID | Unique identifier of the registration. A registration (billing) is potentially linked to several transactions. |
billingReferenceNumber | The reference number of the invoice issued for this transaction. |
| billingFamily | Specifies which component of the system the registration concerns:
|
transactionDate | Date on which the transaction was made. (String type YYYY-MM-DDTHH:MM:SSZ) |
priceName | Name of the price used to carry out the transaction. (String type, between 5 and 250 characters) |
currency | Currency used to carry out the transaction (String type). |
basePrice | Amount before taxes. (Number type) |
subscribeDiscountPercent | Discount percentage applied to the transaction. (Number type) |
| lotPurchaseDiscountPercent | Bulk purchase discount percentage applied to the transaction. (Number type) |
| quantity | Quantity of seats purchased. (Number type) |
totalPrice | Total amount including taxes and the discount or discounts. (Number type) |
paymentMethodID | Identifier of the payment method of the transaction. (Number type) |
paymentMethodType | Payment type of the transaction. (Number type)
|
transactionType | Type of the transaction (Number type)
|
comment | Administrative note left on the transaction. (String type) |
onlineTransactionID | Unique identifier of the online transaction (electronic payment provider). (String type) |
| billToName | "Bill to name" field on the billing address. (String type) |
billingAddress | Line 1 of the billing address. (String type) |
billingAddress2 | Line 2 of the billing address. (String type) |
billingPostalCode | Postal code of the transaction address (String type) |
billingCity | City of the transaction address (String type) |
billingCountryID | Country of the transaction address – Number type (See Appendix 3: Countries and States/Provinces) |
billingStateID | State or province of the transaction address – Number type (See Appendix 3: Countries and States/Provinces) |
balance | Balance of the registration (Number type) |
authorizationStatus | Enum AuthorizationStatus:
|
paymentStatus | Enum PaymentStatus:
|
billingType | Enum BillingType :
|
userID | Identifier of the user associated with the transaction (String type) |
providerId | Identifier of the service provider associated with the transaction (String type) |
workspaceId | Identifier of the course associated with the transaction (String type) |
workspaceInstanceId | Identifier of the session associated with the transaction (String type) |
cohortId | Unique identifier of the cohort (String type) |
| programId | Unique identifier of the learning program (String type) |
onlinePaymentType | Returned by the payment system, for example Moneris or Braintree. See the possible card values in the table below. |
isExternal | Indicates whether it is a refund that took place in another system (Boolean type) |
taxes | (Taxes applied to the transaction) List of taxes |
promoCodes | (Promo codes applied to the transaction) List of promo codes |
| shoppingCartTransactionID | In the case of a cart with several items, this is the identifier of the "master" transaction that groups the various registrations and on which the actual transaction was made with the payment connector. |
| paymentTransactionID | The identifier of the payment transaction from which a registration or a shopping cart containing several registrations originates. |
Transaction: transaction/getlist
 | Retrieves information about a list of transactions in your environment. |
Request
Example of request call content for information on a list of transactions:
{
"filterDate": "2018-08-01T00:00:00Z",
"filterDateMax": "2018-08-29T00:00:00Z",
"filterTransactionType": 2
}IMPORTANT: The method requires dates in UTC since the conversion is done on the server side. A maximum of 1000 transactions will be returned for a request exceeding one day.
Field descriptions
| Name | Required | Comments/description |
| filterDate | X | Start date of the period. The call will return all the transactions made after that moment. (String type YYYY-MM-DDTHH:MM:SSZ) |
| filterDateMax | End date of the period. Will be replaced by the current date if not provided. (String type YYYY-MM-DDTHH:MM:SSZ) | |
| filterTransactionType | Returns only the transactions of the specified type. See the possible values of the transactionType field in the field descriptions of the response. (Number type) |
Response
Example of response call content for information on a list of transactions:
[
{
"id": "V3nIrMZqmh",
"billingID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"billingReferenceNumber": 123,
"billingFamily" : 1,
"transactionDate": "2016-11-11T13:05:29.963",
"priceName": "Prix 2(membre)",
"currency": "cdn",
"basePrice": 50.0,
"subscribeDiscountPercent": 10.0,
"lotPurchaseDiscountPercent": 0.0,
"quantity": 1,
"totalPrice": 52.49,
"paymentMethodID": 5,
"paymentMethodType": 0,
"transactionType": 1,
"comment": "Un commentaire",
"onlineTransactionID": "mtp198yt",
"billToName": "Joann Test 101",
"billingAddress": "690, Saint-Joseph Est",
"billingAddress2": "",
"billingPostalCode": "G1K 3B9",
"billingCity": "Quebec",
"billingCountryID": 37,
"billingStateID": 11,
"balance": 0.0,
"authorizationStatus": 0,
"paymentStatus": 0,
"billingType": 1,
"userID": "RXsZEdyhO7LrjXr1%2bw1ySQ%3d%3d",
"providerId": "RXsZEdyhO7LrjXr1%2bw1ySQ%3d%3d",
"workspaceId": "RXsZEdyhO7LrjXr1%2bw1ySQ%3d%3d",
"workspaceInstanceId": "RXsZEdyhO7LrjXr1%2bw1ySQ%3d%3d",
"cohortId": "0ZmJHkU8UY9k2si1sOPcGg%3d%3d",
"programId": "0ZmJHkU8UY9k2si1sOPcGg%3d%3d",
"onlinePaymentType": "",
"taxes": {"TPS":2.5,"TVQ":4.99},
"promoCodes":
[
{
"id": "O%2f9dsKKECyJSUWkOK37D8g%3d%3d",
"amount": 32.1
}
] ,
"shoppingCartTransactionID": "",
"isExternal": false,
"paymentTransactionID": "V3nIrMZqmh"
},
{...}
]Field descriptions
Each element of the list contains the following fields:
Name | Comments/description |
id | Unique identifier of the transaction. A transaction is linked to a registration (billingID). |
billingID | Unique identifier of the registration. A registration (billing) is potentially linked to several transactions. |
billingReferenceNumber | The reference number of the invoice issued for this transaction. |
| billingFamily | Specifies which component of the system the registration concerns:
|
transactionDate | Date on which the transaction was made. (String type YYYY-MM-DDTHH:MM:SSZ) |
priceName | Name of the price used to carry out the transaction. (String type, between 5 and 250 characters) |
currency | Currency used to carry out the transaction (String type). |
basePrice | Amount before taxes. (Number type) |
subscribeDiscountPercent | Discount percentage applied to the transaction. (Number type) |
| lotPurchaseDiscountPercent | Bulk purchase discount percentage applied to the transaction. (Number type) |
| quantity | Quantity of seats purchased. (Number type) |
totalPrice | Total amount including taxes and the discount or discounts. (Number type) |
paymentMethodID | Identifier of the payment method of the transaction. (Number type) |
paymentMethodType | Payment type of the transaction. (Number type)
|
transactionType | Type of the transaction (Number type)
|
comment | Administrative note left on the transaction. (String type) |
onlineTransactionID | Unique identifier of the online transaction (electronic payment provider). (String type) |
| billToName | "Bill to name" field on the billing address. (String type) |
billingAddress | Line 1 of the billing address. (String type) |
billingAddress2 | Line 2 of the billing address. (String type) |
billingPostalCode | Postal code of the transaction address (String type) |
billingCity | City of the transaction address (String type) |
billingCountryID | Country of the transaction address – Number type (See Appendix 3: Countries and States/Provinces) |
billingStateID | State or province of the transaction address – Number type (See Appendix 3: Countries and States/Provinces) |
balance | Balance of the registration (Number type) |
authorizationStatus | Enum AuthorizationStatus:
|
paymentStatus | Enum PaymentStatus:
|
billingType | Enum BillingType :
|
userID | Identifier of the user associated with the transaction (String type) |
providerId | Identifier of the service provider associated with the transaction (String type) |
workspaceId | Identifier of the course associated with the transaction (String type) |
workspaceInstanceId | Identifier of the session associated with the transaction (String type) |
cohortId | Unique identifier of the cohort (String type) |
| programId | Unique identifier of the learning program (String type) |
onlinePaymentType | Returned by the payment system, for example Moneris or Braintree. See the possible card values in the table below. |
isExternal | Indicates whether it is a refund that took place in another system (Boolean type) |
taxes | (Taxes applied to the transaction) List of taxes |
promoCodes | (Promo codes applied to the transaction) List of promo codes |
| shoppingCartTransactionID | In the case of a cart with several items, this is the identifier of the "master" transaction that groups the various registrations and on which the actual transaction was made with the payment connector. |
| paymentTransactionID | The identifier of the payment transaction from which a registration or a shopping cart containing several registrations originates. |
Card type values supported by the payment connectors (onlinePaymentType)
Name | Card types and their codes |
Moneris | M = Mastercard V = Visa AX = American Express DC = Diners Card NO = Novus / Discover SE = Sears |
Paysafe | AM = American Express |
Braintree | “American Express” “Carte Blanche” “China UnionPay” “Discover” “Elo” “JCB” “Laser” “Maestro” “MasterCard” “Solo” “Switch” “Visa” “Unknown” |
Global Payments | VISA = Visa MC = MasterCard AMEX = American Express DINERS = Diners DISCOVER = Discover JCB = JCB UATP = UATP |
Registrations and transactions - Webhook
The transaction object is returned by the webhooks with the following data:
Response
{
"notificationType": 1,
"portal": {
"id": "IW%2fU8RKO1T7UjasbUcn8rQ%3d%3d",
"title": {
"texts": [{
"text": "Portail de formation",
"languageId": 1
}
],
"IsHaveText": true
},
"subTitle": {
"texts": [{
"text": "Tellement le meilleur portail",
"languageId": 2
}
],
"IsHaveText": true
},
"description": {
"texts": [{
"text": "",
"languageId": 1
}
],
"IsHaveText": true
},
"coverID": 8,
"allowNewAccount": true,
"creationDate": "0001-01-01T00:00:00",
"url": "portailpreprod.sviesolutions.com / JGTHINKWITHPORTALS",
"name": "Votre portail de formation",
"language": 1,
"branchID": "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
"hasCustomLogo": true,
"lastModificationDate": "0001-01-01T00:00:00",
"defaultBranchID": "vrj0IrWe0HF % 2bK9OKGpDF5A%3d%3d",
"isDefaultPortal": true,
"displayType": 1
},
"user": {
"id": "czYuG21TjcY7hETmR3TQHg%3d%3d",
"password": null,
"login": "Brambo",
"firstName": "Brent",
"lastName": "Rambo",
"language": 1,
"email": "karl.bouchard @ sviesolutions.com",
"companyName": null,
"functionTitle": null,
"phoneHome": null,
"phoneMobile": null,
"phoneWork": null,
"phonePublic": 0,
"timeZone": 10,
"address": "690 Rue Saint - Joseph Est",
"address2": null,
"postalCode": "G1K 3B9",
"city": "Québec",
"countryId": 37,
"stateId": 11,
"customFields": {
"Membre": null,
"NbYearService": 0,
"DateEmbauche": "0001-01-01T00:00:00",
"IdUnique": null
}
},
"workspaceInstance": {
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
"name": "33434a",
"creationDate": "0001-01-01T00:00:00",
"startDate": "0001-01-01T00:00:00",
"endDate": "0001-01-01T00:00:00",
"minParticipants": 0,
"maxParticipants": 0,
"isOverBookingSubscription": false,
"workspaceId": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"nbUsersSubbed": -1,
"nbUsersQueue": -1
},
"workspace": {
"id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"creationDate": "2016-11-16T14:52:27.353",
"name": "Ma formation",
"categoryId": "",
"visibilityType": 0,
"maxParticipants": 0,
"minParticipants": 0,
"type": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"providerId": "Mw1VQ2A8DFaNy22zA%3d%3d",
"language": 1,
"description": "",
"subscriptionType": 0,
"startDate": "0001-01-01T00:00:00",
"endDate": "0001-01-01T00:00:00",
"isOverBookingSubscription": true,
"authorizationType": 0,
"enrolmentType": 0,
"externalLink": "monURL",
"keywords": "mot, clef, formation",
"showAvailableSubscriptions": true,
"certificateId": "",
"credits": 0.0,
"nbUsersSubbed": -1,
"nbUsersQueue": -1,
"isAutodeclaration": true,
"accreditationNumber": "12345-e",
"autodeclarationEndDate": "0001-01-01T00:00:00",
"customFields": {
"Champ1": "Snow",
"Test": ""
}
},
"transaction": {
"id": "Y2E5wzApua",
"billingID": "YxLO % 2fUEIoCFRX7S3vH0Yyw%3d%3d",
"transactionDate": "0001-01-01T00:00:00",
"priceName": "",
"currency": "cdn",
"basePrice": 5,
"subscribeDiscountPercent": 0,
"totalPrice": 0,
"paymentMethodID": 21,
"paymentMethodType": 0,
"transactionType": 0,
"comment": "",
"onlineTransactionID": "",
"billingAddress": "690 Rue Saint - Joseph Est",
"billingAddress2": null,
"billingPostalCode": "G1K 3B9",
"billingCity": "Québec",
"billingCountryID": 37,
"billingStateID": null,
"balance": 0,
"authorizationStatus": 0,
"paymentStatus": 0,
"billingType": 1,
"userID": "czYuG21TjcY7hETmR3TQHg%3d%3d",
"taxes": {
"TPS": 2.32,
"TVQ": 3.35
},
"promoCodes":
[
{
"id": "O%2f9dsKKECyJSUWkOK37D8g%3d%3d",
"amount": 32.1
}
]
}
}Field descriptions
| Name | Comments/description |
| notificationType | Type of notification issued by the webhook. (Number type) |
| portal | Object representing the portal on which the registration was made. See the Portals article for the details of the fields. (Object type) |
| user | Object representing the user concerned. See the Users article for the details of the fields. (Object type) |
| workspaceInstance | Object representing the session concerned. See the Sessions article for the details of the fields. (Object type) |
| workspace | Object representing the course or event concerned. See the Courses and events article for the details of the fields. (Object type) |
| transaction | Object representing the transaction. The fields are the same as those returned by transaction/get. (Object type) |
Transaction error code descriptions
Number | Message | Comments/description |
600 | Required id | You must provide an identifier for the transaction. |
601 | Invalid id | The identifier provided for the transaction is invalid. |