Skip to main content
POST
List Service Provider settlements

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

The body is of type object.

Response

200 - application/json

findSettlementsServiceProvider

success
boolean

Whether the request was processed successfully. Declines return HTTP 200 with success: false.

Example:

true

message
string

Human-readable result message.

Example:

"succeeded"

code
string

Machine-readable result code. See the Error Codes reference.

Example:

"0"

data
object[]

The response payload.

totals
object

Aggregate totals across all returned records.

query
object

Echo of the query envelope that produced this result.

Last modified on July 14, 2026