STstarkbank
Split Receiver

List Split Receivers

Get a list of Split Receivers in chunks of at most 100. If you need smaller chunks, use the limit parameter.

get/v2/split-receiver

Request

  • Base URL
    https://api.starkbank.com
  • URL
    https://api.starkbank.com/v2/split-receiver
  • Auth
    API key in header Digital-Signature

Query parameters

afterstring date

Filter entities created after this date.

beforestring date

Filter entities created before this date.

cursorstring

String used to get the next batch of results. Our SDKs handle this for you.

fieldsstring[]

List of strings to filter response JSON keys. Not available in the SDKs.

idsstring[]

List of strings to get specific entities by ids.

limitinteger

Number of results per cursor. Max = 100.

receiverIdsstring[]

List of receiver ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545'].

statusstring

Filter split receivers by the specified status.

tagsstring[]

Filter entities that contain the specified tags.

taxIdsstring[]

List of up to 100 tax IDs (CPF or CNPJ) to filter retrieved splitReceivers. Example: ["012.345.678-90", "45.059.493/0001-73"].

Response

Successful operation

object required

Changes

No recorded changes to this operation across all 1 revision of this API.