Check if a customer has reached their payment method limits. Returns the status of various payment method thresholds to determine if the customer can add additional payment methods.

📘

When a payment method is added, it will automatically become verified. This endpoint is for future use cases where microdeposits are required to verify your card.

Sample API Request: GET

URL: https://caas-staging.coinme.com/services/paymentmethods/status
Headers:
{
  "Authorization": "asdfghj", //required, authorization token
  "User-Agent": "partnerapi" //required
}

Request Body:
{
  "customerId": "c1234-a56b-78c9-d012-345678901234" // unique identifier for the customer, required
}

Sample API Response:

Successful Response:
{
  "data": {
    "maxReached": 3, // indicates if an account has reached the maximum number of payment methods they can add (verified or unverified, the default is 5)
    "maxTotalReached": 5, // indicates if the account has reached the maximum number of verified payment methods they can have (default 3)
    "maxVerifiedReached": 10 // indicates whether the account can add any more payment methods
  },
  "errorResponse": null
}

Failure Response:
{
  "data": null,
  "errorResponse": {
    "httpStatus": "200",
    "timestamp": "2025-01-09T14:30:00.000Z", //UTC
    "path": "/services/paymentmethods/status GET",
    "errorData": [
      {
        "errorCode":"123-123-123-123", //The error code is just a sample showing the structure of the error code.
        "message":"Customer Id not found"
      }
    ]
  }
}

Error Codes