STstarkbank
Payment Request

List Payment Requests

Here you can list and filter payment requests created by the requesting user. We return it paged.

get/v2/payment-request

Request

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

Query parameters

centerIdstring required

Unique ID of the targeted cost center. You can check out the cost center ID directly on its approval section on our Web Banking. Example: 5656565656565656

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.

sortstring

Sort order considered in the response. Options are: "-created" and "-due". Default is "-created".

statusstring

Filter payment requests by the specified status. Example: success

tagsstring[]

Filter entities that contain the specified tags.

typestring

Filters payment requests by the type inferred from the payment parameter, if it is not a dictionary. Example: boleto-payment

Response

Successful operation

object required

Changes

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