Skip to main content

ResponseWrapperListCarteDto

Response for list of cards

statusstring

Status of the response

Possible values: [SUCCESS, ERROR]

Example: ERROR/SUCCESS
messagestring

Message describing the response

Example: Request failed/Request successful
codeMessagestring

Code message describing the response

Example: ERR-001/SUC-001
data object

Represents paginated results.

content object[]

The list of items in the current page.

  • Array [
  • isInternationnalint32

    International card

    Example: 1
    eligibleModificationPlafondsboolean
    cvvstring

    Card CVV

    Example: 123
    contactLessstring
    cardIdstring
    referenceNumberstring

    Reference number

    Example: card_50035661_13600580
    cardTypestring

    Card type

    Example: Prépayé
    cardNumberstring

    Card number

    Example: 471264******8842
    accountNumberstring

    Account number

    Example: 1200054915582
    cardNumberPcistring

    Card number PCI

    Example: 4712
    holderLastNamestring

    Card holder last name

    Example: Essalaoui
    holderFirstNamestring

    Card holder first name

    Example: Mohamed
    statusstring

    Card status

    Example: Active
    statusLabelstring

    Card status label

    Example: Active
    accountCurrencystring

    Account currency

    Example: MAD
    cardAmountstring

    Card amount

    Example: 1000
    validityDatestring
    creationDatestring

    Creation (format dd-MM-yyyy)

    Example: 20-12-2024
    expirationDatestring

    Expiration date (format MM/YY)

    Example: 01/25
    startValDatestring

    Start date of validity (format dd-MM-yyyy)

    Example: 20-12-2024
    cardHolderAgencyCodestring

    Card holder agency code

    Example: 00000
    dailyLocalMoneyDepositstring
    cardProductTypestring

    Possible values: [PREPAID, DEBIT, CARTECLUB, CARTESELECT, CARTECOMPTEEPARGNE, CARTEPREPAYE, PREPAYEMASTER, GIMPURDDA, GIMPUR, PREPAYEEMASTERDDA, VISACLASSICSANSCONTACT, VISAGOLDSANSCONTACT, PREPAYEEMASTERCARDCONTACTLESS]

    renewalOptionboolean

    Renewal option

    Example: false
    genericCardLimits object[]
  • Array [
  • serviceCodestring

    Service code

    Example: GLOBAL
    serviceLabelstring

    Service label

    Example: Plafond Global
    cardLimitsByType object[]
  • Array [
  • typeCodestring

    The type code of the card

    Example: GLOBAL
    valuestring

    The value associated with the card

    Example: 3000
    valueFormattedstring

    The formatted value of the card

    Example: 3000 MAD
    maximumnumber

    The maximum card limit

    Example: 5000
    minimumnumber

    The minimum card limit

    Example: 1000
    endDatestring

    The end date of the card's validity (format : dd-MM-yyyy)

    Example: 12-02-2024
    eligibleModificationboolean
    typeLabelstring

    The type label of the card

    Example: Standard
    consumedAmountstring

    The consumed amount on the card

    Example: 250
    consumedPercentagestring

    The percentage of the card that has been consumed

    Example: 25
    limitTypeLabelstring

    The plafond (limit) type label

    Example: Credit Limit
  • ]
  • ]
  • isEligibleForLimitModificationboolean

    Eligibility for limit modification

    Example: true
    cardBalancestring

    Card balance

    Example: 1 000,00 MAD
    cardImagestring

    Card image (eg: format base64)

    Example: DFlQMFvU7s3Wqr8JHCvmlR95hBx5mUqr/lY
    currentStatusstring

    Current status

    Example: false
    plasticCodestring

    Plastic code

    Example: 471264******8842
    cardHolderstring

    Card holder

    Example: Essalaoui
    activationDatestring

    Activation date (format dd-MM-yyyy)

    Example: 20-12-2024
    isContactlessstring

    Contactless card

    Example: false
    isValidint32

    Card validity

    Example: 1
    bankAccountNumberstring

    Bank account number

    Example: 1200054915582
    cardHolderReferencestring

    Card holder reference

    Example: card_50035661_13600580
    isDeferredboolean

    Deferred card

    Example: false
    cardIdentificationstring

    Card identification

    Example: card_50035661_13600580
    imageUrlstring

    Card image URL

    Example: /images/card_50035661_13600580.png
    cardTypeCodestring

    Card type code

    Example: 71881
    cardUsagestring
    cardPhoneNumberstring

    Card phone number

    Example: +212600000000
    statestring

    Card state

    Example: Active
    cardHolderNamestring

    Card holder name

    Example: Essalaoui
    holderIdentificationstring

    Card holder identification

    Example: 14447
    cardTokenstring

    Card token

    Example: card_50036121_13600580
    externalContractReferencestring

    External contract reference

    Example: REF_CONTRAT_EXTERNE
    unsecurePaymentStatusLabelstring

    Unsecure payment status label

    Example: Active
    billingAccountstring

    The account used for billing purposes

    Example: 1200054915582
  • ]
  • totalElementsint64

    The total number of elements across all pages.

    Example: 100
    totalPagesint32

    The total number of pages available.

    Example: 10
    numberint32

    The current page number (zero-based).

    Example: 0
    sizeint32

    The number of items per page.

    Example: 10
    error object

    Detailed information about the error response

    codestring

    Error code

    Example: ERR-142
    messagestring

    Error message

    Example: Resource not found / Internal server error
    details object[]

    List of error details

  • Array [
  • codestring

    Error code

    Example: ER4001
    messagestring

    Detailed error message

    Example: Invalid input
    targetstring

    Target of the error

    Example: username
  • ]
  • suggestionsstring[]

    List of suggestions for resolving the error

    Example: ["Check the resource ID","Ensure the resource exists"]
    metaData object

    Additional metadata about the error, that could help in debugging

    property name*string

    Additional metadata about the error, that could help in debugging

    Example: {"requestId":"3c5e4cebf39cbc5b","operationId":"66fd4d2ae6b6"}
    timestampdate-time

    Timestamp of when the response was generated

    ResponseWrapperListCarteDto
    {
    "status": "ERROR/SUCCESS",
    "message": "Request failed/Request successful",
    "codeMessage": "ERR-001/SUC-001",
    "data": {
    "content": [
    {
    "isInternationnal": 1,
    "eligibleModificationPlafonds": true,
    "cvv": "123",
    "contactLess": "string",
    "cardId": "string",
    "referenceNumber": "card_50035661_13600580",
    "cardType": "Prépayé",
    "cardNumber": "471264******8842",
    "accountNumber": "1200054915582",
    "cardNumberPci": "4712",
    "holderLastName": "Essalaoui",
    "holderFirstName": "Mohamed",
    "status": "Active",
    "statusLabel": "Active",
    "accountCurrency": "MAD",
    "cardAmount": "1000",
    "validityDate": "string",
    "creationDate": "20-12-2024",
    "expirationDate": "01/25",
    "startValDate": "20-12-2024",
    "cardHolderAgencyCode": "00000",
    "dailyLocalMoneyDeposit": "string",
    "cardProductType": "PREPAID",
    "renewalOption": false,
    "genericCardLimits": [
    {
    "serviceCode": "GLOBAL",
    "serviceLabel": "Plafond Global",
    "cardLimitsByType": [
    {
    "typeCode": "GLOBAL",
    "value": "3000",
    "valueFormatted": "3000 MAD",
    "maximum": 5000,
    "minimum": 1000,
    "endDate": "12-02-2024",
    "eligibleModification": true,
    "typeLabel": "Standard",
    "consumedAmount": "250",
    "consumedPercentage": "25",
    "limitTypeLabel": "Credit Limit"
    }
    ]
    }
    ],
    "isEligibleForLimitModification": true,
    "cardBalance": "1 000,00 MAD",
    "cardImage": "DFlQMFvU7s3Wqr8JHCvmlR95hBx5mUqr/lY",
    "currentStatus": "false",
    "plasticCode": "471264******8842",
    "cardHolder": "Essalaoui",
    "activationDate": "20-12-2024",
    "isContactless": "false",
    "isValid": 1,
    "bankAccountNumber": "1200054915582",
    "cardHolderReference": "card_50035661_13600580",
    "isDeferred": false,
    "cardIdentification": "card_50035661_13600580",
    "imageUrl": "/images/card_50035661_13600580.png",
    "cardTypeCode": "71881",
    "cardUsage": "string",
    "cardPhoneNumber": "+212600000000",
    "state": "Active",
    "cardHolderName": "Essalaoui",
    "holderIdentification": "14447",
    "cardToken": "card_50036121_13600580",
    "externalContractReference": "REF_CONTRAT_EXTERNE",
    "unsecurePaymentStatusLabel": "Active",
    "billingAccount": "1200054915582"
    }
    ],
    "totalElements": 100,
    "totalPages": 10,
    "number": 0,
    "size": 10
    },
    "error": {
    "code": "ERR-142",
    "message": "Resource not found / Internal server error",
    "details": [
    {
    "code": "ER4001",
    "message": "Invalid input",
    "target": "username"
    }
    ],
    "suggestions": [
    "Check the resource ID",
    "Ensure the resource exists"
    ],
    "metaData": {
    "requestId": "3c5e4cebf39cbc5b",
    "operationId": "66fd4d2ae6b6"
    }
    },
    "timestamp": "2024-07-29T15:51:28.071Z"
    }