dxp-ux

[POST]

The createTopupBalance API provides 2 below features,

#createTopupBalance#: allows the customer to top up their account with a mobile number that they have specified (MSISDN) or subscriptionId.

#Retrive Tax Info#: API returns the estimated tax amount before making the top-up if we call API with field reason = TAX.

Please find sample requests and responses for both scenarios below.

This API is available for LCPR.

URL

http://[localhost]:[port]/dxp-ux/v1/{businessId}/topupBalance

URL PARAMS

Header

REQUEST BODY FOR TAX_INFORMATION

Note - 1) The possiable values of reason attributes are "TAX/ESTIMATE/TAX ESTIMATE"

2) No need to pass valid voucher(one time code/nonce) code, it will accept any dumy value.

REQUEST BODY FOR TAX_INFORMATION using MSISDN

{
    "id": "ABC123456",
    "amount": {
        "amount": 100,
        "units": "USD"
    },
    "reason": "TAX ESTIMATE",
    "voucher": "A",
    "product": [
        {
            "id": "01",
            "name": "RechargeOffer",
            "@type": "Offer"
        }
    ],
    "partyAccount": {
        "id": "9347455272",
        "@type": "MSISDN"
    }
}

Definitions

Each of the request parameters is detailed for Tax information request body

RESPONSE BODY FOR TAX_INFORMATION

{
    "status": "Success",
    "id": "ABC123456",
    "amount": {
        "amount": 100,
        "units": "USD"
    },
    "voucher": "A",
    "reason": "TAX ESTIMATE",
    "product": [
        {
            "id": "0",
            "name": "RechargeOffer",
            "@type": "Offer"
        }
    ],
    "validFor": {
        "endDateTime": "65535-12-31T23:59:59.999999Z",
        "startDateTime": "2022-08-30T09:07:14.000Z"
    },
    "bucket": {
        "id": "1",
        "name": "Prepaid Balance"
    },
    "impactedBucket": [
        {
            "amountAfter": 111.5,
            "name": "Total Amount",
            "item": [
                {
                    "amount": 10.5,
                    "name": "STATE SALES TAX"
                },
                {
                    "amount": 1.0,
                    "name": "CITY SALES TAX"
                }
            ]
        }
    ],
    "partyAccount": {
        "id": "9347455272",
        "@type": "MSISDN"
    }
}

Definitions

Each of the response parameters is detailed for Tax information response body

REQUEST BODY FOR TAX_INFORMATION using subscriptionId

{
    "amount": {
        "amount": 100,
        "units": "USD"
    },
    "reason": "TAX ESTIMATE",
    "voucher": "A",
    "product": [
        {
            "id": "01",
            "name": "RechargeOffer",
            "@type": "Offer"
        }
    ],
    "partyAccount": {
        "id": "S-94537890",
        "@type": "subscriptionId"
    }
}

Definitions

Each of the request parameters is detailed for Tax information request body

RESPONSE BODY FOR TAX_INFORMATION

{
    "status": "Success",
    "amount": {
        "amount": 100,
        "units": "USD"
    },
    "voucher": "A",
    "reason": "TAX ESTIMATE",
    "product": [
        {
            "id": "0",
            "name": "RechargeOffer",
            "@type": "Offer"
        }
    ],
    "validFor": {
        "endDateTime": "65535-12-31T23:59:59.999999Z",
        "startDateTime": "2022-08-30T09:07:14.000Z"
    },
    "bucket": {
        "id": "1",
        "name": "Prepaid Balance"
    },
    "impactedBucket": [
        {
            "amountAfter": 111.5,
            "name": "Total Amount",
            "item": [
                {
                    "amount": 10.5,
                    "name": "STATE SALES TAX"
                },
                {
                    "amount": 1.0,
                    "name": "CITY SALES TAX"
                }
            ]
        }
    ],
    "partyAccount": {
        "id": "S-94537890",
        "@type": "subscriptionId"
    }
}

Definitions

Each of the response parameters is detailed for Tax information response body

REQUEST BODY FOR TOPUP BALANCE

Note - 1) No need to pass reason attribute.

2) Expecting valid voucher (one time code/nonce) code for complete top-up balance.

{
    "id": "123456",
    "amount": {
        "amount": 100,
        "units": "USD"
    },
    "voucher": "fake-valid-nonce",
    "product": [
        {
            "id": "01",
            "name": "RechargeOffer",
            "@type": "Offer"
        }
    ],
    "relatedParty": [
        {
            "id": "628935575",
            "@type": "PaymentGatewayUserId"
        },
        {
            "id": "0",
            "@type": "PaymentGatewayId"
        }
    ],
    "partyAccount": {
        "id": "9347455272",
        "@type": "MSISDN"
    }
}

Definitions

Each of the request parameters is detailed.

relatedParty values

RESPONSE BODY FOR TOPUP BALANCE

{
    "id": "123456",
    "confirmationDate": "2022-11-08T08:24:35.000Z",
    "status": "Approved",
    "amount": {
        "amount": 100,
        "units": "USD"
    },
    "voucher": "fake-valid-nonce",
    "product": [
        {
            "id": "0",
            "name": "RechargeOffer",
            "@type": "Offer"
        }
    ],
    "validFor": {
        "endDateTime": "65535-12-31T23:59:59.999999Z",
        "startDateTime": "2022-08-30T09:07:14.000Z"
    },
    "relatedParty": [
        {
            "id": "628935575",
            "@type": "PaymentGatewayUserId"
        },
        {
            "id": "0",
            "@type": "PaymentGatewayId"
        },
        {
            "id": "70",
            "@type": "PaymentResourceIdRef"
        }
    ],
    "bucket": {
        "id": "1",
        "name": "Prepaid Balance"
    },
    "impactedBucket": [
        {
            "amountAfter": 111.5,
            "name": "Total Amount",
            "item": [
                {
                    "amount": 10.5,
                    "name": "STATE SALES TAX"
                },
                {
                    "amount": 1.0,
                    "name": "CITY SALES TAX"
                }
            ]
        }
    ],
    "partyAccount": {
        "id": "9347455272",
        "@type": "MSISDN"
    }
}

Definitions

Each of the response parameters is detailed for Topup Balance response body

relatedParty

Possible Error Scenarios: :

IF WE ARE PASSING INVALID (MSISDN) NUMBER IN REQUEST BODY

{
    "errors": [
        {
            "code": 400,
            "message": "MATRIXX:POST_TOPUP_BALANCE",
            "description": "11 | Subscriber not found (AccessNumber=709565949)"
        }
    ]
}

IF WE ARE PASSING INVALID VOUCHER IN REQUEST BODY

{
    "errors": [
        {
            "code": 400,
            "message": "MATRIXX:POST_TOPUP_BALANCE",
            "description": "52 | The AUTHORIZATION_AND_SETTLEMENT Request to Braintree has Failed: Invalid Payment Method Nonce QWEDRFRG"
        }
    ]
}

IF WE ARE PASSING INVALID PAYMENT Gateway ID REQUEST BODY

{
    "errors": [
        {
            "code": 400,
            "message": "MATRIXX:POST_TOPUP_BALANCE",
            "description": "52 | No Payment Gateway with Id 3 has been configured"
        }
    ]
}