STstarkbank
Merchant Session

Create Merchant Sessions

This route allows the merchant to create a session that can be used by the card holder's application to create a new purchase. The UUID parameter returned by the session should be used to create a Merchant Session Purchase.

post/v2/merchant-session

Request

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

Request body

allowedFundingTypesstring required

The types of funding that are allowed to be used for the purchase. Options are "credit" and "debit".

allowedInstallmentsstring required

The amount and number of installments allowed for the purchase. A non-negative integer that represents the amount in cents to be received and the number of installments. E.g: 100 (R$1.00).

expirationinteger required

Time in seconds counted from the creation datetime until the session expires. After expiration, a purchase cannot be created using the session anymore. E.g.: 3600 (1 hour).

allowedIpsstring

The IP addresses that are allowed to create a purchase using the session.

challengeModestring

Defines whether or not a holder verification (3DS) will be used when authorizing the purchase. 3DS is a protocol designed to enhance security for e-commerce purchases. When enabled, the issuer provides a link for the card holder to complete a verification challenge. Options are "enabled" and "disabled". Default: "enabled"

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.