STstarkbank
Invoice Pull Request

Create Invoice Pull Requests

Use this route to create new invoice pull requests.

post/v2/invoice-pull-request

Request

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

Request body

attemptTypestring

Define the type of attempt, if it is the first one of a billing cycle or if it is a retry. Options: "default", "retry". Default is "default".

duestring date-time required

Expected date of settlement.

invoiceIdstring required

Unique ID of the invoice to be pulled.

subscriptionIdstring required

Unique ID of the invoice pull subscription.

tagsstring[]

Array of strings to tag the entity for future queries. All tags will be converted to lowercase.

Response

Successful operation

object required

Changes

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