Update a Card Account

1 min

PATCH

https://api.sandbox.tripleup.dev/partner/card-accounts/{cardholder_id}

(Alpha - this endpoint is subject to breaking change)

Enroll, un-enroll, or close a Card Account.

Card Accounts must be enrolled at the time of a transaction and not closed at the time of distribution in order to receive Rewards.

The date of enrollment defaults to the current date at UTC-12. The date of un-enrollment defaults to the current date at UTC+12. (This is to accommodate the possibility of a customer's current local date being different than the server's.)

A future API release will address the edge case of unenrolling and then re-enrolling an account within the same day.

Path Parameters

cardholder_idEntityIdrequired
Example
triple-abc-123
Description
The triple-defined ID for the entity.

Body Parameters

bodyobject
- statusCardAccountEnrollmentStatusrequired
  Description
  - `ENROLLED` - The account is enrolled for rewards - `NOT_ENROLLED` - The account is not enrolled for rewards - `CLOSED` - The account is closed and cannot receive rewards
  Default
  ENROLLED

Responses

200Card Account

CardAccount
- card_program_idEntityIdrequired
  Example
  triple-abc-123
  Description
  The triple-defined ID for the entity.
- created_atTimestamprequired
  Example
  2021-12-01T01:59:59.000Z
  Description
  RFC 3339 date time used for creation and mod times
- default_country_codeCountryCode
  Example
  US
  Description
  2-letter ISO-3166 country code
- default_postal_codePostalCode
  Example
  15206
  Description
  ZIP Code™, ZIP+4, or postal code
- external_idCardAccountExternalIdrequired
  Description
  Partner-provided, external ID for a Card Account. External IDs should be **stable** and **never sensitive**. External IDs do not need to be globally unique, but we encourage the use of UUIDs. They must be unique for the Card Account within the scope of its parent Card Program. To protect against accidental inclusion of sensitive personal information, external IDs may not be 9-digit numbers or use the US Tax ID format (###-##-####).
  - ExternalId
- idEntityIdrequired
  Example
  triple-abc-123
  Description
  The triple-defined ID for the entity.
- statusCardAccountEnrollmentStatusrequired
  Description
  - `ENROLLED` - The account is enrolled for rewards - `NOT_ENROLLED` - The account is not enrolled for rewards - `CLOSED` - The account is closed and cannot receive rewards
  Default
  ENROLLED
- updated_atTimestamprequired
  Example
  2021-12-01T01:59:59.000Z
  Description
  RFC 3339 date time used for creation and mod times

400TripleBadRequestError

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    The request is malformed.
  - exceptionstring<TripleBadRequestError>required
    Description
    The exception type.

403TripleNotAuthenticatedError

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    Client authentication failed.
  - exceptionstring<TripleNotAuthenticatedError>required
    Description
    The exception type.

404TripleInvalidPathError

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    The url path or path parameter is invalid.
  - exceptionstring<TripleInvalidPathError>required
    Description
    The exception type.

409TripleIntegrityError

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    The request was well-formed but violated entity integrity constraints.
  - exceptionstring<TripleIntegrityError>required
    Description
    The exception type.

415TripleUnsupportedMediaType

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    The request defined an unsupported media type.
  - exceptionstring<TripleUnsupportedMediaType>required
    Description
    The exception type.

422TripleUnprocessableEntity

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    The request was well-formed but could not be processed.
  - exceptionstring<TripleUnprocessableEntity>required
    Description
    The exception type.

500TripleInternalServerError

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    Triple was unable to process the request due to an internal error.
  - exceptionstring<TripleInternalServerError>required
    Description
    The exception type.

501TripleNotImplementedError

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    The request failed because it requires a feature that is not yet implemented.
  - exceptionstring<TripleNotImplementedError>required
    Description
    The exception type.

503TripleServiceUnavailable

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    The request failed due to a triple service interruption.
  - exceptionstring<TripleServiceUnavailable>required
    Description
    The exception type.

curl

curl --request PATCH \
     --url https://api.sandbox.tripleup.dev/partner/card-accounts/{cardholder_id} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "status": "ENROLLED"
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "status": "ENROLLED"
});

var requestOptions = {
   method: 'PATCH',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.sandbox.tripleup.dev/partner/card-accounts/{cardholder_id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.sandbox.tripleup.dev/partner/card-accounts/{cardholder_id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "status": "ENROLLED"
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.sandbox.tripleup.dev/partner/card-accounts/{cardholder_id}"

payload = json.dumps({
   "status": "ENROLLED"
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("PATCH", url, headers=headers, data=payload)

print(response.text)

200

// Card Account
{
  "card_program_id": "triple-abc-123",
  "created_at": "2021-12-01T01:59:59.000Z",
  "default_country_code": "US",
  "default_postal_code": "15206",
  "external_id": {},
  "id": "triple-abc-123",
  "status": "",
  "updated_at": "2021-12-01T01:59:59.000Z"
}

400

// TripleBadRequestError
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

403

// TripleNotAuthenticatedError
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

404

// TripleInvalidPathError
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

409

// TripleIntegrityError
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

415

// TripleUnsupportedMediaType
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

422

// TripleUnprocessableEntity
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

500

// TripleInternalServerError
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

501

// TripleNotImplementedError
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

503

// TripleServiceUnavailable
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

(Alpha - this endpoint is subject to breaking change)

Enroll, un-enroll, or close a Card Account.

Card Accounts must be enrolled at the time of a transaction and not closed at the time of distribution in order to receive Rewards.

A future API release will address the edge case of unenrolling and then re-enrolling an account within the same day.