Skip to main content

Get Card Account External

POST 
https://api.tripleup.dev/partner/card-account.by-ids

Returns a CardAccount instance using one or more of its associated external IDs:

  • external card account ID
  • external card program ID
  • external publisher ID

The receiver returns the same object as calling the /card-accounts/{id} endpoint with the triple card account ID if a matching CardAccount exists.

Request​

Body

    card_account_external_idCard Account External ID (string)required

    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 (###-##-####).

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^(?!\d{3}-\d\d-\d{4}$)

    Example: id-for-entity
    card_program_external_idCard Program External ID (string)

    Partner-provided, external ID for a Card Program.

    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 Program within the scope of its parent Publisher.

    To protect against accidental inclusion of sensitive personal information, external IDs may not be 9-digit numbers or use the US Tax ID format (###-##-####).

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^(?!\d{3}-\d\d-\d{4}$)

    Example: id-for-entity
    publisher_external_idPublisher External ID (string)

    Partner-provided, external ID for a Publisher.

    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 Publisher within the scope of its parent Portfolio Manager.

    To protect against accidental inclusion of sensitive personal information, external IDs may not be 9-digit numbers or use the US Tax ID format (###-##-####).

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^(?!\d{3}-\d\d-\d{4}$)

    Example: id-for-entity

Responses​

Card Account

Schema
    card_program_idEntityId (string)required

    The triple-defined ID for the entity.

    Possible values: non-empty and <= 100 characters

    Example: triple-abc-123
    created_atdate-timerequired

    RFC 3339 date time used for creation and mod times

    Example: 2021-12-01T01:59:59.000Z
    default_country_codeCountryCode (string)

    2-letter ISO-3166 country code

    Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ^[A-Z]{2}$

    Example: US
    default_postal_codePostalCode (string)

    ZIP Code™, ZIP+4, or postal code

    Possible values: non-empty and <= 15 characters

    Example: 15206
    external_idCard Account External ID (string)required

    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 (###-##-####).

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^(?!\d{3}-\d\d-\d{4}$)

    Example: id-for-entity
    idEntityId (string)required

    The triple-defined ID for the entity.

    Possible values: non-empty and <= 100 characters

    Example: triple-abc-123
    statusCardAccountEnrollmentStatus (string)required
    • 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

    Possible values: [ENROLLED, NOT_ENROLLED, CLOSED]

    Default value: ENROLLED
    updated_atdate-timerequired

    RFC 3339 date time used for creation and mod times

    Example: 2021-12-01T01:59:59.000Z

Authorization: oauth2

name: triple_authtype: oauth2scopes: api.tripleup.com/partner.view_offersdescription: The triple API uses OAuth2 with a client id and client secret.
The URL to get an OAuth2 token is here:
https://auth.tripleup.dev/oauth2/token
This is an example of how to call the API from the command line.
Code will need to be developed by the partner in their servers.
```bash
# Fetch an access token
TOKEN_URL=https://auth.tripleup.dev/oauth2/token
CLIENT_ID=fake
CLIENT_SECRET=another-fake
# Fetch a space-separated list of scopes
# If not provided, will return an access token
# with all scopes to which the client has access
SCOPE=api.tripleup.com/partner.publishers
TOKEN_RESPONSE=$(curl -s -X POST $TOKEN_URL \
  --user $CLIENT_ID:$CLIENT_SECRET \
  --data grant_type=client_credentials \
  --data-urlencode "scope=$SCOPE")
# Use an access token
ACCESS_TOKEN=$(echo $TOKEN_RESPONSE | jq -r '.access_token')
TOKEN_TYPE=$(echo $TOKEN_RESPONSE | jq -r '.token_type')
API_URL=https://api.tripleup.dev
curl -X GET "$API_URL/partner/publishers" \
  --header "Authorization: $TOKEN_TYPE $ACCESS_TOKEN"
```
See the _Client credentials grant_ section at the bottom of this
[AWS blog post](https://aws.amazon.com/blogs/mobile/understanding-amazon-cognito-user-pool-oauth-2-0-grants/)
for more information.
flows: {
  "clientCredentials": {
    "tokenUrl": "https://auth.tripleup.dev/oauth2/token",
    "scopes": {
      "api.tripleup.com/partner.portfolios": "Manage Portfolio Manager details and portfolios of Publishers\n",
      "api.tripleup.com/partner.publishers": "Manage Publisher details, Card Programs, Consumers, Card Accounts,\nand Transactions\n",
      "api.tripleup.com/partner.view_offers": "View recommended Offers, search Offers, and view Offer details\n",
      "api.tripleup.com/partner.content_providers": "Manage Content Provider details, Merchants, Merchant Locations,\nand Offers\n"
    }
  }
}
import http.client
import json

conn = http.client.HTTPSConnection("api.tripleup.dev")
payload = json.dumps({
  "card_account_external_id": "id-for-entity",
  "card_program_external_id": "id-for-entity",
  "publisher_external_id": "id-for-entity"
})
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer <token>'
}
conn.request("POST", "/partner/card-account.by-ids", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
Request Collapse all
Base URL
https://api.tripleup.dev
Auth
Body
{
  "card_account_external_id": "id-for-entity",
  "card_program_external_id": "id-for-entity",
  "publisher_external_id": "id-for-entity"
}