getPaymentGroup

get

/ccstore/v1/paymentGroups/{id}

Get Payment Group. Get PaymentGroup authorization status an order. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types
Path Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getPaymentGroup_response
Type: object
Show Source
Nested Schema : authorizationStatus
Type: object
Object having details about the status of authorization
Show Source
Nested Schema : customPaymentProperties
Type: object
This is a map of externalProperties and their values from statusProps from paymentGroup status. This property is only populated when externalProperties are present in paymentGroup. The paymentGroup status is picked up depending on the payment group state, authorizationStatus for AUTHORIZED and debitStatus for SETTLED.
Example Response (application/json)
{
    "amountAuthorized":114.5,
    "stateAsString":"AUTHORIZED",
    "id":"pg10008",
    "authorizationStatus":[
        {
            "authorizationDecision":"ACCEPT",
            "transactionUuid":"2c82277e4af747dab536dd2591e185a3",
            "displayMessage":"",
            "transactionSuccess":true,
            "reasonCode":"100"
        }
    ]
}

Default Response

The error response
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top