API Reference
Start typing to search…

List OCC requests

get https://api-preview.platform.breadpayments.com/api/servicing/occ

Returns a list of OCCs according to given parameters.

Log in to see full request history
Query Params
uuid

Filter by a specific Payment Agreement ID

uuid

Filter by a specific Buyer ID

status.eq
array of strings

Filter by one or more OCC statuses

status.eq
reviewStatus.eq
array of strings

Filter by one or more review statuses

reviewStatus.eq
date-time

Filter by creation date greater or equal to the provided one. Must use with CreatedAtLte.

date-time

Filter by creation date preceding or equal to the provided one. Must use with CreatedAtGte.

integer

Filter by a minimum amount. Must use with amount.lte

integer

Filter by a maximum amount. Must use with amount.gte

string

Sort response records

integer
≥ 1

The maximum number of records that will be returned in a result set. Default is all records, no limit

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

string

A human-friendly unique ID for a payment agreement.

Responses

Updated about 4 hours ago

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated about 4 hours ago