cisco-cvp-ux

[POST] Towards ARIA and Salesforce

This operation create a paymentMethod entity for customer.

Request

URL

http://[host]:[port]/cisco-cvp-ux/v1/{businessId}/paymentMethod

Common Parameters
Base URI parameters and headers are common to all the resources as part of payment-methods Biz API, listed below with details.

Base URI Parameter

Query Parameter

Headers

Security Headers

Body

Request Body for Aria

{
    "id": "PAYMENT_99905",
    "name": "Main credit card",
    "authorizationCode": "AutoPay_Due_15_PR",
    "description": "IVR One Time Payment",
    "@type": "TokenizedCreditCard",
    "account": [
        {
            "id": "ARIATESTING013"
        }
    ],
    "details": {
        "token": "gftvcdb"
    }
}

Request Body for Salesforce

{
    "token": "cGF5bWVudG1ldGhvZF9jY181a25obmtzZg",
    "account": [
        {
            "id": "31516278-31514752",
            "@type": "BillingAccount",
            "relatedParty": [
                {
                    "id": "12401231232",
                    "@type": "msisdn"
                }
            ]
        }
    ],
    "relatedParty": [
        {
            "name": "BrainTreeToken",
            "@type": "paymentGatewayType"
        },
        {
            "@type": "channel",
            "name": "IVR"
        }
    ]
}

Response

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

TMF Response for post payment method

Success Response from Aria

{
    "relatedParty": [
        {
            "id": "39167180",
            "@type": "BillcontactRef"
        }
    ],
    "id": "PAYMENT_99905",
    "name": "Main credit card",
    "authorizationCode": "AutoPay_Due_15_PR",
    "description": "IVR One Time Payment",
    "@type": "TokenizedCreditCard",
    "account": [
        {
            "id": "ARIATESTING013"
        }
    ],
    "details": {
        "token": "gftvcdb"
    },
    "contact": [
        {
            "contactName": "Rohit,G,Jose",
            "contactType": "primary",
            "contactMedium": [
                {
                    "mediumType": "PostalAddress",
                    "characteristic": {
                        "city": "Toronto",
                        "street1": "15 Rue des Canards",
                        "street2": "15 Rue des Canards",
                        "postCode": "75014",
                        "country": "CA",
                        "stateOrProvince": "AB",
                        "phoneNumber": "9123746584",
                        "emailAddress": "Annacristal@gmail.com",
                        "faxNumber": "3454354353"
                    }
                }
            ]
        }
    ]
}

Success Response from Salesforce

{
    "description": "payment method create request received"
}

Definitions