Jump to

• Request
• Response

Retrieve list of registered credit cards for a profile

get

/spms/v1/financials/payments/cards/{profileId}

This is to retrieve a list of all registered credit cards for a profile

Request

Supported Media Types

• application/json

Path Parameters

• profileId(required): integer(int64)
  profileId

Query Parameters

• isActive: boolean
  Minimum Value: 0

  Activation status of the credit card: * `true` - credit card is active * `false` - credit card is inactive
• orderBy: string
  Minimum Value: 0

  Order By cardID, cardNumber, expirationDate, cardType, displayName, isActive, invoiceWindows with format column1:asc/desc,column2:asc/desc

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Credit Card Information Response

Type: object

Title: Credit Card Information Response

Credit Card Information Response

Show Source

• count: integer
  Example: 12345678
• hasMore: boolean
  Example: true
• items: array items
• limit: integer
  Example: 10
• offset: integer
  Example: 1

{
    "title":"Credit Card Information Response",
    "description":"Credit Card Information Response",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "example":12345678
        },
        "hasMore":{
            "type":"boolean",
            "example":true
        },
        "offset":{
            "type":"integer",
            "example":1
        },
        "limit":{
            "type":"integer",
            "example":10
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/creditCardInformation"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Credit Card Information
  Title: Credit Card Information

  Credit Card Information

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/creditCardInformation"
    }
}

Nested Schema : Credit Card Information

Type: object

Title: Credit Card Information

Credit Card Information

Show Source

• cardID: number
  Credit Card record Id

  Example: 12345
• cardNumber: string
  Credit Card Number

  Example: xxxxxxxxxxxx1234
• cardType: string
  Credit Card type

  Example: VI
• depositLimit: number
  Deposit limit for the credit card

  Example: 1000.00
• displayName: string
  Credit Card Display Name

  Example: FIRST NAME SURNAME
• expirationDate: string
  Credit Card Expiry date

  Example: 01-2025
• invoiceWindows: string
  Assigned Invoice windows number. 0 - All invoices and 1,2,3,4 - other invoice windows number

  Example: 0
• isActive: boolean
  Credit card active status

  Example: true
• isDebit: boolean
  Is Debit Card

  Example: false
• ownerName: string
  Credit Card Owner Name

  Example: FIRST NAME SURNAME

{
    "title":"Credit Card Information",
    "description":"Credit Card Information",
    "type":"object",
    "properties":{
        "cardID":{
            "type":"number",
            "description":"Credit Card record Id",
            "example":"12345"
        },
        "ownerName":{
            "type":"string",
            "description":"Credit Card Owner Name",
            "example":"FIRST NAME SURNAME"
        },
        "cardNumber":{
            "type":"string",
            "description":"Credit Card Number",
            "example":"xxxxxxxxxxxx1234"
        },
        "expirationDate":{
            "type":"string",
            "description":"Credit Card Expiry date",
            "example":"01-2025"
        },
        "depositLimit":{
            "type":"number",
            "description":"Deposit limit for the credit card",
            "example":"1000.00"
        },
        "cardType":{
            "type":"string",
            "description":"Credit Card type",
            "example":"VI"
        },
        "isDebit":{
            "type":"boolean",
            "description":"Is Debit Card",
            "example":"false"
        },
        "displayName":{
            "type":"string",
            "description":"Credit Card Display Name",
            "example":"FIRST NAME SURNAME"
        },
        "isActive":{
            "type":"boolean",
            "description":"Credit card active status",
            "example":true
        },
        "invoiceWindows":{
            "type":"string",
            "description":"Assigned Invoice windows number. 0 - All invoices and 1,2,3,4 - other invoice windows number",
            "example":"0"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CreditCardInformationErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"The parameter profileid has incorrect format"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"The parameter profileid has incorrect format"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CreditCardInformationErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Unauthorized",
        "detail":"Valid token is required to access this resource"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorized",
    "detail":"Valid token is required to access this resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

403 Response

Forbidden

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CreditCardInformationErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource was forbidden"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource was forbidden"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CreditCardInformationErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"This resource path does not exist"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"This resource path does not exist"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

405 Response

Method Not Allowed

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CreditCardInformationErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
        "title":"Method Not Supported",
        "detail":"HTTP method not supported for this resource"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
    "title":"Method Not Supported",
    "detail":"HTTP method not supported for this resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

406 Response

Not Acceptable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CreditCardInformationErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
        "title":"Not Acceptable",
        "detail":"Request a Mime type that is supported for this Resource"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
    "title":"Not Acceptable",
    "detail":"Request a Mime type that is supported for this Resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CreditCardInformationErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
        "title":"Internal Server Error",
        "detail":"Issue fulfilling request. Please retry or contact support"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
    "title":"Internal Server Error",
    "detail":"Issue fulfilling request. Please retry or contact support"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/CreditCardInformationErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service Unavailable.  Try again later"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service Unavailable.  Try again later"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

Back to Top