Foundations

Introduction
Auth
Models

Merchant Operations

Introduction
Transaction
Cart
Reporting
Funding
- Get settlement reportget
Models
- Transaction
- Transaction Metadata

Buyer Management

Introduction
Buyer
Buyer Status
Models
Webhooks
- Buyer Updated Event

Checkout

Introduction
Application
Virtual Card
Models
Webhooks

Servicing

Introduction
Servicing
As Low As
- Get As-Low-Asget
- Get financing/loan-termsget
Financing Payment Plan
- Get Financing Payment Planget
Financing Dynamic Disclosure
- Get Financing Dynamic Disclosureget
Disclosures
Disclosure Templates
- Get a disclosure templateget
Webhooks
- Loan Details Changed Event

Payments

Introduction
Payment Methods
Payments
Refunds
Models

Webhook

Introduction
Subscription Management
Events
- List eventsget
- Replay an eventpost
Client Management
- List JWKsget
Models
Webhooks
- Integration Test Event

Tradein

Introduction
Tradein
Payment Agreement
Models

Foundations

Introduction
Auth
Models

Merchant Operations

Introduction
Transaction
Cart
Reporting
Funding
- Get settlement reportget
Models
- Transaction
- Transaction Metadata

Buyer Management

Introduction
Buyer
Buyer Status
Models
Webhooks
- Buyer Updated Event

Checkout

Introduction
Application
Virtual Card
Models
Webhooks

Servicing

Introduction
Servicing
As Low As
- Get As-Low-Asget
- Get financing/loan-termsget
Financing Payment Plan
- Get Financing Payment Planget
Financing Dynamic Disclosure
- Get Financing Dynamic Disclosureget
Disclosures
Disclosure Templates
- Get a disclosure templateget
Webhooks
- Loan Details Changed Event

Payments

Introduction
Payment Methods
Payments
Refunds
Models

Webhook

Introduction
Subscription Management
Events
- List eventsget
- Replay an eventpost
Client Management
- List JWKsget
Models
Webhooks
- Integration Test Event

Tradein

Introduction
Tradein
Payment Agreement
Models

Update OCC request

patch https://api-preview.platform.breadpayments.com/api/servicing/occ/{occID}

Update OCC updates the status or payment method of an occ request

URL Expired

The URL for this request expired after 30 days.

Path Params

occID

uuid

required

The unique ID of the OCC.

Body Params

Request body for Update Occ Request

buyerID

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.

reviewStatus

string

Defaults to UNSPECIFIED_REVIEW_STATUS

ReviewStatus contains the status of the reviewed occ

reviewNotes

string

ReviewNotes is the review notes

reviewedBy

string

required

ReviewedBy is the reviewer's email

Responses

Response body

object

updatedOcc

object

required

UpdatedOcc is the new updated Occ response

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.

amount

object

required

Represents a monetary amount in the specified currency

paymentMethodID

uuid

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

status

string

required

Defaults to UNSPECIFIED_STATUS

UNSPECIFIED_STATUS REQUESTED UNDER_REVIEW PAYMENTS_RECEIVED READY_TO_PROCESS PENDING COMPLETED CANCELLED FAILED RETURNED OCC_STATUS_REJECTED

tenantID

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.

paymentAgreementID

uuid

required

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

activityID

uuid

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

executionType

string

required

Defaults to UNSPECIFIED_EXECUTION_TYPE

OCC Execution Type

UNSPECIFIED_EXECUTION_TYPE MANUAL AUTO

reviewStatus

string

required

Defaults to UNSPECIFIED_REVIEW_STATUS

UNSPECIFIED_REVIEW_STATUS IN_PROGRESS APPROVED REJECTED INFO_NEEDED

reviewNotes

string

manualReviewReason

string

failureCause

string

reviewedBy

string

reviewedAt

date-time | null

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

notes

string

Response body

object

code

int32

required

The underlying http status code

message

string

required

A simple message in english describing the error and can be returned to the consumer

domain

string

required

The domain where the error is originating from as defined by the service

metadata

object

Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs

Has additional fields

reason

string

Payment agreement retrieval error reason codes

Servicing_PaymentAgreement_BadRequest Servicing_PaymentAgreement_InvalidIdentity Servicing_PaymentAgreement_ServerError

Response body

object

reason

string

required

A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain

code

int32

required

The underlying http status code

message

string

required

A simple message in english describing the error and can be returned to the consumer

domain

string

required

The domain where the error is originating from as defined by the service

metadata

object

Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs

Has additional fields

Response body

object

code

int32

required

The underlying http status code

message

string

required

A simple message in english describing the error and can be returned to the consumer

domain

string

required

The domain where the error is originating from as defined by the service

metadata

object

Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs

Has additional fields

reason

string

Payment agreement retrieval error reason codes

Servicing_PaymentAgreement_BadRequest Servicing_PaymentAgreement_InvalidIdentity Servicing_PaymentAgreement_ServerError

Response body

object

code

int32

required

The underlying http status code

message

string

required

A simple message in english describing the error and can be returned to the consumer

domain

string

required

The domain where the error is originating from as defined by the service

metadata

object

Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs

Has additional fields

reason

string

Payment agreement retrieval error reason codes

Servicing_PaymentAgreement_BadRequest Servicing_PaymentAgreement_InvalidIdentity Servicing_PaymentAgreement_ServerError

Updated 5 days ago

Backdate Payment

Set OCC to be manually reviewed

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://api-preview.platform.breadpayments.com/api/servicing/occ/occID \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "reviewStatus": "UNSPECIFIED_REVIEW_STATUS"
8
}
9
'

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

application/json

text/plain

Updated 5 days ago

Backdate Payment

Set OCC to be manually reviewed

Foundations
Introduction
Auth
Get App Identitiesget
Expire Org Codespost
Authorize Org Codepost
Get Org Codesget
Create Org Codespost
Exchange Service Account JWT For Buyer JWTpost
Authorize a Service Accountpost
Exchange Org User Tokenpost
Refresh a Buyer JWTpost
Login with an OTP Codepost
Authorize a buyer based on buyer credentialspost
Verify an OTP Codepost
Get the status of a Verification OTP Codeget
List codesget
Send a Verification OTP Codepost
Models
UUID
Timestamp
Terms
Term Interval
Region
Phone
Percentage
Payment Product Type
Name
Money
Language Code
Identity
Error
Email
Date
Currency Code
Country Code
Contact
Basis Point
As Low As
Address

Merchant Operations
Introduction
Transaction
List Transactions CSVget
Transaction Aggregationget
Transaction KPIsget
Settle Transactionpost
Refund Transactionpost
Cancel Transactionpost
Authorize Transactionpost
Add Transaction Fulfillment Detailpost
Get Transaction Fulfillment Detailsget
Get Transaction Historyget
Extend Expirationpost
Update Transactionpatch
Get Transaction by Transaction IDget
Search Transactionsget
Get Transaction by Application IDget
Cart
Notify Buyerpost
Expire Cartpost
Delete Cartdelete
Update Cart informationpatch
Get Cartget
Create a Cartpost
List cartsget
Reporting
List funding daily balance dataget
Get legacy settlement reportget
List settlement report CSVget
List targeting export CSVget
List funding aggregate balance dataget
Get Loan History Report By Nameget
Funding
Get settlement reportget
Models
Transaction Metadata
Transaction

Buyer Management
Introduction
Buyer
Create a buyer bankruptcypost
Get a buyer bankruptcyget
Update a buyer's statusput
Get credit report data via service accountget
Update a buyer contactput
Get a buyer contactget
Create a buyer contactpost
Update a buyerput
Get a buyerget
Lookup buyersget
Register a buyerpost
Buyer Status
Models
Employment Type
Employment
Buyer Sub Status
Buyer Contact Map
Buyer Contact
Buyer
Authorized Third Party
Webhooks
Buyer Updated Event

Checkout
Introduction
Application
Complete Checkout for Instore Applicationpost
Prepare Checkout for Applicationpost
Complete Checkout for Applicationpost
Get Application by IDget
Start an Applicationpost
List Applications by Filterget
Virtual Card
Update Issuance Statuspost
Get wallet and DPANget
Get walletget
Get issuance cardget
Get issuanceget
Issue a new GooglePay digital wallet tokenpost
Issue a new ApplePay digital wallet tokenpost
Issue a new virtual cardpost
Models
Order Item
Order
Disclosure
Application
Webhooks

Servicing
Introduction
Servicing
Get Allowed Payment Method Typesget
Refund Paymentpost
Add an audit action for a payment agreementpost
List audit actions for a payment agreementget
GenerateDocument requests a disclosure document to be generated for the requested agreement ID. This method should only be used for special cases on specific disclosures, such as re-generating a disclosure for resolving an archer issue without notifying the buyer and requesting for acknowledgement.post
Calculate payment for a set of agreementsget
Process Scheduled Paymentspost
Process Single Scheduled Paymentpost
Cancel a future paymentdelete
Cancel a payment agreementdelete
Update the loan amountput
Update Loan Interest Ratepost
Waive principal amountpost
Waive installment due amountpost
Waive remaining outstanding balancepost
Waive any remaining amountpost
Waive an amountpost
List Scheduled Payments by Payment Agreement IDget
Closes a disputeput
Check if eligible to open a disputeget
Open a disputepost
List disputesget
Schedule Future Paymentpost
Get Payment Agreement By Numberget
Set OCC to be manually reviewedpatch
Update OCC requestpatch
Backdate Paymentpatch
Add a payment recordpost
Reallocate Paymentpatch
Cancel a paymentdelete
Make Paymentpost
Get Balance Historyget
Enroll in Autopaypost
Unenroll from Autopaydelete
Get Payment Agreementget
List Scheduled Payment by Buyer IDget
Delete payment agreement tags.delete
Update payment agreement tagsput
List Payment Agreement Summariesget
Add OCC Recordpost
List OCC requestsget
List Buyer Payment Agreementsget
List Autopay Enrollmentsget
As Low As
Get financing/loan-termsget
Get As-Low-Asget
Financing Payment Plan
Get Financing Payment Planget
Financing Dynamic Disclosure
Get Financing Dynamic Disclosureget
Disclosures
List disclosuresget
Get static disclosureget
Get disclosure by targetget
Get disclosure by IDget
Get latest disclosureget
Generate a set of disclosurespost
Disclosure Templates
Get a disclosure templateget
Webhooks
Loan Details Changed Event

Payments
Introduction
Payment Methods
List Payment Method Failuresget
Create cybersource transient tokenpost
Create Payment Method Access Tokenpost
Delete Payment Methoddelete
Get Payment Methodget
List Payment Methodsget
Create Payment Methodpost
Payments
Search Payment in Cybersourceget
Reverse Paymentput
Receive a paymentput
Lists Payment Audit Recordsget
Fail Single Paymentput
Cancel a paymentput
Get Payment by either transaction id or reconciliation idget
Get Paymentget
Refunds
stop refund paper checkput
Get Refundget
List Refundsget
Models
Card Type
Card Connection Status
Card Connection
Card Account
Bank Provider
Bank Connection Status
Bank Connection
Bank Account

Webhook
Introduction
Subscription Management
Send a Subscription Integration Test Eventpost
Delete a subscriptiondelete
Update a subscriptionpatch
Get a subscriptionget
Create a subscriptionpost
List subscriptionsget
Events
Replay an eventpost
List eventsget
Client Management
List JWKsget
Models
Subscription
Event Dispatch
Create Subscription
Webhooks
Integration Test Event

Tradein
Introduction
Tradein
Creates an Upgradeable loan based on the given payment agreement IDpost
Retrieves the UpgradeableLoan entity by its own idget
Links a buyers old and new loanpost
Retrieves the UpgradeableLoan entity related to a payment agreementget
Applies a payment to an existing loan as part of the tradein processpost
Records user tradein electionpost
Payment Agreement
Models
Upgradeable Loan Entity
Tradein Error Reason
Payment Request
Election Entity

Foundations
Introduction
Auth
Get App Identitiesget
Expire Org Codespost
Authorize Org Codepost
Get Org Codesget
Create Org Codespost
Exchange Service Account JWT For Buyer JWTpost
Authorize a Service Accountpost
Exchange Org User Tokenpost
Refresh a Buyer JWTpost
Login with an OTP Codepost
Authorize a buyer based on buyer credentialspost
Verify an OTP Codepost
Get the status of a Verification OTP Codeget
List codesget
Send a Verification OTP Codepost
Models
UUID
Timestamp
Terms
Term Interval
Region
Phone
Percentage
Payment Product Type
Name
Money
Language Code
Identity
Error
Email
Date
Currency Code
Country Code
Contact
Basis Point
As Low As
Address

Merchant Operations
Introduction
Transaction
List Transactions CSVget
Transaction Aggregationget
Transaction KPIsget
Settle Transactionpost
Refund Transactionpost
Cancel Transactionpost
Authorize Transactionpost
Add Transaction Fulfillment Detailpost
Get Transaction Fulfillment Detailsget
Get Transaction Historyget
Extend Expirationpost
Update Transactionpatch
Get Transaction by Transaction IDget
Search Transactionsget
Get Transaction by Application IDget
Cart
Notify Buyerpost
Expire Cartpost
Delete Cartdelete
Update Cart informationpatch
Get Cartget
Create a Cartpost
List cartsget
Reporting
List funding daily balance dataget
Get legacy settlement reportget
List settlement report CSVget
List targeting export CSVget
List funding aggregate balance dataget
Get Loan History Report By Nameget
Funding
Get settlement reportget
Models
Transaction Metadata
Transaction

Buyer Management
Introduction
Buyer
Create a buyer bankruptcypost
Get a buyer bankruptcyget
Update a buyer's statusput
Get credit report data via service accountget
Update a buyer contactput
Get a buyer contactget
Create a buyer contactpost
Update a buyerput
Get a buyerget
Lookup buyersget
Register a buyerpost
Buyer Status
Models
Employment Type
Employment
Buyer Sub Status
Buyer Contact Map
Buyer Contact
Buyer
Authorized Third Party
Webhooks
Buyer Updated Event

Checkout
Introduction
Application
Complete Checkout for Instore Applicationpost
Prepare Checkout for Applicationpost
Complete Checkout for Applicationpost
Get Application by IDget
Start an Applicationpost
List Applications by Filterget
Virtual Card
Update Issuance Statuspost
Get wallet and DPANget
Get walletget
Get issuance cardget
Get issuanceget
Issue a new GooglePay digital wallet tokenpost
Issue a new ApplePay digital wallet tokenpost
Issue a new virtual cardpost
Models
Order Item
Order
Disclosure
Application
Webhooks

Servicing
Introduction
Servicing
Get Allowed Payment Method Typesget
Refund Paymentpost
Add an audit action for a payment agreementpost
List audit actions for a payment agreementget
GenerateDocument requests a disclosure document to be generated for the requested agreement ID. This method should only be used for special cases on specific disclosures, such as re-generating a disclosure for resolving an archer issue without notifying the buyer and requesting for acknowledgement.post
Calculate payment for a set of agreementsget
Process Scheduled Paymentspost
Process Single Scheduled Paymentpost
Cancel a future paymentdelete
Cancel a payment agreementdelete
Update the loan amountput
Update Loan Interest Ratepost
Waive principal amountpost
Waive installment due amountpost
Waive remaining outstanding balancepost
Waive any remaining amountpost
Waive an amountpost
List Scheduled Payments by Payment Agreement IDget
Closes a disputeput
Check if eligible to open a disputeget
Open a disputepost
List disputesget
Schedule Future Paymentpost
Get Payment Agreement By Numberget
Set OCC to be manually reviewedpatch
Update OCC requestpatch
Backdate Paymentpatch
Add a payment recordpost
Reallocate Paymentpatch
Cancel a paymentdelete
Make Paymentpost
Get Balance Historyget
Enroll in Autopaypost
Unenroll from Autopaydelete
Get Payment Agreementget
List Scheduled Payment by Buyer IDget
Delete payment agreement tags.delete
Update payment agreement tagsput
List Payment Agreement Summariesget
Add OCC Recordpost
List OCC requestsget
List Buyer Payment Agreementsget
List Autopay Enrollmentsget
As Low As
Get financing/loan-termsget
Get As-Low-Asget
Financing Payment Plan
Get Financing Payment Planget
Financing Dynamic Disclosure
Get Financing Dynamic Disclosureget
Disclosures
List disclosuresget
Get static disclosureget
Get disclosure by targetget
Get disclosure by IDget
Get latest disclosureget
Generate a set of disclosurespost
Disclosure Templates
Get a disclosure templateget
Webhooks
Loan Details Changed Event

Payments
Introduction
Payment Methods
List Payment Method Failuresget
Create cybersource transient tokenpost
Create Payment Method Access Tokenpost
Delete Payment Methoddelete
Get Payment Methodget
List Payment Methodsget
Create Payment Methodpost
Payments
Search Payment in Cybersourceget
Reverse Paymentput
Receive a paymentput
Lists Payment Audit Recordsget
Fail Single Paymentput
Cancel a paymentput
Get Payment by either transaction id or reconciliation idget
Get Paymentget
Refunds
stop refund paper checkput
Get Refundget
List Refundsget
Models
Card Type
Card Connection Status
Card Connection
Card Account
Bank Provider
Bank Connection Status
Bank Connection
Bank Account

Webhook
Introduction
Subscription Management
Send a Subscription Integration Test Eventpost
Delete a subscriptiondelete
Update a subscriptionpatch
Get a subscriptionget
Create a subscriptionpost
List subscriptionsget
Events
Replay an eventpost
List eventsget
Client Management
List JWKsget
Models
Subscription
Event Dispatch
Create Subscription
Webhooks
Integration Test Event

Tradein
Introduction
Tradein
Creates an Upgradeable loan based on the given payment agreement IDpost
Retrieves the UpgradeableLoan entity by its own idget
Links a buyers old and new loanpost
Retrieves the UpgradeableLoan entity related to a payment agreementget
Applies a payment to an existing loan as part of the tradein processpost
Records user tradein electionpost
Payment Agreement
Models
Upgradeable Loan Entity
Tradein Error Reason
Payment Request
Election Entity

200a successful response

400an unsuccessful response

401Unauthorized. Indicates that provided credentials is not valid

403an unsuccessful response

500an unsuccessful response