Create merchant transaction

Create a new merchant transaction (sale) for a specific merchant associated with a marketplace.

This endpoint allows for the creation of merchant sale transactions with installment support, MDR calculations, and scheduled payment dates. The default status is SCHEDULED. However, if the merchant is a marketplace scheduler, the transaction will automatically be set to WAITING_SPLIT status.

This endpoint generates a Merchant transaction created event.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uint64
required
1 to 18446744073709552000

Marketplace ID

uint64
required
1 to 18446744073709552000

Merchant ID

Body Params
string
required

Event datetime. The datetime format follows the ISO 8601 format (UTC).

float
required

Merchant transaction amount

int32
required
1 to 2147483647

Number of installments

string
required

Processing code.
For more information, refer to Processing codes.

string

Represents the currency with an ISO-4217 alphabetic or numeric (3 characters) string. For example, you represent Brazilian real with either BRL or 986. If you don't provide this code, the system uses the currency from the merchant program.

number | null

Authorization identifier

string | null
enum

Defines the status of the merchant transaction request.

  • The default value is SCHEDULED for merchant schedulers, or WAITING_SPLIT for marketplace schedulers.
  • The WAITING_SPLIT status should only be used when the transaction needs to wait for split request processing, and only if the merchant_id provided is the schedule_id.
  • The schedule_id can be obtained through the marketplace query API.
Allowed:
Headers
string
required

Authorization token

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json