STstarkbank
Payment Request

Create Payment Requests

Use this route to create new payment requests in our Web Banking approval flow.

post/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

Request body

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

paymentstring required

JSON specifying the requested payment. The payment JSON is the same as those passed in the requests that create the payments without going through the approval flow (see transfer and boleto payment). The only exception is that the "scheduled" parameter cannot be sent on these JSONs, as the PaymentRequest "due" parameter already serves this purpose. The SDKs also accept their respective objects instead of JSONs.

duestring date-time

Suggested payment date. This parameter may be altered by the controllers of the cost center. Default is today. Example: "2020-08-01"

tagsstring[]

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

typestring required

Payment type. The SDKs will take care of this parameter for you if you use their specialized objects. But if you pass a dictionary in payment parameter you need to inform its type. Examples: "transfer", "brcode-payment", "boleto-payment", "utility-payment".

Response

Successful operation

object required

Changes

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