• E-commerce Transactions
  • getGet e-commerce transaction.
  • getList e-commerce transactions.
  • postApproves or denies an e-commerce transaction.

API docs by Redocly

Absorb Integration API (v1)

Download OpenAPI specification:Download

E-commerce Transactions

Get e-commerce transaction.

Authorizations:

api_key

path Parameters

transactionId required

string <guid> The E-commerce transaction ID.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

id	string <guid> The unique E-commerce transaction identifier.
paymentGatewayTransactionId	string The transaction's payment gateway transaction ID.
transactionDate	string The transaction's creation date.
transactionCompletedDate	string The transaction's completion date (done by payment gateway or admin approval).
status	string The transaction's status. Possible values: Approved, Declined, PendingApproval
	Array of objects (EcommerceTransactionDetailResource) The transaction's shopping cart items.
paymentMethod	integer Enum: 1 2 4 8 16 The transaction's method of payment. Possible Enum Values: 1 = CreditCard 2 = PayPal 4 = WireTransfer 8 = Check 16 = PurchaseOrder
cardType	string The transaction's credit card type.
maskedCardNumber	string The transaction's last 4 digits of the credit card.
billingFirstName	string First name of the person responsible for payment.
billingLastName	string Last name of the person responsible for payment.
billingAddress	string Address of the person responsible for payment.
billingEmailAddress	string Email address of the person responsible for payment.
learnerEmailAddress	string Email address of the learner receiving the course/enrollment key(s).
learnerFirstName	string First name of the learner receiving the course/enrollment key(s).
learnerLastName	string Last name of the learner receiving the course/enrollment key(s).
referenceNumber	string The transaction's reference number.
couponCode	string The transaction's coupon code used.
provinceTaxLabel	string The transaction's provincial tax name.
provinceTax	number <decimal> The transaction's dollar amount of provincial tax.
countryTaxLabel	string The transaction's country tax name.
countryTax	number <decimal> The transaction's dollar amount of country tax.
discount	number <decimal> The transaction's dollar amount of discount.
subTotal	number <decimal> The transaction's subtotal before taxes and discounts.
totalAmount	number <decimal> The transaction's total amount actually paid.
paymentGatewayMessage	string The transaction's message from payment gateway.
paymentGatewayResult	string The transaction's result from payment gateway. Meaning depends on type of payment gateway.
paymentGatewayMessageCode	string The transaction's message code from payment gateway. Meaning depends on type of payment gateway.
userId	string <guid> The transaction's user ID.
isNewUser	boolean Indicates if this transaction was started by a new Absorb user.
isRefunded	boolean Indicates if this transaction was refunded.
refundDate	string The transaction's refund date.
quantity	integer <int32> The transaction's quantity of seats purchased. This value applies to each shopping cart item.

US

https://rest.myabsorb.com/e-commerce/transactions/{transactionId}

CA

https://rest.myabsorb.ca/e-commerce/transactions/{transactionId}

EU

https://rest.myabsorb.eu/e-commerce/transactions/{transactionId}

AU

https://rest.myabsorb.com.au/e-commerce/transactions/{transactionId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": "string",
• "paymentGatewayTransactionId": "string",
• "transactionDate": "string",
• "transactionCompletedDate": "string",
• "status": "string",
• "details": [

  • {

    • "id": "string",
    • "courseId": "string",
    • "courseName": "string",
    • "sessionId": "string",
    • "sessionName": "string",
    • "price": 0

    }

  ],
• "paymentMethod": 1,
• "cardType": "string",
• "maskedCardNumber": "string",
• "billingFirstName": "string",
• "billingLastName": "string",
• "billingAddress": "string",
• "billingEmailAddress": "string",
• "learnerEmailAddress": "string",
• "learnerFirstName": "string",
• "learnerLastName": "string",
• "referenceNumber": "string",
• "couponCode": "string",
• "provinceTaxLabel": "string",
• "provinceTax": 0,
• "countryTaxLabel": "string",
• "countryTax": 0,
• "discount": 0,
• "subTotal": 0,
• "totalAmount": 0,
• "paymentGatewayMessage": "string",
• "paymentGatewayResult": "string",
• "paymentGatewayMessageCode": "string",
• "userId": "string",
• "isNewUser": true,
• "isRefunded": true,
• "refundDate": "string",
• "quantity": 0

}

List e-commerce transactions.

Can be filtered by userId, courseId, transactionDate, transactionCompletedDate, and paymentGatewayTransactionId.

Authorizations:

api_key

query Parameters

userId	string <guid> The specified user ID to filter by.
courseId	string <guid> The specified course ID to filter by.
transactionDate	string <date-time> The specified creation date to filter by.
transactionCompletedDate	string <date-time> The specified completion date to filter by.
paymentGatewayTransactionId	string The specified payment gateway transaction ID to filter by.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

Array

id	string <guid> The unique E-commerce transaction identifier.
paymentGatewayTransactionId	string The transaction's payment gateway transaction ID.
transactionDate	string The transaction's creation date.
transactionCompletedDate	string The transaction's completion date (done by payment gateway or admin approval).
status	string The transaction's status. Possible values: Approved, Declined, PendingApproval
	Array of objects (EcommerceTransactionDetailResource) The transaction's shopping cart items.
paymentMethod	integer Enum: 1 2 4 8 16 The transaction's method of payment. Possible Enum Values: 1 = CreditCard 2 = PayPal 4 = WireTransfer 8 = Check 16 = PurchaseOrder
cardType	string The transaction's credit card type.
maskedCardNumber	string The transaction's last 4 digits of the credit card.
billingFirstName	string First name of the person responsible for payment.
billingLastName	string Last name of the person responsible for payment.
billingAddress	string Address of the person responsible for payment.
billingEmailAddress	string Email address of the person responsible for payment.
learnerEmailAddress	string Email address of the learner receiving the course/enrollment key(s).
learnerFirstName	string First name of the learner receiving the course/enrollment key(s).
learnerLastName	string Last name of the learner receiving the course/enrollment key(s).
referenceNumber	string The transaction's reference number.
couponCode	string The transaction's coupon code used.
provinceTaxLabel	string The transaction's provincial tax name.
provinceTax	number <decimal> The transaction's dollar amount of provincial tax.
countryTaxLabel	string The transaction's country tax name.
countryTax	number <decimal> The transaction's dollar amount of country tax.
discount	number <decimal> The transaction's dollar amount of discount.
subTotal	number <decimal> The transaction's subtotal before taxes and discounts.
totalAmount	number <decimal> The transaction's total amount actually paid.
paymentGatewayMessage	string The transaction's message from payment gateway.
paymentGatewayResult	string The transaction's result from payment gateway. Meaning depends on type of payment gateway.
paymentGatewayMessageCode	string The transaction's message code from payment gateway. Meaning depends on type of payment gateway.
userId	string <guid> The transaction's user ID.
isNewUser	boolean Indicates if this transaction was started by a new Absorb user.
isRefunded	boolean Indicates if this transaction was refunded.
refundDate	string The transaction's refund date.
quantity	integer <int32> The transaction's quantity of seats purchased. This value applies to each shopping cart item.

US

https://rest.myabsorb.com/e-commerce/transactions

CA

https://rest.myabsorb.ca/e-commerce/transactions

EU

https://rest.myabsorb.eu/e-commerce/transactions

AU

https://rest.myabsorb.com.au/e-commerce/transactions

Response samples

• 200
• 422

Content type

application/json

[

• {

  • "id": "string",
  • "paymentGatewayTransactionId": "string",
  • "transactionDate": "string",
  • "transactionCompletedDate": "string",
  • "status": "string",
  • "details": [

    • {

      • "id": "string",
      • "courseId": "string",
      • "courseName": "string",
      • "sessionId": "string",
      • "sessionName": "string",
      • "price": 0

      }

    ],
  • "paymentMethod": 1,
  • "cardType": "string",
  • "maskedCardNumber": "string",
  • "billingFirstName": "string",
  • "billingLastName": "string",
  • "billingAddress": "string",
  • "billingEmailAddress": "string",
  • "learnerEmailAddress": "string",
  • "learnerFirstName": "string",
  • "learnerLastName": "string",
  • "referenceNumber": "string",
  • "couponCode": "string",
  • "provinceTaxLabel": "string",
  • "provinceTax": 0,
  • "countryTaxLabel": "string",
  • "countryTax": 0,
  • "discount": 0,
  • "subTotal": 0,
  • "totalAmount": 0,
  • "paymentGatewayMessage": "string",
  • "paymentGatewayResult": "string",
  • "paymentGatewayMessageCode": "string",
  • "userId": "string",
  • "isNewUser": true,
  • "isRefunded": true,
  • "refundDate": "string",
  • "quantity": 0

  }

]

Approves or denies an e-commerce transaction.

Authorizations:

api_key

path Parameters

transactionId required

string <guid> The E-commerce transaction ID.

header Parameters

x-api-key	string
x-api-version	string 1

Request Body schema: application/json

The status of the transaction.

status

string Status of the transaction. Accepted values: Approved Declined

Responses

US

https://rest.myabsorb.com/e-commerce/transactions/{transactionId}/status

CA

https://rest.myabsorb.ca/e-commerce/transactions/{transactionId}/status

EU

https://rest.myabsorb.eu/e-commerce/transactions/{transactionId}/status

AU

https://rest.myabsorb.com.au/e-commerce/transactions/{transactionId}/status

Request samples

• Payload

Content type

application/json

{

• "status": "string"

}

Response samples

• 404
• 409
• 422

Content type

application/json

{

• "validations": [

  • "string"

  ],
• "code": 0,
• "message": "string",
• "term": "string",
• "_meta": {

  • "property1": "string",
  • "property2": "string"

  }

}