Make Payment

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

Makes a payment towards a payment agreement

Path Params

uuid

required

The unique ID of the payment agreement.

Body Params

Request body for Make a Payment

paymentMethodID

uuid

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

amount

object

required

Represents a monetary amount in the specified currency

paymentType

string

Defaults to UNKNOWN_REQUEST_TYPE

One of 'INSTALLMENT', 'OTHER', 'OUTSTANDING_BALANCE', 'PAYOFF', 'PRINCIPAL', 'RECOVERY', 'DOWN_PAYMENT', 'SPLITPAY_FIRST_PAYMENT'

source

string

required

The payment source

acknowledgement

object

required

sourceType

string

Defaults to UNKNOWN_SOURCE_TYPE

Identifies the processing source type of payment. Note: 'SCHEDULED_PAYMENT' is deprecated in favor of SCHEDULED

sourceId

string

Source ID (UUID)

subSourceType

string

Defaults to UNKNOWN_SUB_SOURCE_TYPE

SubSourceType is the medium through which the payment was originated. One of WEB (online), TEL (over the phone), or IVR (automated through interactive voice response).

effectiveTime

date-time | null

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

notes

string

Notes for the payment

async

boolean

Whether this payment should be made asynchronously or not

Show Deprecated

Headers

xIdempotencyKey

uuid

X-Idempotency-Key: Optional header for enabling idempotency

Responses

Response body

object

acknowledgementID

uuid

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

paymentReferenceID

uuid

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

paymentAgreement

object

A full view of a payment agreement including the payment schedule, balance summary, and adjustments.

uuid

required

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

tenantID

uuid

required

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

programID

uuid

required

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

buyerID

uuid

required

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.

applicationID

uuid

required

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.

createdAt

date-time

required

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

updatedAt

date-time

required

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

expiresAt

date-time

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

paymentProductID

uuid

required

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

productType

string

Defaults to UNKNOWN

The type of payment product.

UNKNOWN INSTALLMENTS SPLITPAY DEBT_CONSOLIDATION PERSONAL_LOAN

status

string

required

The status of a payment agreement. Note: REVIEW is deprecated.

UNKNOWN_STATUS OFFERED ACCEPTED EXPIRED REVIEW OUTSTANDING PAID CHARGED_OFF CANCELLED CLOSED

terms

object

required

Represents the terms agreed upon for a loan

paymentAmount

object

required

Represents a monetary amount in the specified currency

activities

array of objects

required

Activities that affect the payment agreement balance, such as payments and refunds. This is only returned given the parameter include=activities.

activities*

object

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.

updatedAt

date-time

required

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

extensionType

string

PAYMENT REFUND OCC DUE_DATE_CHANGE FUTURE_PAYMENT SKIPPED_INSTALLMENTS TERMS_UPDATE CHARGE_BACK PAYMENT_REFUND WAIVE

dueDateChangeExtension

object | null

Only present when the extensionType is DUE_DATE_CHANGE.

paymentExtension

object | null

Represents a payment made towards the loan

refundExtension

object | null

Only present when the extensionType is REFUND.

occExtension

object | null

Only present when the extensionType is OCC.

futurePaymentExtension

object | null

Only present when the extensionType is FUTURE_PAYMENT.

skippedInstallmentsExtension

object | null

Only present when the extensionType is SKIPPED_INSTALLMENTS.

termsUpdateExtension

object | null

Only present when the extensionType is TERMS_UPDATE.

chargeBackExtension

object | null

Only present when the extensionType is CHARGE_BACK.

paymentRefundExtension

object | null

Only present when the extensionType is PAYMENT_REFUND.

waiveExtension

object | null

Only present when the extensionType is WAIVE.

subStatus

string

required

The substatus of a payment agreement.

UNKNOWN_SUB_STATUS CURRENT DELINQUENT_PAST_DUE PENDING FULFILLED CHARGED_OFF_PAID PAYMENTS_FROZEN GRACE_PERIOD PRE_GRACE_PERIOD NONE

reason

string

Defaults to UNKNOWN_REASON

UNKNOWN_REASON: unknown reason
WRITE_OFF: Paid, Closed status
CONTRACTUAL: Charged off
FULLY_REFUNDED: Closed
MERCHANT_FRAUD: Cancelled
OTHER_CHOSEN: Expired
LIFECYCLE: Standard change
RESCINDED: Whether a closed/cancelled status is due to right of rescission
refund or chargeback

UNKNOWN_REASON WRITE_OFF CONTRACTUAL BANKRUPT FRAUD CONSUMER_PROPOSAL CREDIT_COUNSELING IDENTITY_THEFT PAYMENT_FRAUD SYNTHETIC_FRAUD MEMBER_PAID DECEASED FAMILY_FRAUD FRAUD_CREDIT_BUST_OUT FIRST_PARTY_FRAUD LEGAL FULLY_REFUNDED MERCHANT_FRAUD BREAD_FRAUD SETTLEMENT_CANCELLED SETTLEMENT_EXPIRED OTHER_CHOSEN NONE_CHOSEN LIFECYCLE RESCINDED

agreementNumber

string

A human-friendly unique ID for a payment agreement.

schedule

object

required

Describes the start date and its installments.

balanceSummary

object

required

Represents a summary of the payment agreement's aggregated balances.

autopay

object | null

required

Describes the autopay enrollment for a payment agreement.

completionDate

date | null

required

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

disputed

boolean

required

Flags if there is an open product dispute.

availableAdjustments

array of objects

required

A list of adjustments that can be made to the agreement.

availableAdjustments*

object

200A successful response from making a payment

400an unsuccessful response

401Unauthorized. Indicates that provided credentials is not valid

403an unsuccessful response

500an unsuccessful response