REST API for Oracle Commerce Cloud December 2017

customCurrency

post

/ccadmin/v1/webhook/customCurrency

This webhook is used for Custom currency Payments

Request

Supported Media Types

application/json

Body Parameter

This webhook is used for Custom currency Payments

Root Schema : customCurrency_request

This webhook is used for Custom currency Payments

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"
}

Properties

amount: Type: string

amount.
billingAddress: Type: object billingAddress

Additional Properties Allowed:

billing address details
channel: Type: string

channel
currencyCode: Type: string

The three character currency code.
customProperties: Type: object customProperties

Additional Properties Allowed: { "description":"key value pair of custom attributes", "type":"string" }

key value pair of custom attributes
gatewayId: Type: string

Reflects the same gateway ID of the corresponding request. Mandatory attribute.
gatewaySettings: Type: object gatewaySettings

Additional Properties Allowed:

key value pair of gateway settings
locale: Type: string

locale
loyaltyDetails: Type: array loyaltyDetails

Additional Properties Allowed:

profile loyalty programs
orderId: Type: string

Order Id
paymentId: Type: string

Reflects the same paymentId of the corresponding request. Mandatory attribute.
paymentMethod: Type: string

Reflects the same payment method of the corresponding request. Mandatory attribute.
profile: Type: object profile

Additional Properties Allowed:

Basic profile information.
referenceInfo: Type: object referenceInfo

Additional Properties Allowed:
referenceInfos: Type: array referenceInfos

Additional Properties Allowed:
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

Default shipping address
siteId: Type: string

site associated with this request
transactionId: Type: string

Reflects the same transaction ID of the corresponding request. Mandatory attribute.
transactionTimestamp: Type: string

Reflects the same transaction timestamp of the corresponding request. Mandatory attribute.
transactionType: Type: string

type of transaction

Nested Schema : billingAddress

Type: object

billing address details

Properties

address1: Type: string

The 1st line of address field
address2: Type: string

The 2nd line of address field
city: Type: string

The city of the customer
country: Type: string

The country of the customer
email: Type: string

The email of the customer
firstName: Type: string

The first name of the customer
lastName: Type: string

The last name of customer
phoneNumber: Type: integer

The phone number of the customer
postalCode: Type: string

The postal code
state: Type: string

Nested Schema : customProperties

Type: object

Additional Properties Allowed

Type: string

key value pair of custom attributes

key value pair of custom attributes

Properties

membershipId: Type: string

memberShipId of customer.
programId: Type: string

Unique id for loyalty program.

Nested Schema : gatewaySettings

Type: object

key value pair of gateway settings

Properties

Nested Schema : loyaltyDetails

Type: array

profile loyalty programs

Items

Type: object items

Additional Properties Allowed:

Nested Schema : profile

Type: object

Basic profile information.

Properties

email: Type: string

The email address
id: Type: string

The ID of the shopper profile that owns the order.
phoneNumber: Type: string

Phone number.

Nested Schema : referenceInfo

Type: object

Properties

amount: Type: string

amount.
currencyCode: Type: string

The three character currency code.
hostTransactionId: Type: string

The transaction ID returned by the gateway
locale: Type: string

locale
merchantTransactionId: Type: string

The transaction ID returned by the merchant. Mandatory attribute.

Nested Schema : referenceInfos

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shippingAddress

Type: object

Default shipping address

Properties

address1: Type: string

Address Line 1.
address2: Type: string

Address Line 2.
city: Type: string

City.
country: Type: string

Name of the country.
email: Type: string
firstName: Type: string

First name.
lastName: Type: string

The last name of customer
phoneNumber: Type: integer

Phone number.
postalCode: Type: string

Postal code.
state: Type: string

State.

Nested Schema : items

Type: object

Properties

membershipId: Type: string

membershipId of the profile.
programId: Type: string

programId of Loyalty Program
programName: Type: string

programName of Loyalty Program
status: Type: string

status of Enrollment.

Nested Schema : items

Type: object

Properties

amount: Type: string

amount.
currencyCode: Type: string

The three character currency code.
hostTransactionId: Type: string

The transaction ID returned by the gateway
locale: Type: string

locale
merchantTransactionId: Type: string

The transaction ID returned by the merchant. Mandatory attribute.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : customCurrency_response

Properties

amount: Type: string

amount.
authorizationResponse: Type: object authorizationResponse

Additional Properties Allowed:
channel: Type: string

Required: true

channel
creditResponse: Type: object creditResponse

Additional Properties Allowed:
currencyCode: Type: string

Required: true

The three character currency code.
gatewayId: Type: string

Required: true

Reflects the same gateway ID of the corresponding request. Mandatory attribute.
inquireBalanceResponse: Type: object inquireBalanceResponse

Additional Properties Allowed:
locale: Type: string

Required: true

locale
orderId: Type: string

Required: true

order id
paymentId: Type: string

Required: true

Reflects the same paymentId of the corresponding request. Mandatory attribute.
paymentMethod: Type: string

Required: true

Reflects the same payment method of the corresponding request. Mandatory attribute.
siteId: Type: string

Required: true

site associated with this request
transactionId: Type: string

Required: true

Reflects the same transaction ID of the corresponding request. Mandatory attribute.
transactionTimestamp: Type: string

Required: true

Reflects the same transaction timestamp of the corresponding request. Mandatory attribute.
transactionType: Type: string

Required: true

transaction type
voidResponse: Type: object voidResponse

Additional Properties Allowed:

Nested Schema : authorizationResponse

Type: object

Properties

additionalProperties: Type: object additionalProperties

Additional Properties Allowed:

key value pair of additional attributes
customPaymentProperties: Type: array customPaymentProperties

Additional Properties Allowed:

custom attributes
hostTransactionId: Type: string

The transaction ID returned by the gateway
hostTransactionTimestamp: Type: string

The timestamp of the transaction.
merchantTransactionId: Type: string

Required: true

The transaction ID returned by the merchant. Mandatory attribute.
merchantTransactionTimestamp: Type: string

Required: true

The merchant timestamp of the transaction. Mandatory attribute.
responseCode: Type: string

Required: true

Returned code of response. Mandatory attribute.
responseDescription: Type: string

The description of the response. Optional attribute
responseReason: Type: string

Required: true

Response reason. Optional attribute

Nested Schema : creditResponse

Type: object

Properties

additionalProperties: Type: object additionalProperties

Additional Properties Allowed:

key value pair of additional attributes
customPaymentProperties: Type: object customPaymentProperties

Additional Properties Allowed:

key value pair of custom attributes
hostTransactionId: Type: string

The transaction ID returned by the gateway
hostTransactionTimestamp: Type: string

The timestamp of the transaction.
merchantTransactionId: Type: string

Required: true

The transaction ID returned by the merchant. Mandatory attribute.
merchantTransactionTimestamp: Type: string

Required: true

The merchant timestamp of the transaction. Mandatory attribute.
responseCode: Type: string

Required: true

Returned code of response. Mandatory attribute.
responseDescription: Type: string

The description of the response. Optional attribute
responseReason: Type: string

Required: true

Response reason. Optional attribute

Nested Schema : inquireBalanceResponse

Type: object

Properties

additionalProperties: Type: object additionalProperties

Additional Properties Allowed:

key value pair of additional attributes
customPaymentProperties: Type: object customPaymentProperties

Additional Properties Allowed:

key value pair of custom attributes
hostTransactionId: Type: string

The transaction ID returned by the gateway
hostTransactionTimestamp: Type: string

The timestamp of the transaction.
loyaltyPrograms: Type: array loyaltyPrograms

Required: true

Additional Properties Allowed:
merchantTransactionId: Type: string

Required: true

The transaction ID returned by the merchant. Mandatory attribute.
merchantTransactionTimestamp: Type: string

Required: true

The merchant timestamp of the transaction. Mandatory attribute.
responseCode: Type: string

Required: true

Returned code of response. Mandatory attribute.
responseDescription: Type: string

The description of the response. Optional attribute
responseReason: Type: string

Required: true

Response reason. Optional attribute

Nested Schema : voidResponse

Type: object

Properties

additionalProperties: Type: object additionalProperties

Additional Properties Allowed:

key value pair of additional attributes
customPaymentProperties: Type: object customPaymentProperties

Additional Properties Allowed:

key value pair of custom attributes
hostTransactionId: Type: string

The transaction ID returned by the gateway
hostTransactionTimestamp: Type: string

The timestamp of the transaction.
merchantTransactionId: Type: string

Required: true

The transaction ID returned by the merchant. Mandatory attribute.
merchantTransactionTimestamp: Type: string

Required: true

The merchant timestamp of the transaction. Mandatory attribute.
responseCode: Type: string

Required: true

Returned code of response. Mandatory attribute.
responseDescription: Type: string

The description of the response. Optional attribute
responseReason: Type: string

Required: true

Response reason. Optional attribute

Nested Schema : additionalProperties

Type: object

key value pair of additional attributes

Properties

membershipId: Type: string

membershipId of the profile.
programId: Type: string

programId of Loyalty Program
programName: Type: string

programName of Loyalty Program

Nested Schema : customPaymentProperties

Type: array

custom attributes

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

membershipId: Type: string

membershipId of the profile.
programId: Type: string

programId of Loyalty Program
programName: Type: string

programName of Loyalty Program

Nested Schema : additionalProperties

Type: object

key value pair of additional attributes

Properties

Nested Schema : customPaymentProperties

Type: object

key value pair of custom attributes

Properties

Nested Schema : additionalProperties

Type: object

key value pair of additional attributes

Properties

Nested Schema : customPaymentProperties

Type: object

key value pair of custom attributes

Properties

Nested Schema : loyaltyPrograms

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

additionalProperties: Type: object additionalProperties

Additional Properties Allowed:

key value pair of additional attributes
loyaltyPointDetails: Type: array loyaltyPointDetails

Required: true

Additional Properties Allowed:
membershipId: Type: string

Required: true

membershipId of the profile.
programId: Type: string

Required: true

programId of Loyalty Program
programName: Type: string

Required: true

programName of Loyalty Program

Nested Schema : additionalProperties

Type: object

key value pair of additional attributes

Properties

Nested Schema : loyaltyPointDetails

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

additionalProperties: Type: object additionalProperties

Additional Properties Allowed:

key value pair of additional attributes
membershipType: Type: string

Required: true

membership type
pointsBalance: Type: string

Required: true

available points balance
pointsType: Type: string

Required: true

points type

Nested Schema : additionalProperties

Type: object

key value pair of additional attributes

Properties

Nested Schema : additionalProperties

Type: object

key value pair of additional attributes

Properties

Nested Schema : customPaymentProperties

Type: object

key value pair of custom attributes

Properties

Example 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"
}