User Management

Update a Credit Card Profile

Supply card details Spinwheel could not resolve. Send an account number, an expiration date, or both. At least one of cardProfile.accountNumber and cardProfile.expirationDate must be present; an empty cardProfile is rejected.

expirationDate is the same { month, year } object the extended card profile returns.

A supplied value takes precedence over a resolved one, and the card carries it on its next appearance in the extended card profile.

patch/v1/users/{userId}/creditCards/{creditCardId}

Request

Base URL
https://sandbox-api.spinwheel.io
URL
https://sandbox-api.spinwheel.io/v1/users/{userId}/creditCards/{creditCardId}
Auth
API key in header Authorization

Path parameters

userIdstring required

Spinwheel userId to identify a user (one of userId or extUserId is required).

creditCardIdstring required

Spinwheel credit card Id associated with the user.

Request body

Example request

{
  "cardProfile": {
    "accountNumber": "4111111111111111",
    "expirationDate": {
      "month": "03",
      "year": "2028"
    }
  }
}

Response

Successful response

Example response

{
  "status": {
    "code": 200,
    "desc": "success",
    "messages": [
      {
        "desc": "Example description"
      }
    ]
  },
  "data": {
    "creditCardId": "7025c075-e92d-46fa-85e5-ac31ca667079",
    "logoUrl": "https://spinwheel.io/logos/1226cd1b-51dd-4bd1-8dc8-098deb9e0c7b.png",
    "displayName": "TD Bank",
    "updatedOn": 1597753517524,
    "createdOn": 1597753517524,
    "cardBrand": {
      "cardName": "Visa",
      "cardArtUrl": "https://www.visa.com/en_us/visa-everywhere/visa-card-art.html",
      "updatedOn": 1597753517524
    },
    "userId": "3fef7131-71ae-4204-a8bd-3fc3ad6b4b82",
    "cardProfile": {
      "creditCardNumberMasked": "495962******6670",
      "accountOriginationDate": "2023-01-15",
      "creditLimit": 5000,
      "highCreditAmount": 5000,
      "accountRating": "1",
      "liabilitySubtype": "CreditCard",
      "closedDateWithFormat": {
        "value": "2020-01-01",
        "format": "YYYY-MM-DD"
      },
      "availableCreditDerived": 2500,
      "reviewedInMonths": 6,
      "reportedDateWithFormat": {
        "value": "2020-01-01",
        "format": "YYYY-MM-DD"
      },
      "chargeOffAmount": 5000,
      "chargeOffDateWithFormat": {
        "value": "2020-01-01",
        "format": "YYYY-MM-DD"
      },
      "firstDelinquencyDateWithFormat": {
        "value": "2020-01-01",
        "format": "YYYY-MM-DD"
      },
      "lastActivityDateWithFormat": {
        "value": "2020-01-01",
        "format": "YYYY-MM-DD"
      },
      "accountTypeCode": "R",
      "highestAdverseRatingDateWithFormat": {
        "value": "2020-01-01",
        "format": "YYYY-MM-DD"
      },
      "mostRecentAdverseRatingDateWithFormat": {
        "value": "2020-01-01",
        "format": "YYYY-MM-DD"
      },
      "secondMostRecentAdverseRatingDateWithFormat": {
        "value": "2020-01-01",
        "format": "YYYY-MM-DD"
      },
      "adverseRatingCount": 2,
      "liabilityTransfers": {
        "transferredFrom": {
          "creditorName": "MASTERCARD"
        },
        "transferredTo": {
          "creditorName": "MASTERCARD"
        }
      },
      "narratives": [
        {
          "code": "EP",
          "description": "Fixed rate"
        }
      ],
      "creditUtilization": 25,
      "accountNumber": "4111111111111111",
      "paymentHistory": {
        "lastAssessedStatementDate": "2020-01-01",
        "details": [
          {
            "date": "2020-01-01",
            "description": "The account is current",
            "code": "1"
          }
        ]
      }
    },
    "balanceDetails": {
      "outstandingBalance": 2500,
      "updatedOn": 1597753517524
    },
    "statementSummary": {
      "statementDateWithFormat": {
        "value": "2020-01-01",
        "format": "YYYY-MM-DD"
      },
      "statementBalance": 3194,
      "minimumPaymentAmount": 100,
      "lastPaymentAmount": 100,
      "lastPaymentDateWithFormat": {
        "value": "2020-01-01",
        "format": "YYYY-MM-DD"
      },
      "dueDate": "2023-04-10",
      "amountPastDue": 100,
      "refreshedFields": {
        "paymentDueDay": {
          "value": "2023-04-10",
          "format": "YYYY-MM-DD",
          "updatedOn": 1643917894780
        },
        "lastPaymentDate": {
          "value": "2023-04-10",
          "format": "YYYY-MM-DD",
          "updatedOn": 1643917894780
        },
        "lastPaymentAmount": {
          "value": 100,
          "updatedOn": 1643917894780
        }
      },
      "updatedOn": 1597753517524,
      "dueDateWithFormat": {
        "value": "2020-01-01",
        "format": "YYYY-MM-DD"
      }
    },
    "aprs": [
      {
        "rate": 31.24,
        "applicableBalance": 2500,
        "expirationDate": "2023-12-31",
        "updatedOn": 1597753517524
      }
    ],
    "creditor": {
      "industryType": "SalesFinancing",
      "industryCode": "FF",
      "phoneNumber": "8663968254",
      "originalName": "TD BANK",
      "bureauSubscriberCode": "401BB00573",
      "billingAddresses": [
        {
          "addressLine1": "123 Main Street",
          "addressLine2": "Unit 208",
          "city": "San Francisco",
          "state": "CA",
          "zip": "90211",
          "zipExtension": "1234",
          "reportedDate": "2023-09-20T00:00:00.000Z",
          "reportedDateWithFormat": {
            "value": "2020-01-01",
            "format": "YYYY-MM-DD"
          },
          "addressType": "CURRENT"
        }
      ],
      "address": {
        "addressLine1": "123 Main Street",
        "addressLine2": "Unit 208",
        "city": "San Francisco",
        "state": "CA",
        "zip": "90211",
        "zipExtension": "1234"
      },
      "billingAddress": {
        "addressLine1": "123 Main Street",
        "addressLine2": "Unit 208",
        "city": "San Francisco",
        "state": "CA",
        "zip": "90211",
        "zipExtension": "1234"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.