Vtex Paymentdetails 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
{
"operationId": "PaymentDetails",
"method": "GET",
"path": "/api/pvt/transactions/{transactionId}/payments/{paymentId}",
"summary": "VTex Get payment details",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"id": "20147A81H48B64D8DA1423AFD32D6671C",
"paymentSystem": 2,
"paymentSystemName": "Visa",
"merchantName": null,
"group": "creditCard",
"userProfileId": null,
"isCustom": false,
"allowInstallments": true,
"requiresAuthentication": false,
"allowIssuer": true,
"allowNotification": false,
"isAvailable": true,
"description": null,
"authorizationDate": "2023-06-02T17:04:23",
"self": {
"href": "/api/pvt/transactions/D8640778F8194C50BB42BD4F9D282AD8/payments/20147A81H48B64D8DA1423AFD32D6671C"
},
"tid": "pi_3NEbOkCp13eGpuNm179AVYJ5",
"nsu": null,
"returnCode": null,
"returnMessage": null,
"status": "Finished",
"connector": "payment-test-v1",
"ConnectorResponses": {
"Tid": "pi_3NEbOkCp13eGpuNm172AVYJ4",
"ReturnCode": null,
"Message": null,
"authId": "kh07vt",
"nsu": "p0dug1"
},
"connectorResponse": {
"Tid": "pi_3NEbOkCp13eGpuNm172AVYJ4",
"ReturnCode": null,
"Message": null,
"authId": "kh07vt",
"nsu": "p0dug1"
},
"ShowConnectorResponses": true,
"value": 61400,
"installmentsInterestRate": 0,
"installmentsValue": 61400,
"referenceValue": 61400,
"installments": 1,
"currencyCode": "BRL",
"provider": null,
"isBillingAddressDifferent": false,
"isRegexValid": null,
"isLuhnValid": null,
"fields": [
{
"name": "AvailableRules",
"value": "74410430-43b4-4b40-99f4-887f18f945dd,dc47c1f5-6950-4e38-b3af-1f56fc56ddd9,52e7e8ff-8508-4ac4-a78a-c5ddb054a0ee"
},
{
"name": "originalPaymentSystem",
"value": "2"
},
{
"name": "callbackUrl",
"value": "https://payment-test.myvtex.com/checkout/gatewayCallback/1336650505288/Success"
},
{
"name": "baseUrl",
"value": "https://payment-test.vtexpayments.com.br:443"
},
{
"name": "currencyCode",
"value": "BRL"
},
{
"name": "usedAccountId",
"value": "True"
},
{
"name": "cardHolder",
"value": "teste teste"
},
{
"name": "firstDigits",
"value": "400000"
},
{
"name": "lastDigits",
"value": "0002"
},
{
"name": "expiryMonth",
"value": "05"
},
{
"name": "expiryYear",
"value": "2038"
},
{
"name": "parentAccountId",
"value": "08134AF761A148B9A5DCE14A81F31DD9"
},
{
"name": "accountId",
"value": "08134AF761A148B9A5DCE14A81F31DD9"
},
{
"name": "address",
"value": "{\"addressType\":\"residential\",\"addressId\":\"8427936352555\",\"postalCode\":\"22250040\",\"street\":\"Praia Botafogo\",\"neighborhood\":\"Botafogo\",\"city\":\"Rio de Janeiro\",\"state\":\"RJ\",\"country\":\"BRA\",\"number\":\"123\",\"complement\":null}"
},
{
"name": "affiliationId",
"value": "4696dd94-a6c2-4206-a90e-6348d7fb8a97"
},
{
"name": "ruleId",
"value": "74450431-23b4-4b40-99f4-887f18f945dd"
},
{
"name": "ruleName",
"value": "payment test"
},
{
"name": "sequence",
"value": "505288-0"
},
{
"name": "paymentMethod",
"value": "Visa"
},
{
"name": "authorizationConnectorResponse",
"value": "{\"paymentId\":\"20147A81H48B64D8DA1423AFD32D6671C\",\"status\":\"approved\",\"acquirer\":null,\"code\":null,\"message\":null,\"authorizationId\":\"kh07vt\",\"nsu\":\"p0dug1\",\"tid\":\"i_3NEbOkCp13eGpuNm172AVYJ4\"}"
},
{
"name": "tid",
"value": "pi_3NEbOkCp13eGpuNm172AVYJ4"
},
{
"name": "connector",
"value": "Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector"
},
{
"name": "waitingForAutoSettle",
"value": "06/06/2023 17:04:23 P UTC"
},
{
"name": "settlementConnectorResponse",
"value": "{\"settleId\":\"iy20l\",\"value\":614.0,\"requestId\":\"2023-06-02T17:05:42-61400\",\"paymentId\":\"20147A81H48B64D8DA1423AFD32D6671C\",\"code\":null,\"message\":null}"
},
{
"name": "refundingConnectorResponse",
"value": "{\"refundId\":null,\"value\":0.0,\"requestId\":\"req_SDh1bz40RayDaI\",\"paymentId\":null,\"code\":\"charge_already_refunded\",\"message\":\"Charge ch_3NEbOkCp13eGpuNm1XGACuQG has already been refunded.\"}"
},
{
"name": "refund",
"value": "[{\"Id\":\"53e9229e-eac7-4fce-b353-55be479e9d6d\",\"Token\":\"05136362B4464EBB99191A188033A048\",\"RefundDate\":\"2023-06-02T17:05:59.4129308Z\",\"ValueAsInt\":100,\"RefundType\":1},{\"Id\":\"b19bf9e5-0c13-495f-9316-41a857251be7\",\"Token\":\"D8640778F8194C50BB42BD4F9D282AD8\",\"RefundDate\":\"2023-06-02T17:06:08.4184954Z\",\"ValueAsInt\":61300,\"RefundType\":0}]"
}
],
"sheets": null,
"originalPaymentId": null
}
}
]
}