Jump to

• Request
• Response

getPaymentGroup

get

/ccagent/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

• application/json

Path Parameters

• id: string

Header Parameters

• X-CCAsset-Language(optional): string
  The asset language of the request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getPaymentGroup_response

Type: object

Show Source

• amountAuthorized(optional): string
  Amount authorized by the payment gateway.
• authorizationStatus(optional): object authorizationStatus
  Object having details about the status of authorization
• customPaymentProperties(optional): object customPaymentProperties
  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.
• id(optional): string
  The id of the payment group item.
• stateAsString(optional): string
  Payment group state in string after authorization.

{
    "properties":{
        "amountAuthorized":{
            "description":"Amount authorized by the payment gateway.",
            "type":"string"
        },
        "customPaymentProperties":{
            "description":"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.",
            "type":"object"
        },
        "stateAsString":{
            "description":"Payment group state in string after authorization.",
            "type":"string"
        },
        "id":{
            "description":"The id of the payment group item.",
            "type":"string"
        },
        "authorizationStatus":{
            "description":"Object having details about the status of authorization",
            "type":"object",
            "properties":{
                "authorizationDecision":{
                    "description":"Decision from authorization",
                    "type":"string"
                },
                "transactionUuid":{
                    "description":"Unique Transaction id sent by storefront to CyberSource to correlate the response data with order once the response arrives",
                    "type":"string"
                },
                "displayMessage":{
                    "description":"User friendly message in case authorization fails.",
                    "type":"string"
                },
                "transactionSuccess":{
                    "description":"Whether transaction was successful or failed.",
                    "type":"string"
                },
                "reasonCode":{
                    "description":"Authorization outcome reason code specific to CyberSource",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : authorizationStatus

Type: object

Object having details about the status of authorization

Show Source

• authorizationDecision(optional): string
  Decision from authorization
• displayMessage(optional): string
  User friendly message in case authorization fails.
• reasonCode(optional): string
  Authorization outcome reason code specific to CyberSource
• transactionSuccess(optional): string
  Whether transaction was successful or failed.
• transactionUuid(optional): string
  Unique Transaction id sent by storefront to CyberSource to correlate the response data with order once the response arrives

{
    "description":"Object having details about the status of authorization",
    "type":"object",
    "properties":{
        "authorizationDecision":{
            "description":"Decision from authorization",
            "type":"string"
        },
        "transactionUuid":{
            "description":"Unique Transaction id sent by storefront to CyberSource to correlate the response data with order once the response arrives",
            "type":"string"
        },
        "displayMessage":{
            "description":"User friendly message in case authorization fails.",
            "type":"string"
        },
        "transactionSuccess":{
            "description":"Whether transaction was successful or failed.",
            "type":"string"
        },
        "reasonCode":{
            "description":"Authorization outcome reason code specific to CyberSource",
            "type":"string"
        }
    }
}

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

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

Back to Top