Update cards

Create or update cards associated with a customer account.

PUT /v2/data/customers/:sourceCustomerId/accounts/:sourceAccountId/cards

Input Parameters

In addition to the path parameters, this endpoint requires a JSON body be posted.

Path ParamTypeDescription
sourceCustomerIdstringCustomer identifier
accountIdstringAccount identifier
PropertyTypeRequiredDescription
cardsCard[]RequiredCreate Card Parameters or Update Card Parameters described below

Create Card Parameters

PropertyTypeRequiredDescription
sourceAccountIdstringRequiredAccount identifier to associate with the card
sourceCustomerIdstringRequiredCustomer identifier associated with the account
last4stringRequiredLast 4 digits of the card number
iinstringRequiredCard IIN number
cardTypeCardTypeRequiredCard type
statusCardStatusRequiredThe status of the new card
networkIdentifierstringRequiredThe first digit of the Plastic Account Number (PAN) as the network Identifier (3-MC, 4-V, 5-D, 6-AXP)
openDatestringRequiredThe date and time the card was opened
closeDatestringRequired, if status is CLOSEDThe date and time the card was closed

Update Card Status Parameters

!!! info "Any card properties left out of the response will not be updated."

PropertyTypeRequiredDescription
sourceAccountIdstringRequiredAccount identifier to associate with the card
sourceCustomerIdstringRequiredCustomer identifier associated with the account
last4stringRequiredLast 4 digits of the card number
cardTypeCardTypeNoCard type
statusCardStatusNoThe updated status of the card
networkIdentifierstringNoThe first digit of the Plastic Account Number (PAN) as the network Identifier (3-MC, 4-V, 5-D, 6-AXP)
openDatestringNoThe date and time the card was opened
closeDatestringRequired, if status is being updated CLOSEDThe date and time the card was closed

Output

This endpoint returns an HTTP response indicating success (200) or failure (500).

Example

This example shows one card being created and another being set to CLOSED.

Request

PUT /v2/data/customers/:sourceCustomerId/accounts/:sourceAccountId/cards
{
    "cards": [
        {
            "sourceAccountId": "42c57311-25f9-4501-b9db-e78afa73c0e3",
            "sourceCustomerId": "afa2r21-25f9-4501-b9db-e78afa73c0e3",
            "last4": "2345",
            "iin": "123456",
            "cardType": "CREDIT",
            "status": "OPEN",
            "networkIdentifier": 3,
            "openDate": "2017-01-01T08:00:00Z",
            "closeDate": null
        },
        {
            "sourceAccountId": "42c57311-25f9-4501-b9db-e78afa73c0e3",
            "sourceCustomerId": "afa2r21-25f9-4501-b9db-e78afa73c0e3",
            "last4": "6789",
            "iin": "873452",
            "cardType": "CREDIT",
            "status": "CLOSED",
            "networkIdentifier": 3,
            "openDate": "2017-01-01T08:00:00Z",
            "closeDate": "2023-04-06T08:00:00Z"
        }
    ]
}

Response

{
    "requestId": "380052b4-3a64-4952-b640-ba696eb9f44b"
}