Retrieve transaction timeline messages

Retrieves a list of transaction timeline messages.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

q
string

Use this field to perform a partial search of text fields.

get
/transactions/{id}/timeline
Request samples
// all parameters are optional except for the `id`
const firstCollection = await api.transactions
    .getAllTimelineMessages({id: 'my-transaction'});

// alternatively you can specify one or more of them
const params = {id: 'my-transaction', limit: 20, offset: 100};
const secondCollection = await api.transactions.getAllTimelineMessages(params);

// access the collection items, each item is a Member
secondCollection.items
    .forEach(message => console.log(message.fields.eventType));
Responses

200

List of transaction timeline messages retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
id
string <= 50 characters

ID of the timeline message.

type
string

Type of timeline message.

Enum: "amount-adjusted" "blocklist-matched" "bump-offer-accepted" "bump-offer-presented" "bump-offer-rejected" "customer-redirected-offsite" "customer-returned" "dcc-offer-accepted" "dcc-offer-forced" "dcc-offer-presented" "dcc-offer-rejected" "dispute-changed" "dispute-created" "dispute-forfeited" "dispute-lost" "dispute-responded" "dispute-won" "gateway-connection-failed" "gateway-connection-timed-out" "gateway-response-received" "offsite-transaction-completed" "quickbooks-payment-created" "quickbooks-refund-receipt-created" "quickbooks-transaction-task-failed" "risk-score-changed" "timeline-comment-created" "transaction-abandoned" "transaction-amount-discrepancy-found" "transaction-approved" "transaction-canceled" "transaction-capture-delayed" "transaction-captured" "transaction-declined" "transaction-discrepancy-found" "transaction-disputed" "transaction-initiated" "transaction-payment-method-changed" "transaction-process-requested" "transaction-processed" "transaction-queried" "transaction-reconciled" "transaction-refunded" "transaction-retried" "transaction-rules-processed" "transaction-scheduled-time-changed" "transaction-timeout-resolved" "transaction-updated" "transaction-voided" "transaction-waiting-gateway" "transaction-waiting-gateway-completed"
triggeredBy
string

Specifies who, or what, triggered the timeline message.

Enum: "rebilly" "app" "direct-api"
message
string

Contents of the timeline message.

object (TimelineExtraData)

Additional data.

occurredTime
string <date-time> (ServerTimestamp)

Read-only timestamp in ISO 8601 date-time format.

Array of objects (SelfLink)

Related links.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

Response samples
application/json
[ { "id": "tmln_0YV8Q9WEF5DTA8HFXS27D1G6GC", "type": "amount-adjusted", "triggeredBy": "rebilly", "message": "string", "occurredTime": "2019-08-24T14:15:22Z", } ]