Get settlement report

get https://api-preview.platform.breadpayments.com/api/funding/settlement-report

Get a list of settlement report entries based on date range.

Query Params

merchantID.eq

uuid

required

Query items belonging to provided merchant identifier.

programID.eq

array of uuids

length ≥ 0

Query items belonging to provided identifier(s) of the program(s).

programID.eq

effectiveDate.gt

date

Query items with effective dates after provided date.

effectiveDate.gte

date

Query items with effective dates on and after provided date.

effectiveDate.lt

date

Query items with effective dates before provided date.

effectiveDate.lte

date

Query items with effective dates before and on provided date.

limit

integer

1 to 2000

Defaults to 500

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

Responses

Response body

object

items

array of objects

List of settlement report entries.

items

object

achEffectiveDate

date

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

bankRequestDate

date

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

merchantID

uuid

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

merchantName

string

The name of the merchant.

programID

uuid

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

programName

string

The name of the program.

partnerID

uuid

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

transactionID

uuid

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

productType

string

The type of payment product

INSTALLMENTS SPLITPAY DEBT_CONSOLIDATION PERSONAL_LOAN

merchantOrderID

string

External ID from the merchant order management system.

customerName

string

Name of the buyer that purchased the order.

fundingEventType

string

The type of transaction event that generated this funding event.

CHARGEBACK REFUND SETTLE

generatedBy

string

The type of source that generated this funding event.

UNKNOWN_GENERATEDBY TRANSACTION CLASSIC MANUAL

locationReferenceID

string

The reference id for the merchant's brick and mortar store

transactionAmount

object