latestOpenAPI 3.0.42026-08-202078952.1 MB

f37f136ed35a

Payment policy assignments

Get all payment policy assignments

Returns all payment policy assignments matching the specified filter parameters. An assignment links a payment policy to a rate group or rate. Override assignments are not included. Note this operation supports Portfolio Access Tokens.

post/api/connector/v1/paymentPolicyAssignments/getAll

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

EnterpriseIdsstring[] nullable

Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.

PaymentPolicyAssignmentIdsstring[] nullable

Unique identifiers of the payment policy assignments.

PaymentPolicyIdsstring[] nullable

Unique identifiers of the payment policies.

RateGroupIdsstring[] nullable

Unique identifiers of the rate groups.

RateIdsstring[] nullable

Unique identifiers of the rates.

ActivityStatesActivityStates[] nullable

Whether to return only active, only deleted, or both types of record. If not specified, only active records will be returned.

Response

OK

Cursorstring uuid nullable

Pagination cursor for retrieving the next page of results. Null if there are no more results.