Mail Order Management APIs

Complete Purchase

API to confirm payment for complete purchase of a Mail Order on the Titan Mail Cloud infra

API consumers can use Create Mail Order/Modify Mail Order APIs for order provisioning and upgrades/renewals.

This API serves a different (and more deeply integrated) case where partner is handling payments for some purchases user initiated in Titan's Domain Control Panel.

Flow:

  1. User initiates a payment action (adds some addon to cart, increases mailboxes, upgrades plan) on Control Panel.
  2. For payment Titan redirects user to a payment url partners provide, passing on a trackingId as part of jwt
  3. Partner takes payment from user and triggers this API (Complete Purchase) with the same trackingId
  4. Titan records the payment and makes the purchases associated with that trackingId.
post/partner/completePurchase

Request

  • Base URL: https://bll.titan.email
  • URL: https://bll.titan.email/partner/completePurchase
  • Auth: none declared

Request body

titanOrderIdnumber required

The unique order ID against each domain provisioned with Titan

domainNamestring

[Deprecated] The mail order name associated to the Titan order ID

customerIdstring

[Deprecated] unique id stored on your end for each customer

trackingIdstring required

Payment tracking token fetched from Titan's control panel

currencystring

This is the currency in which the customer is being charged for Titan mail. also updates domain to this currency

chargedAmountnumber required

Total amount charged by the partner to the end customer in the customer's currency for this purchase including taxAmount. Precision upto 2 decimal places.

chargedUSDAmountnumber

The value of chargedAmount in USD. If this field is null then open-exchange rates are used to calculate this field

discountAmountnumber

Any ad hoc discount given to the customer for this purchase. This should be passed in the original currency in which amount was charged to the customers.

taxAmountnumber

Amount collected from the user as TAX amount in the customer's currency for this purchase. Precision upto 2 decimal places.

paymentTxnIdstring

Payment Transaction ID in your system.

Example request

{
  "titanOrderId": 1,
  "domainName": "xyz.com",
  "customerId": "abcd123",
  "trackingId": "qwe-123-asd-321",
  "currency": "USD",
  "chargedAmount": 12.2,
  "chargedUSDAmount": 12.2,
  "discountAmount": 1.5,
  "taxAmount": 0.2,
  "paymentTxnId": "txnId"
}

Response

OK

reqIDstring required

Example response

{
  "reqID": "server.req.id"
}

Changes

No recorded changes to this operation across all 1 revision of this API.