VTEX · Example Payload

Vtex 2Sendpaymentswithsavedcreditcard Example

CommerceE-CommerceRetailMarketplacePayments

Vtex 2Sendpaymentswithsavedcreditcard Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "2.SendPaymentsWithSavedCreditCard",
  "method": "POST",
  "path": "/api/pvt/transactions/{transactionId}/payments",
  "summary": "VTex 2.2 Send payments with saved credit card",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "1EED2BE7683644B4B4D441B0AFCE4004",
        "paymentSystem": 4,
        "paymentSystemName": "Mastercard",
        "merchantName": null,
        "group": "creditCard",
        "userProfileId": null,
        "isCustom": false,
        "allowInstallments": true,
        "requiresAuthentication": false,
        "allowIssuer": true,
        "allowNotification": false,
        "isAvailable": true,
        "description": null,
        "authorizationDate": null,
        "self": {
          "href": "/api/pvt/transactions/99129781C2D84F2AA55E62B72B14A7E9/payments/1EED2BE7683644B4B4D441B0AFCE4004"
        },
        "tid": null,
        "nsu": null,
        "returnCode": null,
        "returnMessage": null,
        "status": "Received",
        "connector": null,
        "ConnectorResponses": null,
        "connectorResponse": null,
        "ShowConnectorResponses": false,
        "value": 30000,
        "installmentsInterestRate": 0,
        "installmentsValue": 0,
        "referenceValue": 30000,
        "installments": 1,
        "currencyCode": "BRL",
        "provider": null,
        "isBillingAddressDifferent": null,
        "isRegexValid": null,
        "isLuhnValid": null,
        "fields": [
          {
            "name": "AvailableRules",
            "value": "993d4d35-b64d-454d-8108-c560580160e0,eae3d89b-7dc7-4862-931d-e6d4e1ff838c"
          },
          {
            "name": "originalPaymentSystem",
            "value": "4"
          },
          {
            "name": "baseUrl",
            "value": "https://cosmetics2.vtexpayments.com.br:443"
          },
          {
            "name": "currencyCode",
            "value": "BRL"
          },
          {
            "name": "usedAccountId",
            "value": "False"
          },
          {
            "name": "cardHolder",
            "value": "UserTest"
          },
          {
            "name": "firstDigits",
            "value": "537824"
          },
          {
            "name": "lastDigits",
            "value": "9174"
          },
          {
            "name": "expiryMonth",
            "value": "10"
          },
          {
            "name": "expiryYear",
            "value": "2019"
          },
          {
            "name": "accountId",
            "value": "09F1F6C21F764BBF85D0039F4A2D3E04"
          }
        ],
        "sheets": null,
        "originalPaymentId": null
      }
    }
  ]
}