STstarkbank
Invoice Pull Subscription

Create Invoice Pull Subscriptions

Use this route to create new invoice pull subscriptions.

post/v2/invoice-pull-subscription

Request

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

Request body

displayDescriptionstring

Description to be presented to the payer.

externalIdstring

Safe string that must be unique among all your Invoice PullSubscriptions to prevent duplicates.

intervalstring required

Cycle definition of the Invoice Pull Requests. Options are "week", "month", "quarter", "semester" and "year".

namestring

Name of the debtor.

pullModestring required

Defines if the invoice pull requests will be made automatically by Stark Bank or manually by the company.

pullRetryLimitstring required

Defines how many times the receiver is able to create Invoice Pull Requests for retries. Options are "0" and "3".

referenceCodestring

Safe string that must be unique among all your Pix Subscriptions and represent a contract.

startstring required

Expected date to settle the first Invoice Pull Request.

taxIdstring

Tax id of the debtor.

typestring required

Subscription journey type. Options: "push", "qrcode", "qrcodeAndPayment" or "paymentAndOrQrcode".

amountinteger required

Fixed amount to be charged every cycle. Required if the subscription has a fixed amount, and never sent together with amountMinLimit. Minimum is 1 (R$0.01).

amountMinLimitstring required

Minimum amount limit that the payer can set to be charged every cycle. Required if the subscription has a variable amount, and never sent together with amount. Minimum is 1 (R$0.01).

datastring required

Additional data required by some types of invoice pull subscription. On creation, it is required for the push, qrcodeAndPayment and paymentAndOrQrcode types, and not required for the qrcode type. For the push type, it sets the bank account details of the payer, with accountNumber, branchCode, bankCode and taxId as required strings. For the qrcodeAndPayment or paymentAndOrQrcode types, it sets the immediate payment parameters: amount in cents is required, while due in ISO 8601 (default: 2 days after creation), expiration in seconds (default 5097600, 59 days), fine as a fixed percentage (default 2.00) and interest as a monthly percentage (default 1.00) are optional. This parameter only defines what you send on creation. When an active subscription is later retrieved or listed, the data returned in the response can contain the payer's accountNumber, bankCode, branchCode and taxId regardless of the authorization journey.

duestring date-time

Due date for answering with an approval or denial. If not provided, defaults to 2 days after creation.

endstring

Determines the final date of the 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.