customCurrency

post

/ccadmin/v1/webhook/customCurrency

This webhook is used for Custom currency Payments

Request

Supported Media Types
Body ()
This webhook is used for Custom currency Payments
Root Schema : customCurrency_request
Type: object
This webhook is used for Custom currency Payments
Show Source
Example:
{
    "loyaltyDetails":[
        {
            "programName":"programForFlyer",
            "membershipId":"member0002",
            "programId":"prg10002",
            "status":"Enrolled"
        },
        {
            "programName":"programForYoungster",
            "membershipId":"member0001",
            "programId":"prg10001",
            "status":"Enrolled"
        }
    ],
    "orderId":"o30417",
    "profile":{
        "phoneNumber":"1234512345",
        "id":"110072",
        "email":"a@a.com"
    },
    "channel":"storefront",
    "locale":"en",
    "transactionId":"o30417-pg30418-1504691722253",
    "transactionTimestamp":"2017-09-06T09:55:22+0000",
    "transactionType":"0600",
    "customProperties":{
        "cust-prop2":"cust-prop2",
        "cust-prop1":"cust-prop1"
    },
    "paymentId":"pg30418",
    "gatewaySettings":{
        "paymentMethodTypes":"loyaltyPoints"
    },
    "paymentMethod":"loyaltyPoints",
    "shippingAddress":{
        "lastName":"a",
        "country":"US",
        "firstName":"a",
        "phoneNumber":"1234512345",
        "address2":null,
        "city":"cambridge",
        "address1":"1 main st",
        "postalCode":"02142",
        "state":"MA",
        "email":"a@a.com"
    },
    "siteId":"siteUS",
    "currencyCode":"PTS",
    "gatewayId":"demoLoyaltyPointsPaymentGateway"
}
Nested Schema : billingAddress
Type: object
billing address details
Show Source
Nested Schema : customProperties
Type: object
key value pair of custom attributes
Show Source
Nested Schema : gatewaySettings
Type: object
key value pair of gateway settings
Show Source
Nested Schema : loyaltyDetails
Type: array
profile loyalty programs
Show Source
Nested Schema : profile
Type: object
Basic profile information.
Show Source
Nested Schema : referenceInfo
Type: object
Show Source
Nested Schema : referenceInfos
Type: array
Show Source
Nested Schema : shippingAddress
Type: object
Default shipping address
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : customCurrency_response
Type: object
Show Source
Nested Schema : authorizationResponse
Type: object
Show Source
Nested Schema : creditResponse
Type: object
Show Source
Nested Schema : inquireBalanceResponse
Type: object
Show Source
Nested Schema : voidResponse
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
key value pair of additional attributes
Show Source
Nested Schema : customPaymentProperties
Type: array
custom attributes
Show Source
Nested Schema : additionalProperties
Type: object
key value pair of additional attributes
Show Source
Nested Schema : customPaymentProperties
Type: object
key value pair of custom attributes
Show Source
Nested Schema : additionalProperties
Type: object
key value pair of additional attributes
Show Source
Nested Schema : customPaymentProperties
Type: object
key value pair of custom attributes
Show Source
Nested Schema : loyaltyPrograms
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
key value pair of additional attributes
Show Source
Nested Schema : loyaltyPointDetails
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
key value pair of additional attributes
Show Source
Nested Schema : additionalProperties
Type: object
key value pair of additional attributes
Show Source
Nested Schema : customPaymentProperties
Type: object
key value pair of custom attributes
Show Source
Example Response (application/json)
{
    "transactionType":"0600",
    "orderId":"o30417",
    "paymentId":"pg30418",
    "channel":"storefront",
    "paymentMethod":"loyaltyPoints",
    "siteId":"siteUS",
    "locale":"en",
    "inquireBalanceResponse":{
        "hostTransactionTimestamp":"1504691722267",
        "responseReason":"inquireBalanceResponseReason",
        "customPaymentProperties":[
            "5000addnl-property-key5",
            "cust-prop2",
            "5000addnl-property-key2",
            "cust-prop1"
        ],
        "responseDescription":"inquireBalanceResponseDescription",
        "loyaltyPrograms":[
            {
                "loyaltyPointDetails":[
                    {
                        "membershipType":"blue",
                        "pointsBalance":"2000",
                        "pointsType":"bluePoints",
                        "additionalProperties":{
                            "propertyName1":"value1",
                            "propertyName2":"value2"
                        }
                    },
                    {
                        "membershipType":"red",
                        "pointsBalance":"6000",
                        "pointsType":"redPoints",
                        "additionalProperties":{
                            "propertyName4":"value4",
                            "propertyName3":"value3"
                        }
                    },
                    {
                        "membershipType":"green",
                        "pointsBalance":"6000",
                        "pointsType":"PTS",
                        "additionalProperties":{
                            "propertyName4":"value4",
                            "propertyName3":"value3"
                        }
                    }
                ],
                "programName":"programForYoungster",
                "membershipId":"member0001",
                "additionalProperties":{
                    "propertyName5":"value5",
                    "validTill":"2029-11-26T15:57:55.631Z",
                    "propertyName6":"value6",
                    "validFrom":"2017-07-14T15:57:55.631Z"
                },
                "programId":"prg10001"
            },
            {
                "loyaltyPointDetails":[
                    {
                        "membershipType":"silver",
                        "pointsBalance":"2000",
                        "pointsType":"rewardPoints",
                        "additionalProperties":{
                            "propertyName7":"value7",
                            "propertyName8":"value8"
                        }
                    },
                    {
                        "membershipType":"gold",
                        "pointsBalance":"6000",
                        "pointsType":"skyMiles",
                        "additionalProperties":{
                            "propertyName10":"value10",
                            "propertyName9":"value9"
                        }
                    }
                ],
                "programName":"programForFlyer",
                "membershipId":"member0002",
                "additionalProperties":{
                    "validTill":"2030-12-26T15:57:55.631Z",
                    "propertyName12":"value12",
                    "propertyName11":"value11",
                    "validFrom":"2017-06-14T15:57:55.631Z"
                },
                "programId":"prg10002"
            }
        ],
        "merchantTransactionId":"MERCH-TX-1504691722267",
        "hostTransactionId":"HOST-TX-1504691722267",
        "additionalProperties":{
            "5000addnl-property-key5":"5000payment-property-value5",
            "5000addnl-property-key4":"5000payment-property-value4",
            "5000addnl-property-key3":"5000payment-property-value3",
            "cust-prop2":"cust-prop2",
            "5000addnl-property-key2":"5000payment-property-value2",
            "cust-prop1":"cust-prop1",
            "5000addnl-property-key1":"5000payment-property-value1"
        },
        "responseCode":"5000",
        "merchantTransactionTimestamp":"1504691722267"
    },
    "currencyCode":"PTS",
    "transactionId":"o30417-pg30418-1504691722253",
    "transactionTimestamp":"2017-09-06T09:55:22+0000",
    "gatewayId":"demoLoyaltyPointsPaymentGateway"
}
Back to Top