dxp-ux

1.0.x
(0 reviews)

POST paymentMethod (TMF-670)

[POST] Towards ARIA

This operation create a paymentMethod entity for customer.

Request URL

https://[localhost]:[port]/dxp-ux/v1/{businessId}/paymentMethod

URL PARAMS

nametypedescriptionrequired
businessIdstring2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit.Y
namevaluedescriptionrequired
client_idstringThe client_id identifying the channel. Minimum characters: 5Y
client_secretstringPassword associated with the client_id. Minimum characters: 5Y
Correlation-IDstringIdentifier that correlates HTTP request between a client and server.
Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.		N
For business it is Mandatory
channelIdstringChannel to business:
Can be : APP		Y
targetSystemStringTo identify the bss system
Eg: aria		Y

Request Data Model

Request Field NametypeM/ODescription
idstringMUnique external identifier for payment method in Aria System
namestringOA word, term, or phrase by which the payment method is known.
account.idstringMaccount id
account.namestringOaccount name
@typestringMAria is accepting only 2 fields 1. TokenizedCreditCard and 2. ElectronicCheque (ACH
descriptionstringOPayment method description
authorizationCodestringM"AutoPayDue(n)_PR" : where n is from 0 to 18. 0 to 18 refer to you can set when you want to set the auto pay to be collected from the bill date.
example: AutoPay_Due_15_PR
details.accountNumberstringM/OAccount number Mandatory for ACH(ElectronicCheque)
Not in scope
details.bicstringM/OBank routing number Mandatory for ACH(ElectronicCheque)
Not in scope
details.tokenstringMPayment token (braintree token)
contact/contactNamestringOBilling Contact Name to provide comma separated values for first name, middle name and last name.
Example: Anna,m,Cristal or Anna
contact /contactMediumArray (contactMedium)OA list of contact mediums. Indicates the contact medium that could be used to contact the party.
contact/contactMedium.mediumTypeStringOContact medium type ‘BillAddress’.
contact/contactMedium.characteristics(Object)OContact Characteristics If no contact characteristics are present in the request, bill contact no will not be present in the response.
contact/contactMedium.characteristics.contactTypestringOType of billing contact. Default value “primary”.
contact/contactMedium.characteristics.street1stringOFirst address line of the billing contact.
contact/contactMedium.characteristics.street2stringOSecond address line of the billing contact.
contact/contactMedium.characteristics.citystringOCity of the billing contact.
contact/contactMedium.characteristics.stateOrProvincestringOState or province of the billing contact. Eg: "OT"
contact/contactMedium.characteristics.postcodestringOPostal code for the billing contact. Postal/Zip code for the contact's address
contact/contactMedium.characteristics.countrystringOCountry of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase. Country as ISO code Eg: “CA”
contact/contactMedium.characteristics.emailAddressstringOEmail of the billing contact.
contact/contactMedium.characteristics.phoneNumberstringOPhone number of the billing contact.
contact/contactMedium.characteristics.faxNumberstringOFax number of the billing contact.

Request Body

This table include the field which are required to create paymentMethod in aria system.

{
    "id": "BANx0823-CANx22x1_PM_001",
    "name": "Main credit card",
    "authorizationCode": "AutoPay_Due_15_PR",
    "description": "Tokenised Credit Card",
    "@type": "TokenisedCreditCard",
    "account": [
        {
            "id": "BANx0823-CANx22x1",
            "name": "Anna,Cristal"
        }
    ],
    "details": {
        "token": "gftvcdb"
    },
    "contact": [
        {
            "contactName": "Anna,M,Cristal",
            "contactType": "primary",
            "contactMedium": [
                {
                    "mediumType": "PostalAddress",
                    "characteristic": {
                        "city": "Toronto",
                        "street1": "15 Rue des Canards",
                        "street2": "15 Rue des Canards",
                        "postCode": "75014",
                        "country": "CA",
                        "stateOrProvince": "PR",
                        "phoneNumber": "9123746584",
                        "emailAddress": "Annacristal@gmail.com",
                        "faxNumber": "3454354353"
                    }
                }
            ]
        }
    ]
}

Response 201

{
    "relatedParty": [
        {
            "id": "37357823",
            "@type": "BillContactRef"
        }
    ],
    "id": "BANx0823-CANx22x1_PM_001",
    "name": "Main PM",
    "description": "Tokenized Credit Card",
    "@type": "TokenizedCreditCard",
    "account": [
        {
            "id": "CA-111001-01"
        }
    ],
    "details": {
        "token": "SALESFORCE003"
    },
    "contact": [
        {
            "contactName": "Anna,m,M,Cristal",
            "contactType": "primary",
            "contactMedium": [
                {
                    "mediumType": "BillAddress",
                    "characteristic": {
                        "city": "Toronto",
                        "street1": "15 Rue des Canards",
                        "street2": "15 Rue des Canards",
                        "postCode": "75014",
                        "country": "CA",
                        "stateOrProvince": "OT",
                        "phoneNumber": "9123746584",
                        "emailAddress": "Annacristal@gmail.com",
                        "faxNumber": "3454354353"
                    }
                }
            ]
        }
    ]
}

Reviews