Skip to main content
PUT
Set clients for a transaction

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the dashboard.

X-Environment
string
header
required

Target environment for the request. Must be "test" or "live".

Path Parameters

transactionId
string<uuid>
required

Body

application/json
clients
object[]
required

Response

200 - application/json

OK

scopes
enum<string>[]
required
Available options:
base,
MX:AV,
MX:AV:ARI,
MX:AV:AVI,
MX:AV:INM,
MX:AV:JYS,
MX:AV:MJR,
MX:AV:MPC,
MX:AV:TSC,
MX:AV:VEH,
MX:CNBV,
MX:CNBV:TRANSMISOR,
MX
id
string<uuid>
required
timestamp
string<date-time>
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
isAlerted
boolean
required
alertedAt
string<date-time> | null
required
status
enum<string>
default:not_applicable

Status

Available options:
not_applicable,
pending,
completed,
failed,
cancelled
amount

Amount

currency
any

Currency

exchangeRates
object

Exchange Rates

externalId
string

External ID

description
string

Description

productId
string<uuid>
metadata
object

Metadata

scopeData
object
riskAssessments
object
tags
object[]