Jump to

• Request
• Response

Get payment by ID

get

/ccstore/v1/orders/current/payments/{id}

This API is used by the CX Commerce OSF Storefront. This API is currently not used by CX Commerce Classic Storefront but may be used in the future. It may be used in applications outside of CX Commerce Storefront.

Get payment details retained on the cart (current incomplete order) for the given payment group ID.

This endpoint is part of a group of APIs used in conjunction with each other to perform granular actions on the cart (current incomplete order).

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The ID of the payment to retrieve.

Header Parameters

• X-CCOrganization(optional): string
  Current organization context of the logged in user
• X-CCVisitorId(optional): string
  ID provided by the Oracle Commerce Visit Service to uniquely identify the current visitor. It is required for every request to enable full endpoint capabilities for all shopper types.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The model being returned when the GET operation succeeds. It contains the details of the shipping group in the current order for the given shipping group ID.

Body ()

Root Schema : getPayment_response

Type: object

Show Source

• items(optional): object items

{
    "properties":{
        "items":{
            "type":"object",
            "properties":{
                "amount":{
                    "description":"Amount to be authorized from the gift card or store credit.",
                    "type":"number"
                },
                "paymentExpired":{
                    "description":"A boolean to indicate the added payment is expired.",
                    "type":"boolean"
                },
                "customProperties":{
                    "description":"Custom object with dynamic properties. This will be passed to the webhook request",
                    "type":"object"
                },
                "balance":{
                    "description":"Total available balance on the gift card or store credit.",
                    "type":"number"
                },
                "giftCardNumber":{
                    "description":"Gift card number used for payment. Payment type:physicalGiftCard.",
                    "type":"string"
                },
                "storeCreditNumber":{
                    "description":"Store credit number used for payment. Payment type:storeCredit.",
                    "type":"string"
                },
                "gatewayName":{
                    "description":"Payment gateway name. e.g. chaseGiftCard.",
                    "type":"string"
                },
                "giftCardPin":{
                    "description":"Gift card pin. Payment type:physicalGiftCard.",
                    "type":"string"
                },
                "paymentMethod":{
                    "description":"Payment method. e.g. physicalGiftCard/ store credit.",
                    "type":"string"
                },
                "isAmountRemaining":{
                    "description":"A boolean to decide if more payment can be made from this payment.",
                    "type":"boolean"
                },
                "type":{
                    "description":"Payment type: physicalGiftCard, storeCredit",
                    "type":"string"
                },
                "paymentState":{
                    "description":"The state of the payment group. e.g. INITIAL.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• amount(optional): number
  Amount to be authorized from the gift card or store credit.
• balance(optional): number
  Total available balance on the gift card or store credit.
• customProperties(optional): object customProperties
  Custom object with dynamic properties. This will be passed to the webhook request
• gatewayName(optional): string
  Payment gateway name. e.g. chaseGiftCard.
• giftCardNumber(optional): string
  Gift card number used for payment. Payment type:physicalGiftCard.
• giftCardPin(optional): string
  Gift card pin. Payment type:physicalGiftCard.
• isAmountRemaining(optional): boolean
  A boolean to decide if more payment can be made from this payment.
• paymentExpired(optional): boolean
  A boolean to indicate the added payment is expired.
• paymentMethod(optional): string
  Payment method. e.g. physicalGiftCard/ store credit.
• paymentState(optional): string
  The state of the payment group. e.g. INITIAL.
• storeCreditNumber(optional): string
  Store credit number used for payment. Payment type:storeCredit.
• type(optional): string
  Payment type: physicalGiftCard, storeCredit

{
    "type":"object",
    "properties":{
        "amount":{
            "description":"Amount to be authorized from the gift card or store credit.",
            "type":"number"
        },
        "paymentExpired":{
            "description":"A boolean to indicate the added payment is expired.",
            "type":"boolean"
        },
        "customProperties":{
            "description":"Custom object with dynamic properties. This will be passed to the webhook request",
            "type":"object"
        },
        "balance":{
            "description":"Total available balance on the gift card or store credit.",
            "type":"number"
        },
        "giftCardNumber":{
            "description":"Gift card number used for payment. Payment type:physicalGiftCard.",
            "type":"string"
        },
        "storeCreditNumber":{
            "description":"Store credit number used for payment. Payment type:storeCredit.",
            "type":"string"
        },
        "gatewayName":{
            "description":"Payment gateway name. e.g. chaseGiftCard.",
            "type":"string"
        },
        "giftCardPin":{
            "description":"Gift card pin. Payment type:physicalGiftCard.",
            "type":"string"
        },
        "paymentMethod":{
            "description":"Payment method. e.g. physicalGiftCard/ store credit.",
            "type":"string"
        },
        "isAmountRemaining":{
            "description":"A boolean to decide if more payment can be made from this payment.",
            "type":"boolean"
        },
        "type":{
            "description":"Payment type: physicalGiftCard, storeCredit",
            "type":"string"
        },
        "paymentState":{
            "description":"The state of the payment group. e.g. INITIAL.",
            "type":"string"
        }
    }
}

Nested Schema : customProperties

Type: object

Custom object with dynamic properties. This will be passed to the webhook request

Example Response (application/json)

{
    "paymentGroupId":"pg230440",
    "amount":27.4,
    "customPaymentProperties":{
    },
    "balance":"27.4",
    "gatewayName":"demoGenericGiftCardGateway",
    "giftCardNumber":"6035718888920014103",
    "paymentMethod":"physicalGiftCard",
    "isAmountRemaining":false,
    "links":[
        {
            "method":"DELETE",
            "rel":"/rels/deletePayment",
            "href":"http://localhost:8080/ccstoreui/v1/orders/current/payments/pg230440"
        },
        {
            "method":"GET",
            "rel":"self",
            "href":"http://localhost:8080/ccstoreui/v1/orders/current/payments/pg230440"
        },
        {
            "method":"GET",
            "rel":"canonical",
            "href":"http://localhost:8080/ccstoreui/v1/orders/current/payments/pg230440"
        },
        {
            "method":"PATCH",
            "rel":"/rels/updatePayment",
            "href":"http://localhost:8080/ccstoreui/v1/orders/current/payments/pg230440"
        }
    ],
    "paymentState":"INITIAL",
    "maskedCardNumber":"xxxxxxxxxxxxxxx4103"
}

400 Response

The error response (which alternates to the default response depending on error reason).

Body ()

Root Schema : errorModelSingleError

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

Default Response

The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:

Error Code	Description	Possible Fix
29008	The payment was not found in the current order (cart)	Verify you have entered a valid payment ID.

The error response:

Body ()

Root Schema : errorModelMultiErrors

Type: object

Show Source

• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "message":{
            "description":"The localized message describing the error",
            "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