Search Transactions

get https://api-preview.platform.breadpayments.com/api/transaction/search

Search transactions in a paginated format based on provided filters

time	status	user agent
Retrieving recent requests…

Loading…

Query Params

merchantID.eq

uuid

The unique identifier of the merchant.

programID.eq

array of uuids

length ≥ 0

The unique identifier(s) of the program(s).

programID.eq

groupID.eq

array of uuids

length between 0 and 1

The unique identifier(s) of the group(s) which is used to fetch transactions made from the locations belonging to these groups.

groupID.eq

locationID.eq

array of uuids

length between 0 and 1

The unique identifier(s) of the location(s) which is used to fetch transactions made from these locations.

locationID.eq

createdAt.lt

date-time

The date and time before which all returned transactions have been created.

createdAt.gte

date-time

The date and time after and including which all returned transactions have been created.

expiresAt.lt

date-time

The date and time before which all returned transactions will expire.

expiresAt.gte

date-time

The date and time after and including which all returned transactions will expire.

status.eq

array of strings

length ≥ 0

Equal to the given transaction status(es).

status.eq

paymentProductID.eq

array of uuids

length ≥ 0

Equal to the given payment product ID(s).

paymentProductID.eq

id.like

string

Transaction ID matching given pattern

externalID.like

string

external ID matching given pattern.

billingContact.like

string

Billing contact matching given pattern.

limit

integer

1 to 200

Defaults to 10

The maximum number of records that will be returned in a result set.

offset

integer

≥ 0

Defaults to 0

The number of records to skip before starting to collect the result set. Used in conjunction with limit query parameter for pagination support

sort

string

The sort key.

carts.eq

boolean

Whether or not to include carts in the transactions returned

includeAllDescendantMerchants

boolean

Whether or not to include descendant merchants

Responses

Response body

object

items

array of objects

required

items*

object

adjustedAmount

object

required

Represents a monetary amount in the specified currency

applicationID

uuid

required

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

billingContact

object

required

Represents contact information for an entity

buyerID

uuid

required

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

createdAt

date-time

required

The timestamp value formatted per RFC3339. This does not allow nulls.

description

string

required

a description for the transaction

discountAmount

object

required

Represents a monetary amount in the specified currency

expirationExtended

boolean

required

Whether the expiration has been extended for this transaction

expiresAt

date-time

The timestamp value formatted per RFC3339. This does not allow nulls.

externalID

string

required

An identifier that has significance to the Merchant allowing the transaction to be associated with the Merchant’s systems.

fulfillmentCarrier

string

the shipping carrier moving the transacted item.

fulfillmentTrackingNumber

string

the number used to see the shipping progress of the transacted item.

uuid

required

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

locationID

uuid

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

merchantID

uuid

required

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

metadata

object

required

Metadata is a JSON field available to merchants for storing external data on a Transaction
Metadata keys have a max size of 128, and there can be up to 50 keys total. The max value size for a key is 5000.

Has additional fields

paymentAgreementID

uuid

required

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

paymentProductID

uuid

required

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

merchantPaymentProductValuesID

uuid

required

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

productType

string

required

The type of payment product

INSTALLMENTS SPLITPAY DEBT_CONSOLIDATION PERSONAL_LOAN

programID

uuid

required

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

merchantProgramValuesID

uuid

required

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

refundedAmount

object

required

Represents a monetary amount in the specified currency

chargedbackAmount

object

required

Represents a monetary amount in the specified currency

cancelledAmount

object

required

Represents a monetary amount in the specified currency

settledAmount

object

required

Represents a monetary amount in the specified currency

overflowAmount

object

required

Represents a monetary amount in the specified currency

shippingAmount

object

required

Represents a monetary amount in the specified currency

shippingContact

object

required

Represents contact information for an entity

status

string

required

The possible statuses of a Transaction

AUTHORIZED CANCELLED EXPIRED PARTIALLY_AUTHORIZED PARTIALLY_REFUNDED PARTIALLY_SETTLED PENDING REFUNDED SETTLED CHARGEDBACK PARTIALLY_CHARGEDBACK

taxAmount

object

required

Represents a monetary amount in the specified currency

tenantID

uuid

required

A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.

isCarts

boolean

required

Whether the transacted item is associated with a cart id.

totalAmount

object

required

Represents a monetary amount in the specified currency

revision

integer

required

The revision of the transaction. Incremented whenever there is a change to the transaction.

updatedAt

date-time

required

The timestamp value formatted per RFC3339. This does not allow nulls.

pagination

object

required

Result pagination values

limit

integer

required

The maximum number of records that will be returned.

offset

integer

required

The number of records skipped.

total

integer

required

The total available records.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api-preview.platform.breadpayments.com/api/transaction/search?limit=10&offset=0' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

200Paginated list of transactions from ListTransactions

401Unauthorized. Indicates that provided credentials is not valid

403Forbidden. Indicates that request cannot be authorized

404The requested resource was not found

500The requested resource conflicts with an existing resource.

503The service is unavailable.