REST API for Oracle Commerce Cloud December 2017

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: Type: string

Required: true

Header Parameters

X-CCAsset-Language: Type: string

The asset language of the request

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getPaymentGroup_response

Properties

amountAuthorized: Type: string

Amount authorized by the payment gateway.
authorizationStatus: Type: object authorizationStatus

Additional Properties Allowed:

Object having details about the status of authorization
id: Type: string

The id of the payment group item.
stateAsString: Type: string

Payment group state in string after authorization.

Nested Schema : authorizationStatus

Type: object

Object having details about the status of authorization

Properties

authorizationDecision: Type: string

Decision from authorization
displayMessage: Type: string

User friendly message in case authorization fails.
reasonCode: Type: string

Authorization outcome reason code specific to CyberSource
transactionSuccess: Type: string

Whether transaction was successful or failed.
transactionUuid: Type: string

Unique Transaction id sent by storefront to CyberSource to correlate the response data with order once the response arrives

Example 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

Properties

devMessage: Type: string

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

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

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

The localized message describing the error
moreInfo: Type: string

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

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

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

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

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

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

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

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "amountAuthorized": 114.5,
  "stateAsString": "AUTHORIZED",
  "id": "pg10008",
  "authorizationStatus": [{
    "authorizationDecision": "ACCEPT",
    "transactionUuid": "2c82277e4af747dab536dd2591e185a3",
    "displayMessage": "",
    "transactionSuccess": true,
    "reasonCode": "100"
  }]
}