Add a payment record

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

Add a payment record without actually charging a user's payment method, useful for mitigating production issues.

Responses

Response body

object

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

tags

object

AgreementTag

string

Defaults to CREDIT_BUREAU_DISPUTE

Payment Agreement Tag Name. Note: 'CREDIT_BUREAU_REPORTING' is deprecated and should not be used.

CREDIT_BUREAU_REPORTING CREDIT_BUREAU_DISPUTE COLLECTION_HOLD_STATUS MIGRATED_FROM_CLASSIC CBR_DO_NOT_REPORT CBR_FORCE_REPORT IMPROPER_CHARGE_OFF CBR_DELETE_ACCOUNT

CreditBureauDisputeStatusType

string

Defaults to UNKNOWN_STATUS

UNKNOWN_STATUS NO_DISPUTE DISPUTED RESOLVED WITHDRAWN

CreditBureauReportingStatusType

string

Defaults to UNKNOWN_STATUS

deprecated

UNKNOWN_STATUS REPORTED NEVER_REPORT REPORTING_PAUSED NOT_REPORTED

CreditBureauReportingSubStatusType

string

Defaults to UNKNOWN_SUB_STATUS

deprecated

UNKNOWN_SUB_STATUS NONE CHARGED_OFF CURRENT DELETED_DUE_TO_FRAUD DELETED_DUE_TO_OTHER DPD_30_TO_59 DPD_60_TO_89 DPD_90_TO_119 PAID PAID_AFTER_CHARGE_OFF

PauseCollectionCalls

object

MigratedFromClassic

object

CbrDoNotReport

object

Has additional fields

CbrForceReport

object

ImproperChargeOff

object

Has additional fields

CbrDeleteAccount

object

Has additional fields

payment

object

Represents a payment made towards the loan

uuid

required

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

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

required

Defaults to UNKNOWN_REQUEST_TYPE

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

UNKNOWN_REQUEST_TYPE INSTALLMENT OTHER OUTSTANDING_BALANCE PAYOFF PRINCIPAL RECOVERY DOWN_PAYMENT SPLITPAY_FIRST_PAYMENT

source

string

Source (example: "docs")

paymentMethodType

string

Defaults to ACH

PaymentMethodType is a further distinction of an AccountType. E.g. debit vs credit for card accounts

ACH CREDIT_CARD DEBIT_CARD EFT MANUAL_PAYMENT EXTERNAL_COLLECTION TRADE_IN_CREDIT CHECK_PAYMENT PAPER_CHECK

status

string

Defaults to UNKNOWN_STATUS

UNKNOWN_STATUS SCHEDULED PENDING RECEIVED FAILED CANCELLED CHARGED_BACK REFUNDED RETURNED REJECTED

subStatus

string

Defaults to UNKNOWN_SUB_STATUS

UNKNOWN_SUB_STATUS NONE RETRY

effectiveAt

date-time

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

processedAt

date-time

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

dateScheduled

date

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

accountType

string

Defaults to UNSPECIFIED

AccountType designates the type of an account, and is logically aligned with payments' PaymentMethodType.

UNSPECIFIED BANK_ACCOUNT CARD_ACCOUNT MANUAL_PAYMENT EXTERNAL_COLLECTION TRADE_IN_CREDIT CHECK_PAYMENT PAPER_CHECK

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-preview.platform.breadpayments.com/api/servicing/payment-agreement/id/payment/add-payment-record \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "requestType": "UNKNOWN_REQUEST_TYPE"
8
}
9
'

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

application/json

text/plain

200A successful response from adding a payment record

400an unsuccessful response

401Unauthorized. Indicates that provided credentials is not valid

403an unsuccessful response

500an unsuccessful response