Get Balance History

get https://api-preview.platform.breadpayments.com/api/servicing/payment-agreement/{id}/history

Returns a payment agreement's balance history.

Log in to see full request history

Responses

Response body

object

balanceHistory

object

required

agreementID

uuid

required

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

nextStartPoint

date-time

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

periodSummaries

array of objects

required

periodSummaries*

object

periodStartDate

date

required

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

periodEndDate

date

required

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

periodPaidDate

date

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

amountExpected

object

Represents a monetary amount in the specified currency

amountOwed

object

Represents a monetary amount in the specified currency

amountPaid

object

Represents a monetary amount in the specified currency

amountRefunded

object

Represents a monetary amount in the specified currency

interestOwed

object

Represents a monetary amount in the specified currency

interestPaid

object

Represents a monetary amount in the specified currency

interestRefunded

object

Represents a monetary amount in the specified currency

principalOwed

object

Represents a monetary amount in the specified currency

principalPaid

object

Represents a monetary amount in the specified currency

prepaymentPaid

object

Represents a monetary amount in the specified currency

principalRefunded

object

Represents a monetary amount in the specified currency

downPaymentPaid

object

Represents a monetary amount in the specified currency

downPaymentRefunded

object

Represents a monetary amount in the specified currency

payoffAmount

object

Represents a monetary amount in the specified currency

balanceAtMaturity

object

Represents a monetary amount in the specified currency

daysPastDue

int32

events

array of objects

events

object

paymentEvent

object | null

Only present when eventType is PAYMENT.

refundEvent

object | null

Only present when eventType is REFUND.

occEvent

object | null

Only present when eventType is OCC.

chargeOffEvent

object | null

Only present when eventType is CHARGEOFF.

chargeBackEvent

object | null

Only present when eventType is CHARGEBACK.

waiveEvent

object | null

Only present when eventType is WAIVE.

paymentRefundEvent

object | null

Only present when eventType is PAYMENT_REFUND.

eventType

string

Enumerated types of period events in a payment agreement's balance history.

PAYMENT REFUND OCC CHARGEOFF CHARGEBACK WAIVE PAYMENT_REFUND

effectiveDate

date

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

createdDate

date

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

updatedDate

date

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

source

string

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-preview.platform.breadpayments.com/api/servicing/payment-agreement/id/history \
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