Support
/
5 minute read
February 22, 2021

Core API Transaction Token

Hidden

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.

Copied

Is this helpful?

Yes
No

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
Copied

Is this helpful?

Yes
No

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

Copied

Is this helpful?

Yes
No

Feedback on this page?

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