CardReportRequest

{
    "type": "object",
    "properties": {
        "cardIssue": {
            "$ref": "#/definitions/CardIssue"
        }
    },
    "required": [
        "cardIssue"
    ]
}
              

CardIssue

{
    "type": "object",
    "properties": {
        "accountId": {
            "description": "Unique ID used by front end to identify the account",
            "type": "string",
            "example": "123456"
        },
        "reportTypeCode": {
            "description": "Code to indicate the type of the report. Values: Lost and Stolen request (Request flag = T), Damage Card Replacement (Request flag = R), Blocking request (Request flag = B), Other request (Request flag = Z).",
            "type": "string",
            "example": "T"
        },
        "cardBlockCode": {
            "description": "Card block Codes. Possibles values are in AMCR file (AMCR-LB-LM-BLK).",
            "type": "string",
            "example": "L"
        },
        "blockReasonCode": {
            "description": "The reason for blocking the card. For eg: The card is stolen while travelling.",
            "type": "string",
            "example": "01"
        },
        "feeCode": {
            "description": "Code to indicate how the replacement need to be payed. Valid values are B, N, Y and U",
            "type": "string",
            "example": "B"
        },
        "replacementReason": {
            "description": "Reason of the replacement of the card. Possible values E, O, B, G, U",
            "type": "string",
            "example": "E"
        }
    },
    "required": [
        "accountId",
        "reportTypeCode",
        "cardBlockCode",
        "feeCode",
        "replacementReason"
    ]
}
              

CardReportResponse

{
    "type": "object",
    "properties": {
        "reportFolioId": {
            "description": "Unique Id to identify the operation. It is generated by the folio operation service used for tracking.",
            "type": "string",
            "example": "05235e5da96d000001"
        },
        "cardPlastic": {
            "$ref": "#/definitions/CardPlastic"
        },
        "address": {
            "$ref": "#/definitions/AddressInformation"
        }
    },
    "required": [
        "reportFolioId",
        "cardPlastic",
        "address"
    ]
}
              

CardPlastic

{
    "type": "object",
    "properties": {
        "displayCardNumber": {
            "description": "The last 4 digits of the new card number.",
            "type": "string",
            "example": "3523"
        }
    },
    "required": [
        "displayCardNumber"
    ]
}
              

AddressInformation

{
    "type": "object",
    "properties": {
        "postalCode": {
            "description": "Postal code of the address.",
            "type": "string",
            "example": "06500"
        },
        "colonyName": {
            "description": "Name of the Colony.",
            "type": "string",
            "example": "Cuauhtemoc"
        },
        "lastUpdatedDate": {
            "description": "Last time the address was updated",
            "type": "string",
            "format": "date",
            "example": "2018-02-02",
            "maxLength": 10
        }
    },
    "required": [
        "postalCode",
        "colonyName",
        "lastUpdatedDate"
    ]
}
              

CardDeliveryBranchRequest

{
    "type": "object",
    "properties": {
        "branchId": {
            "description": "Unique identifier for the branch.",
            "type": "string",
            "example": "1234"
        },
        "branchName": {
            "description": "Name of the branch.",
            "type": "string",
            "example": "Patio Santa fe"
        },
        "accountId": {
            "description": "Unique ID used by front end to identify the account",
            "type": "string",
            "example": "123456"
        },
        "reportFolioId": {
            "description": "Unique Id to identify the operation. It is generated by the folio operation service, used  for tracking",
            "type": "string",
            "example": "123456"
        },
        "branchAddress": {
            "$ref": "#/definitions/AddressInfo"
        }
    },
    "required": [
        "branchId",
        "branchName"
    ]
}
              

AddressInfo

{
    "type": "object",
    "properties": {
        "colonyName": {
            "description": "Name of the Colony of the bank branch.",
            "type": "string",
            "example": "Cuauhtemoc"
        },
        "postalCode": {
            "description": "Postal code of the bank branch.",
            "type": "string",
            "example": "06500"
        },
        "city": {
            "description": "City of the bank branch.",
            "type": "string",
            "example": "Mexico City"
        },
        "streetName": {
            "description": "The name on a street of the bank branch.",
            "type": "string",
            "example": "Rio de la plata"
        }
    },
    "required": [
        "colonyName",
        "postalCode",
        "city",
        "streetName"
    ]
}
              

CardDeliveryBranchResponse

{
    "type": "object",
    "properties": {
        "displayCardNumber": {
            "description": "The last 4 digits of the card number.",
            "type": "string",
            "example": "3523"
        },
        "deliveryFolioId": {
            "description": "Folio ID for the query obtained from this rescue/ send card request. It is generated by the folio operation service, used  for tracking",
            "type": "string",
            "example": "05235e5da96d000001"
        },
        "branchId": {
            "description": "Unique identifier for the branch.",
            "type": "string",
            "example": "1234"
        },
        "branchName": {
            "description": "Name of the branch.",
            "type": "string",
            "example": "Patio Santa fe"
        },
        "branchAddress": {
            "$ref": "#/definitions/Address"
        }
    },
    "required": [
        "displayCardNumber",
        "deliveryFolioId",
        "branchId",
        "branchAddress",
        "branchName"
    ]
}
              

Address

{
    "type": "object",
    "properties": {
        "colonyName": {
            "description": "Name of the Colony of the bank branch.",
            "type": "string",
            "example": "Cuauhtemoc"
        },
        "postalCode": {
            "description": "Postal code of the bank branch.",
            "type": "string",
            "example": "06500"
        },
        "city": {
            "description": "City of the bank branch.",
            "type": "string",
            "example": "Ciudad de Mexico"
        },
        "streetName": {
            "description": "The name on a street of the bank branch.",
            "type": "string",
            "example": "Rio de la plata"
        }
    },
    "required": [
        "colonyName",
        "postalCode",
        "city",
        "streetName"
    ]
}
              

CardDeliveryStatusRequest

{
    "properties": {
        "accountId": {
            "description": "Unique ID used by front end to identify the account.",
            "type": "string",
            "example": "1234"
        }
    },
    "required": [
        "accountId"
    ]
}
              

CardDeliveryStatusResponse

{
    "type": "object",
    "properties": {
        "displayCardNumber": {
            "description": "The last 4 digits of the card number.",
            "type": "string",
            "example": "3523"
        },
        "branchId": {
            "description": "Unique identifier for the branch.",
            "type": "string",
            "example": "1234"
        },
        "deliveryStatus": {
            "description": "Delivery status of the card. Ex- Pending, Sent, In-process, Canceled, etc.",
            "type": "string",
            "example": "Pending"
        },
        "deliveryMode": {
            "description": "Delivery Mode. It represents shipping mode basically and says by which mode card plastic is getting delivered. For Ex: Standard shipping or Pickup Branch or Preferred Mailing Address",
            "type": "string",
            "example": "Branch"
        },
        "address": {
            "$ref": "#/definitions/AddressDetail"
        }
    },
    "required": [
        "displayCardNumber",
        "branchId",
        "deliveryStatus",
        "deliveryMode",
        "address"
    ]
}
              

AddressDetail

{
    "type": "object",
    "properties": {
        "colonyName": {
            "description": "Name of the Colony of the bank branch.",
            "type": "string",
            "example": "Cuauhtemoc"
        },
        "postalCode": {
            "description": "Postal code of the bank branch.",
            "type": "string",
            "example": "06500"
        },
        "city": {
            "description": "City of the bank branch.",
            "type": "string",
            "example": "Ciudad de Mexico"
        },
        "streetName": {
            "description": "The name on a street of the bank branch.",
            "type": "string",
            "example": "Rio de la plata"
        },
        "landmark": {
            "description": "A landscape that is easily seen and recognized from a distance, especially one that enables someone to establish their location.",
            "type": "string",
            "example": "between Gante and Bolivar"
        }
    },
    "required": [
        "colonyName",
        "postalCode",
        "city",
        "streetName"
    ]
}
              

CardHardBlockRequest

{
    "type": "object",
    "properties": {
        "accountId": {
            "description": "Unique ID used by front end to identify the account.",
            "type": "string",
            "example": "1234"
        },
        "cardBlockCode": {
            "description": "The block code used to block a particular card.Card Block Codes are Temp. Block,  Lost, Fraud / Stolen, Over Credit Limit For eg: if card is lost the first step is to block the card to avoid any discrepany like misuse(Fraud)",
            "type": "string",
            "example": "L"
        },
        "blockReasonCode": {
            "description": "Block reason code gives  more specific reason for blocking the card. For eg: The card is stolen while travelling.",
            "type": "string",
            "example": "01"
        }
    },
    "required": [
        "cardBlockCode",
        "blockReasonCode",
        "accountId"
    ]
}
              

CardHardBlockResponse

{
    "type": "object",
    "properties": {
        "hardBlockFolioId": {
            "description": "Unique Id to identify the operation. It is generated by the folio operation service used for tracking.",
            "type": "string",
            "example": "05235e5da96d000001"
        }
    },
    "required": [
        "hardBlockFolioId"
    ]
}
              

ErrorResponse

{
    "properties": {
        "type": {
            "type": "string",
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "More Info can be used to pass any additional details",
            "type": "string"
        },
        "uuid": {
            "description": "128 bit UUID that you generate for every request",
            "type": "string"
        },
        "timestamp": {
            "description": "Timestamp of the error",
            "type": "string"
        }
    },
    "required": [
        "type",
        "code"
    ]
}