/

5 minute read

November 10, 2020

Core API Transaction Token

Use this view endpoint to associate the Core API Transaction Token with the DiVA Reports Transaction Token. This endpoint provides a lookup between the two types of tokens, with the Core API Transaction Token derived from webhooks associated with the Core API (see Transactions in the Core API Reference). The /transactiontoken endpoint is useful for assisting reconciliation efforts.

This endpoint supports multiple response formats, query filtering, field filtering, sorting, and pagination. For more information about response options, see Response Customization.

Retrieve the Core API transaction token (JSON)

Action: GET
Endpoint: /views/transactiontoken

Retrieve the Core API transaction token. This endpoint returns a JSON object that contains an array of records matching your filter query.

Sample response body

The following sample shows a representative response for a GET request to the /views/transactiontoken?program=my_program endpoint.


{
    "total": 21,
    "is_more": false,
    "count": 21,
    "info": {},
    "start_date": null,
    "end_date": null,
    "last_run_time": "2020-10-12T11:12:13Z",
    "schema": [
        {
            "field": "program",
            "type": "character varying(128)",
            "description": "The name of the card program.",
            "display": "Program",
            "units": null,
            "has_total": false,
            "is_filter_only": false
        },
        {
            "field": "bank",
            "type": "character varying(128)",
            "description": "The bank under which the program operates.",
            "display": "Bank",
            "units": null,
            "has_total": false,
            "is_filter_only": false
        },
        {
            "field": "core_api_transaction_token",
            "type": "character varying(36)",
            "description": null,
            "display": "Core Api Transaction Token",
            "units": null,
            "has_total": false,
            "is_filter_only": false
        },
        {
            "field": "transaction_token",
            "type": "character varying(128)",
            "description": "The token of the transaction; unique within a program.",
            "display": "Transaction Token",
            "units": null,
            "has_total": false,
            "is_filter_only": false
        },
        {
            "field": "transaction_timestamp",
            "type": "timestamp without time zone",
            "description": "The date and time when a transaction occurred. Displayed in UTC.",
            "display": "Transaction Timestamp",
            "units": null,
            "has_total": false,
            "date_format": "YYYY-MM-DD",
            "is_filter_only": false
        }
    ],
    "records": [
        {
            "program": "my_program",
            "bank": "bank_name",
            "core_api_transaction_token": "665z2647-683f-44ba-aa0a-e93ebe457990",
            "transaction_token": "e50b74c3-92c2-99e4-9e1h-30eadaz1a999",
            "transaction_timestamp": "2020-09-12",
        },
        {
            "program": "my_program",
            "bank": "bank_name",
            "core_api_transaction_token": "665z2647-683f-44ba-aa0a-e93ebe457990",
            "transaction_token": "e50b74c3-92c2-99e4-9e1h-30eadaz1a999",
            "transaction_timestamp": "2020-09-12",
        },

        ...

        {
            "program": "my_program",
            "bank": "bank_name",
            "core_api_transaction_token": "665z2647-683f-44ba-aa0a-e93ebe457990",
            "transaction_token": "e50b74c3-92c2-99e4-9e1h-30eadaz1a999",
            "transaction_timestamp": "2020-09-12",
        }
    ]
}

Is this helpful?

Retrieve the Core API transaction token (file export)

Action: GET
Endpoint: /views/transactiontoken/{export_type}

Retrieve transactiontoken information. This endpoint asynchronously generates a file in the specified format and returns a job token for retrieving the file when it is completed. The file contains a list of records matching your filter query.

URL path parameters

Fields Description

export_type

string
Required

File format in which to export the data.

Allowable Values:

csv

Query parameters

Fields Description

compress

string
Optional

Type of file compression for the exported file.

Allowable Values:

gz, zip

Default value:
gz

Sample response body

{
    "token":"111122225b444d8888888a9999ae11111db63da4.csv.gz"
}

Is this helpful?

Retrieve Core API transaction token schema

Action: GET
Endpoint: /views/transactiontoken/schema

Retrieve a JSON representation of the transactiontoken schema. The schema object contains an array of objects that describe the available columns and the data type of each column.

Sample response body

The following sample shows a representative response for a GET request to the /views/transactiontoken/schema?program=my_program endpoint. The schema can vary based on the data you are authorized to access (based on the credentials you provide in your request).

[
    {
        "field": "program",
        "type": "character varying(128)",
        "description": "The name of the card program.",
        "display": "Program",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "bank",
        "type": "character varying(128)",
        "description": "The bank under which the program operates.",
        "display": "Bank",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "core_api_transaction_token",
        "type": "character varying(36)",
        "description": null,
        "display": "Core Api Transaction Token",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "transaction_token",
        "type": "character varying(128)",
        "description": "The token of the transaction; unique within a program.",
        "display": "Transaction Token",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "transaction_timestamp",
        "type": "timestamp without time zone",
        "description": "The date and time when a transaction occurred. Displayed in UTC.",
        "display": "Transaction Timestamp",
        "units": null,
        "has_total": false,
        "date_format": "YYYY-MM-DD",
        "is_filter_only": false
    }
]

Is this helpful?

Have any feedback on this page?

If you feel we can do anything better, please let our team know.

We strive for the best possible developer experience.