STstarkbank
Merchant Purchase

Create Merchant Purchase

This route is used to charge a card that has been previously saved. Cards can only be used in this route once a previous purchase was approved through a Merchant Session Purchase.

post/v2/merchant-purchase

Request

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

Request body

amountinteger required

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

cardIdstring required

The ID of the Merchant Card to be used for the purchase.

fundingTypestring required

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

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.

challengeModestring

Defines whether or not a holder verification (3DS) will be used when authorizing the purchase. Options are "enabled" and "disabled". Default: "enabled"

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 buyer'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.