Jump to

• Request
• Response

Retrieves payment method types of logged in profile

get

/ccstore/v1/selfservice/payments/paymentMethodTypes

Retrieves all active orders associated with the organization of logged in profile in the currently authenticated session. If the profile is not logged in or is anonymous then the endpoint will fail. Please refer to Fusion Order Management REST API more detailed attributes.

Request

Supported Media Types

• application/json

Query Parameters

• limit: integer
  Specifies the number of orders to be retrieved starting from offset. Default value for the limit is 25 and max value is also 25. In case this is not present, complete list or max limit list (whichever is lower) of orders will be returned.
• offset: integer
  Starting index when paging through orders.
• orderBy: string
  The sort order
• q: string
  The query to use
• totalResults: boolean
  Calculate total results count

  Default Value: false

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returned when operation succeeds.

Body ()

Root Schema : getPaymentMethodTypes_success_response

Type: object

Show Source

• count: integer
  The number of items returned
• hasMore: boolean
  Whether there are more items available
• items: array items
• limit: integer
  The maximum number of items per page
• offset: integer
  The offset of the current page

{
    "type":"object",
    "properties":{
        "offset":{
            "description":"The offset of the current page",
            "type":"integer"
        },
        "count":{
            "description":"The number of items returned",
            "type":"integer"
        },
        "hasMore":{
            "description":"Whether there are more items available",
            "type":"boolean"
        },
        "limit":{
            "description":"The maximum number of items per page",
            "type":"integer"
        },
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "Description":{
                        "description":"The description of the payment method type",
                        "type":"string"
                    },
                    "Meaning":{
                        "description":"The meaning of the payment method type",
                        "type":"string"
                    },
                    "LookupCode":{
                        "description":"The lookup code of the payment method type",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "Description":{
                "description":"The description of the payment method type",
                "type":"string"
            },
            "Meaning":{
                "description":"The meaning of the payment method type",
                "type":"string"
            },
            "LookupCode":{
                "description":"The lookup code of the payment method type",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• Description: string
  The description of the payment method type
• LookupCode: string
  The lookup code of the payment method type
• Meaning: string
  The meaning of the payment method type

{
    "type":"object",
    "properties":{
        "Description":{
            "description":"The description of the payment method type",
            "type":"string"
        },
        "Meaning":{
            "description":"The meaning of the payment method type",
            "type":"string"
        },
        "LookupCode":{
            "description":"The lookup code of the payment method type",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "offset":0,
    "count":3,
    "hasMore":false,
    "limit":25,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstore/v1/selfservice/payments/paymentMethodTypes"
        }
    ],
    "items":[
        {
            "Description":"A purchase order is used as the payment method for the subscription.",
            "@context":{
                "key":"ORA_PURCHASE_ORDER"
            },
            "Meaning":"Purchase order",
            "LookupCode":"ORA_PURCHASE_ORDER"
        },
        {
            "Description":"A wire number identifying the electronic funds transfer is used as the payment method for the subscription.",
            "@context":{
                "key":"ORA_WIRE"
            },
            "Meaning":"Wire",
            "LookupCode":"ORA_WIRE"
        },
        {
            "Description":"Credit card is used as the payment method for the subscription.",
            "@context":{
                "key":"ORA_CREDIT_CARD"
            },
            "Meaning":"Credit card",
            "LookupCode":"ORA_CREDIT_CARD"
        }
    ]
}

401 Response

Returned when operation fails.

Body ()

Root Schema : getPaymentMethodTypes_401_failure_response

Example Response (application/json)

{
    "errorCode":"00001000",
    "message":"The user is not authenticated.",
    "status":"401"
}

500 Response

Returned when operation fails.

Body ()

Root Schema : getPaymentMethodTypes_500_failure_response

Example Response (application/json)

{
    "errorCode":"59004",
    "message":"Error occurred while making socket connection.",
    "status":"500"
}

Back to Top