STstarkbank
Merchant Session

Create Merchant Session Purchase

This route can be used to create a Merchant Purchase directly from the payer's client application. The UUID of a Merchant Session that was previously created by the merchant is necessary to access this route. This route is currently not available in the SDKs. Your front-end must call "POST /v2/merchant-session/:uuid/purchase" directly on the Stark Bank API.

post/v2/merchant-session/{uuid}/purchase

Request

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

Path parameters

uuidstring required

The UUID of the Merchant Session created by the merchant to process the purchase.

Request body

amountinteger required

A non-negative integer that represents the amount in cents to be received. E.g: 100 (R$1.00)

cardExpirationstring required

A string in the format YYYY-MM representing the expiration of the card to be used for the purchase.

cardNumberstring required

A string representing the number of the card to be used for the purchase.

cardSecurityCodestring required

A string representing the security code of the card to be used for the purchase.

fundingTypestring required

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

holderNamestring required

The name of the card holder as it appears on the card.

billingCitystring required

The billing city associated with the card used for the purchase. Required if challengeMode is "enabled" and optional otherwise.

billingCountryCodestring required

The billing country code associated with the card used for the purchase. Required if challengeMode is "enabled" and optional otherwise.

billingStateCodestring required

The billing state code associated with the card used for the purchase. Required if challengeMode is "enabled" and optional otherwise.

billingStreetLine1string required

The billing street address associated with the card used for the purchase. Required if challengeMode is "enabled" and optional otherwise.

billingStreetLine2string required

The billing street address complement associated with the card used for the purchase. Required if challengeMode is "enabled" and optional otherwise.

billingZipCodestring required

The billing zip code associated with the card used for the purchase. Required if challengeMode is "enabled" and optional otherwise.

holderEmailstring required

The email associated with the holder of the card used for the purchase. Required if challengeMode is "enabled" and optional otherwise.

holderPhonestring required

The phone number associated with the holder of the card used for the purchase. Required if challengeMode is "enabled" and optional otherwise.

installmentCountstring

A non-negative integer that represents the number of purchase installments. Default: 1

metadatastring required

An object containing additional data related to the purchase. If 3DS is enabled, the following fields related to the payer's device are required: userAgent, timezoneOffset, userIp, language.

Response

Successful operation

object required

Changes

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