Skip to main content
POST
/
api
/
v1
/
transactions
Criar transação
curl --request POST \
  --url https://upay-sistema-api.onrender.com/api/v1/transactions \
  --header 'API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product": "<string>",
  "amountCents": 2,
  "paymentMethod": "PIX",
  "clientEmail": "jsmith@example.com",
  "clientName": "<string>",
  "paymentLinkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "installments": 6,
  "dueDate": "2023-11-07T05:31:56Z",
  "trackingParams": {}
}
'
{
  "message": "<string>",
  "transaction": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "displayId": "<string>",
    "product": "<string>",
    "amountCents": 123,
    "status": "<string>",
    "paymentMethod": "<string>",
    "client": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "trackingParams": {}
  }
}

Authorizations

​
API-Key
string
header
required

Chave de API obtida através do endpoint /api/credentials. Também aceita formato Bearer Token: Authorization: Bearer <api_key>

Body

application/json
​
product
string
required
​
amountCents
integer
required
Required range: x >= 1
​
paymentMethod
enum<string>
required
Available options:
PIX,
CREDIT_CARD,
BOLETO
​
clientEmail
string<email>
required
​
clientName
string
required
​
paymentLinkId
string<uuid>
​
installments
integer
Required range: 1 <= x <= 12
​
dueDate
string<date-time>
​
trackingParams
object

Parâmetros de rastreamento (UTMs como utm_source, utm_medium, utm_campaign, ou identificadores como fbclid, gclid, src)

Response

Transação criada com sucesso

​
message
string
​
transaction
object