v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-202547455.8 KB

Transaction process

Send payments information

This request is used to send the payment data.

Permissions

This endpoint does not require authentication or permissions.

post/api/payments/transactions/{transactionId}/payments

Path parameters

transactionIdstring required

Example:A3BDE325F76B4B758B398D900DF06150

Transaction identification.

Query parameters

anstring required

Example:cosmetics2

Account name.

orderIdstring required

Example:1248716513905

Order identification.

Headers

Content-Typestring required

Example:application/json

Type of the content being sent.

Acceptstring required

Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

paymentSystemnumber required

Payment system identification.

installmentsnumber required

Number of installments.

currencyCodestring required

Currency code in ISO 4217 standard.

valuenumber required

Payment value.

installmentsInterestRatenumber required

The interest rate.

installmentsValuenumber required

The value of each installment.

referenceValuenumber required

Value amount of the payment without interest applied. This value is the same as the value field when installmentsInterestRate is 0.0.

Example request

[
  {
    "paymentSystem": 17,
    "installments": 1,
    "currencyCode": "BRL",
    "value": 15000,
    "referenceValue": 15000,
    "fields": {
      "holderName": "UserTest",
      "cardNumber": "111111111111",
      "validationCode": "231",
      "dueDate": "10/19",
      "document": "8041734561",
      "accountId": "08134AF761A148B9A5DCE14A81F31DD9",
      "address": {
        "addressType": "Residential",
        "receiverName": "Clark Kent",
        "postalCode": "5555555",
        "city": "Sao Paulo",
        "state": "SP",
        "country": "BRA",
        "street": "Avenue Splendor Garden",
        "number": 111,
        "neighborhood": "Sumare",
        "complement": "House",
        "reference": "Close to the bank.",
        "geoCoordinates": [
          -47.924747467041016,
          -15.832582473754883
        ]
      },
      "callbackUrl": "https://coinshop.vtexpayments.com.br/payment-provider/transactions/900BA26FEAC84332A53AE1007E740DE3/payments/E713830E32764BF99028A0A275841BFC/notification"
    },
    "transaction": {
      "id": "72E84719BDF14B2FB170B38AD12598C9",
      "merchantName": "cosmetics2"
    }
  }
]

Response

Created

This endpoint does not return a response body.