REST API for Oracle Commerce Cloud 21D

calculateRemainingBalance

post

/ccagent/v1/payment/calculateRemainingBalance

Get remaining order amount for mixed currency orders.

Request

Supported Media Types

application/json

Root Schema : calculateRemainingBalance_request

Type: object

Show Source

alternateCurrencyAmount: number

The ammount in alternate currency.
alternateCurrencyCode: string

The alternate currency code.
amount: number

The amount in the order currency.
orderId: string

The order ID.
profileId(optional): string

The profile ID.

{
    "properties":{
        "amount":{
            "description":"The amount in the order currency.",
            "type":"number"
        },
        "orderId":{
            "description":"The order ID.",
            "type":"string"
        },
        "profileId":{
            "description":"The profile ID.",
            "type":"string"
        },
        "alternateCurrencyAmount":{
            "description":"The ammount in alternate currency.",
            "type":"number"
        },
        "alternateCurrencyCode":{
            "description":"The alternate currency code.",
            "type":"string"
        }
    },
    "required":[
        "orderId",
        "amount",
        "alternateCurrencyCode",
        "alternateCurrencyAmount"
    ],
    "example":{
        "amount":20,
        "orderId":"o410438",
        "alternateCurrencyAmount":19,
        "alternateCurrencyCode":"USD"
    }
}

Example:

{
    "amount":20,
    "orderId":"o410438",
    "alternateCurrencyAmount":19,
    "alternateCurrencyCode":"USD"
}

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : calculateRemainingBalance_response

Type: object

Show Source

alternateCurrencyAmount(optional): number

The input amount in alternate currency.
alternateCurrencyAmountRemaining(optional): number

The amount remaining that can be paid in alternate currency.
alternateCurrencyCode(optional): string

The alternate currency code.
amount(optional): number

The input amount in order currency.
amountRemaining(optional): number

The remaining order amount in order currency.
currencyCode(optional): string

The order currency.
minimumMonetaryCurrencyAmountRemaining(optional): number

The minimum monetary currency amount remaining to be paid.
orderId(optional): string

The order ID.
payments(optional): array payments

The array of payment groups
payShippingInSecondaryCurrency(optional): boolean

A site level setting, when enabled, makes it mandatory for the shopper to pay shipping charges in monetary currency. Additionally, if the allowAlternateCurrency flag is enabled then shopper has to pay atleast shipping and tax total in monetary, rest of the amount can be paid in mix of points and monetary currency, or can be paid only in points or only in monetary.
payTaxInSecondaryCurrency(optional): boolean

A site level setting, when enabled, makes it mandatory for the shopper to pay tax in monetary currency. Additionally, if the allowAlternateCurrency flag is enabled then shopper has to pay atleast shipping and tax total in monetary, rest of the amount can be paid in mix of points and monetary currency, or can be paid only in points or only in monetary.
secondaryCurrencyShippingAmount(optional): number

This field represents the shipping amount, shipping discount and shipping surcharge in monetary Currency.\nPrerequisites for the value in this Attribute:\n1. PriceList configured for the site is in custom currency.\n2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
secondaryCurrencyTaxAmount(optional): number

This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. \nPrerequisites for the value in this Attribute: Prerequisites for the value in this Attribute:\n1. PriceList configured for the site is in custom currency.\n2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.\n3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.
state(optional): boolean

The order state.

{
    "properties":{
        "secondaryCurrencyTaxAmount":{
            "description":"This field  represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. \\nPrerequisites for the value in this Attribute: Prerequisites for the value in this Attribute:\\n1. PriceList configured for the site is in custom currency.\\n2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.\\n3.  If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.",
            "type":"number"
        },
        "alternateCurrencyAmountRemaining":{
            "description":"The amount remaining that can be paid in alternate currency.",
            "type":"number"
        },
        "secondaryCurrencyShippingAmount":{
            "description":"This field  represents the shipping amount, shipping discount and shipping surcharge in monetary Currency.\\nPrerequisites for the value in this Attribute:\\n1. PriceList configured for the site is in custom currency.\\n2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.",
            "type":"number"
        },
        "amount":{
            "description":"The input amount in order currency.",
            "type":"number"
        },
        "orderId":{
            "description":"The order ID.",
            "type":"string"
        },
        "payments":{
            "description":"The array of payment groups",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "signature":{
                        "description":"Signature for PayU",
                        "type":"string"
                    },
                    "type":{
                        "description":"PaymentMethodType",
                        "type":"string"
                    },
                    "maskedCardNumber":{
                        "description":"Masked Gift Card Number",
                        "type":"string"
                    },
                    "transactionStatusByQuery":{
                        "description":"Status of tranaction for PayU",
                        "type":"string"
                    },
                    "balance":{
                        "description":"Balance for GiftCard",
                        "type":"number"
                    },
                    "merchantId":{
                        "description":"Merchant ID for PayU",
                        "type":"string"
                    },
                    "paymentId":{
                        "description":"Payment ID for PayU",
                        "type":"string"
                    },
                    "uiIntervention":{
                        "description":"If UI Intervention required",
                        "type":"string"
                    },
                    "id":{
                        "description":"Id for Paypal",
                        "type":"string"
                    },
                    "paymentState":{
                        "description":"Payment State of the payment",
                        "type":"string"
                    },
                    "amount":{
                        "description":"Amount authorized",
                        "type":"number"
                    },
                    "gatewayName":{
                        "description":"Name of the Gateway used to process the payment",
                        "type":"string"
                    },
                    "confirmationUrl":{
                        "description":"Confirmation URL",
                        "type":"string"
                    },
                    "message":{
                        "description":"Error message, if any",
                        "type":"string"
                    },
                    "intent":{
                        "description":"Intent for Paypal",
                        "type":"string"
                    },
                    "signatureAlgorithm":{
                        "description":"Signature Algorithm used for PayU",
                        "type":"string"
                    },
                    "paymentGroupId":{
                        "description":"Payment Group ID relevant to the PaymentMethodType",
                        "type":"string"
                    },
                    "savedCardId":{
                        "description":"Id of the saved card associated with the payment group.",
                        "type":"string"
                    },
                    "responseUrl":{
                        "description":"Response URL",
                        "type":"string"
                    },
                    "accountId":{
                        "description":"Account ID for PayU based on Billing Country",
                        "type":"string"
                    },
                    "customPaymentProperties":{
                        "description":"Custom Payment Properties",
                        "type":"object"
                    },
                    "giftCardNumber":{
                        "description":"Gift Card Number",
                        "type":"string"
                    },
                    "sopUrl":{
                        "description":"URL to be redirected",
                        "type":"string"
                    },
                    "paymentMethod":{
                        "description":"Payment Method Used",
                        "type":"string"
                    },
                    "transaction_state":{
                        "description":"Transaction State for Paypal",
                        "type":"string"
                    },
                    "REDIRECT":{
                        "description":"Redirect URL for Paypal",
                        "type":"string"
                    }
                }
            }
        },
        "alternateCurrencyCode":{
            "description":"The alternate currency code.",
            "type":"string"
        },
        "payShippingInSecondaryCurrency":{
            "description":"A site level setting, when enabled, makes it mandatory for the shopper to pay shipping charges in monetary currency. Additionally, if the allowAlternateCurrency flag is enabled then shopper has to pay atleast shipping and tax total in monetary, rest of the amount can be paid in mix of points and monetary currency, or can be paid only in points or only in monetary.",
            "type":"boolean"
        },
        "payTaxInSecondaryCurrency":{
            "description":"A site level setting, when enabled, makes it mandatory for the shopper to pay tax in monetary currency. Additionally, if the allowAlternateCurrency flag is enabled then shopper has to pay atleast shipping and tax total in monetary, rest of the amount can be paid in mix of points and monetary currency, or can be paid only in points or only in monetary.",
            "type":"boolean"
        },
        "amountRemaining":{
            "description":"The remaining order amount in order currency.",
            "type":"number"
        },
        "alternateCurrencyAmount":{
            "description":"The input amount in alternate currency.",
            "type":"number"
        },
        "state":{
            "description":"The order state.",
            "type":"boolean"
        },
        "minimumMonetaryCurrencyAmountRemaining":{
            "description":"The minimum monetary currency amount remaining to be paid.",
            "type":"number"
        },
        "currencyCode":{
            "description":"The order currency.",
            "type":"string"
        }
    },
    "example":{
        "secondaryCurrencyTaxAmount":0,
        "alternateCurrencyAmountRemaining":"746.0",
        "secondaryCurrencyShippingAmount":425,
        "amount":20,
        "orderId":"o410440",
        "payments":[
            {
                "paymentGroupId":"pg530482",
                "amountAuthorized":20,
                "amount":20,
                "customPaymentProperties":{
                    "1000addnl-property-key5":"1000payment-property-value5",
                    "1000addnl-property-key2":"1000payment-property-value2"
                },
                "gatewayName":"demoLoyaltyPointsPaymentGateway",
                "uiIntervention":null,
                "paymentMethod":"customCurrencyPaymentGroup",
                "isAmountRemaining":false,
                "paymentState":"AUTHORIZED",
                "type":"loyaltyPoints",
                "currencyCode":"silverPts"
            }
        ],
        "alternateAmount":19,
        "alternateCurrencyCode":"USD",
        "payShippingInSecondaryCurrency":true,
        "payTaxInSecondaryCurrency":true,
        "amountRemaining":"20.0",
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:9080/ccagentui/v1/payment/calculateRemainingBalance"
            }
        ],
        "state":"PENDING_PAYMENT",
        "minimumMonetaryCurrencyAmountRemaining":"406.0",
        "currencyCode":"silverPts"
    }
}

Example:

{
    "secondaryCurrencyTaxAmount":0,
    "alternateCurrencyAmountRemaining":"746.0",
    "secondaryCurrencyShippingAmount":425,
    "amount":20,
    "orderId":"o410440",
    "payments":[
        {
            "paymentGroupId":"pg530482",
            "amountAuthorized":20,
            "amount":20,
            "customPaymentProperties":{
                "1000addnl-property-key5":"1000payment-property-value5",
                "1000addnl-property-key2":"1000payment-property-value2"
            },
            "gatewayName":"demoLoyaltyPointsPaymentGateway",
            "uiIntervention":null,
            "paymentMethod":"customCurrencyPaymentGroup",
            "isAmountRemaining":false,
            "paymentState":"AUTHORIZED",
            "type":"loyaltyPoints",
            "currencyCode":"silverPts"
        }
    ],
    "alternateAmount":19,
    "alternateCurrencyCode":"USD",
    "payShippingInSecondaryCurrency":true,
    "payTaxInSecondaryCurrency":true,
    "amountRemaining":"20.0",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/payment/calculateRemainingBalance"
        }
    ],
    "state":"PENDING_PAYMENT",
    "minimumMonetaryCurrencyAmountRemaining":"406.0",
    "currencyCode":"silverPts"
}

Nested Schema : payments

Type: array

The array of payment groups

Show Source

Array of: object items

{
    "description":"The array of payment groups",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "signature":{
                "description":"Signature for PayU",
                "type":"string"
            },
            "type":{
                "description":"PaymentMethodType",
                "type":"string"
            },
            "maskedCardNumber":{
                "description":"Masked Gift Card Number",
                "type":"string"
            },
            "transactionStatusByQuery":{
                "description":"Status of tranaction for PayU",
                "type":"string"
            },
            "balance":{
                "description":"Balance for GiftCard",
                "type":"number"
            },
            "merchantId":{
                "description":"Merchant ID for PayU",
                "type":"string"
            },
            "paymentId":{
                "description":"Payment ID for PayU",
                "type":"string"
            },
            "uiIntervention":{
                "description":"If UI Intervention required",
                "type":"string"
            },
            "id":{
                "description":"Id for Paypal",
                "type":"string"
            },
            "paymentState":{
                "description":"Payment State of the payment",
                "type":"string"
            },
            "amount":{
                "description":"Amount authorized",
                "type":"number"
            },
            "gatewayName":{
                "description":"Name of the Gateway used to process the payment",
                "type":"string"
            },
            "confirmationUrl":{
                "description":"Confirmation URL",
                "type":"string"
            },
            "message":{
                "description":"Error message, if any",
                "type":"string"
            },
            "intent":{
                "description":"Intent for Paypal",
                "type":"string"
            },
            "signatureAlgorithm":{
                "description":"Signature Algorithm used for PayU",
                "type":"string"
            },
            "paymentGroupId":{
                "description":"Payment Group ID relevant to the PaymentMethodType",
                "type":"string"
            },
            "savedCardId":{
                "description":"Id of the saved card associated with the payment group.",
                "type":"string"
            },
            "responseUrl":{
                "description":"Response URL",
                "type":"string"
            },
            "accountId":{
                "description":"Account ID for PayU based on Billing Country",
                "type":"string"
            },
            "customPaymentProperties":{
                "description":"Custom Payment Properties",
                "type":"object"
            },
            "giftCardNumber":{
                "description":"Gift Card Number",
                "type":"string"
            },
            "sopUrl":{
                "description":"URL to be redirected",
                "type":"string"
            },
            "paymentMethod":{
                "description":"Payment Method Used",
                "type":"string"
            },
            "transaction_state":{
                "description":"Transaction State for Paypal",
                "type":"string"
            },
            "REDIRECT":{
                "description":"Redirect URL for Paypal",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

accountId(optional): string

Account ID for PayU based on Billing Country
amount(optional): number

Amount authorized
balance(optional): number

Balance for GiftCard
confirmationUrl(optional): string

Confirmation URL
customPaymentProperties(optional): object customPaymentProperties

Custom Payment Properties
gatewayName(optional): string

Name of the Gateway used to process the payment
giftCardNumber(optional): string

Gift Card Number
id(optional): string

Id for Paypal
intent(optional): string

Intent for Paypal
maskedCardNumber(optional): string

Masked Gift Card Number
merchantId(optional): string

Merchant ID for PayU
message(optional): string

Error message, if any
paymentGroupId(optional): string

Payment Group ID relevant to the PaymentMethodType
paymentId(optional): string

Payment ID for PayU
paymentMethod(optional): string

Payment Method Used
paymentState(optional): string

Payment State of the payment
REDIRECT(optional): string

Redirect URL for Paypal
responseUrl(optional): string

Response URL
savedCardId(optional): string

Id of the saved card associated with the payment group.
signature(optional): string

Signature for PayU
signatureAlgorithm(optional): string

Signature Algorithm used for PayU
sopUrl(optional): string

URL to be redirected
transaction_state(optional): string

Transaction State for Paypal
transactionStatusByQuery(optional): string

Status of tranaction for PayU
type(optional): string

PaymentMethodType
uiIntervention(optional): string

If UI Intervention required

{
    "type":"object",
    "properties":{
        "signature":{
            "description":"Signature for PayU",
            "type":"string"
        },
        "type":{
            "description":"PaymentMethodType",
            "type":"string"
        },
        "maskedCardNumber":{
            "description":"Masked Gift Card Number",
            "type":"string"
        },
        "transactionStatusByQuery":{
            "description":"Status of tranaction for PayU",
            "type":"string"
        },
        "balance":{
            "description":"Balance for GiftCard",
            "type":"number"
        },
        "merchantId":{
            "description":"Merchant ID for PayU",
            "type":"string"
        },
        "paymentId":{
            "description":"Payment ID for PayU",
            "type":"string"
        },
        "uiIntervention":{
            "description":"If UI Intervention required",
            "type":"string"
        },
        "id":{
            "description":"Id for Paypal",
            "type":"string"
        },
        "paymentState":{
            "description":"Payment State of the payment",
            "type":"string"
        },
        "amount":{
            "description":"Amount authorized",
            "type":"number"
        },
        "gatewayName":{
            "description":"Name of the Gateway used to process the payment",
            "type":"string"
        },
        "confirmationUrl":{
            "description":"Confirmation URL",
            "type":"string"
        },
        "message":{
            "description":"Error message, if any",
            "type":"string"
        },
        "intent":{
            "description":"Intent for Paypal",
            "type":"string"
        },
        "signatureAlgorithm":{
            "description":"Signature Algorithm used for PayU",
            "type":"string"
        },
        "paymentGroupId":{
            "description":"Payment Group ID relevant to the PaymentMethodType",
            "type":"string"
        },
        "savedCardId":{
            "description":"Id of the saved card associated with the payment group.",
            "type":"string"
        },
        "responseUrl":{
            "description":"Response URL",
            "type":"string"
        },
        "accountId":{
            "description":"Account ID for PayU based on Billing Country",
            "type":"string"
        },
        "customPaymentProperties":{
            "description":"Custom Payment Properties",
            "type":"object"
        },
        "giftCardNumber":{
            "description":"Gift Card Number",
            "type":"string"
        },
        "sopUrl":{
            "description":"URL to be redirected",
            "type":"string"
        },
        "paymentMethod":{
            "description":"Payment Method Used",
            "type":"string"
        },
        "transaction_state":{
            "description":"Transaction State for Paypal",
            "type":"string"
        },
        "REDIRECT":{
            "description":"Redirect URL for Paypal",
            "type":"string"
        }
    }
}

Nested Schema : customPaymentProperties

Type: object

Custom Payment Properties

Default Response

The error response

Root Schema : errorModel

Type: object

Show Source

devMessage(optional): string

An optional non-localized message containing technical information for developers
errorCode(optional): string

The numerical code identifying the error
errors(optional): array errors

An optional list of errors if multiple errors were encountered
message(optional): string

The localized message describing the error
moreInfo(optional): string

An optional non-localized message with more information
o:errorPath(optional): string

An optional machine readable description of where the error occurred
status(optional): string

The HTTP status code
type(optional): string

The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

devMessage(optional): string

An optional non-localized message containing technical information for developers
errorCode(optional): string

The numerical code identifying the error
message(optional): string

The localized message describing the error
moreInfo(optional): string

An optional non-localized message with more information
o:errorPath(optional): string

An optional machine readable description of where the error occurred
status(optional): string

The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}