{"id":"82c7d479-6ab3-4b0b-9b7e-49f630161513","createdDate":"2023-08-03T12:12:41.154Z","updatedDate":"2023-08-03T12:12:41.154Z","resourceId":"482e1b83-298f-474a-a2b2-7d6b7fa853eb","api":{"schema":{"object":{"displayName":"Transaction Object","description":"","slug":"transaction-object","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Transaction","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/cashier.git"},"methods":[{"summary":"Create Transaction","description":"Creates initial request for a transaction to authorize and optionally capture funds. Capture can be executed separately with an additional API call. Use this endpoint to execute one-time and [recurring payments]().","operationId":"wix.wixpay.transaction.api.v3.TransactionServiceV3.CreateTransaction","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.CreateTransactionResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/transaction-service/v3","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/transaction-service/v3","destinationPath":"/v3","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/payments/v3/transactions","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/payments/v3/transactions","destinationPath":"/v3/transactions","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateTransactionRequest","description":"","properties":{"accountId":{"title":"accountId","description":"Wix Payments account ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"paymentMethodType":{"title":"paymentMethodType","description":"Do not use this field.","type":"string","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"message":"Do not use this field."}}},"paymentMethodTypeId":{"title":"paymentMethodTypeId","description":"Type ID of payment method to use.\nSupported values are `creditCard`, `cardReader`, `ach`, `applePay`, `googlePay`, `boleto`, `giropay`, `iDeal`, `payPal`, `pix`, `sepa`, `sofort`.\nPass specific data for each payment method type using a corresponding parameter.\nFor example, pass the parameter `card` when passing `creditCard` for this field.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"amount":{"title":"amount","description":"Payment amount in minor units, for example, cents.","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"currency":{"title":"currency","description":"Payment currency according to ISO 4217. For example: USD, EUR, GBP.","format":"CURRENCY","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"idempotencyKey":{"title":"idempotencyKey","description":"Key to ensure idempotency.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"externalTransactionId":{"title":"externalTransactionId","description":"Corresponding transaction ID within the external entity that initiated the transaction.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"externalInvoiceId":{"title":"externalInvoiceId","description":"Corresponding invoice ID within the external entity that made the request.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"externalOrderId":{"title":"externalOrderId","description":"Order ID provided by the external entity that initiated the request.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"externalBuyerId":{"title":"externalBuyerId","description":"Customer ID provided by the external entity that initiated the request.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"automaticCapture":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.AutomaticCapture","summary":"automaticCapture","description":"Whether to capture this transaction automatically. When not passed, the transaction can be manually captured later.","x-wix-docs":{"exposure":"PUBLIC"}},"returnUrl":{"title":"returnUrl","description":"URL to return to after redirection to the payment approval page.","format":"URI","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"installmentCount":{"title":"installmentCount","description":"Number of installments (must be greater than 1 to trigger payment in installments).","minimum":2,"maximum":1000,"$ref":"#/components/schemas/google.protobuf.UInt32Value","x-wix-docs":{"exposure":"PUBLIC"}},"items":{"title":"items","description":"Order line items.","maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Item"},"x-wix-docs":{"exposure":"PUBLIC"}},"billingAddress":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.AddressDetails","summary":"billingAddress","description":"Billing address.","x-wix-docs":{"exposure":"PUBLIC"}},"shippingAddress":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.AddressDetails","summary":"shippingAddress","description":"Shipping address.","x-wix-docs":{"exposure":"PUBLIC"}},"riskData":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.RiskData","summary":"riskData","description":"Payment information for the transaction's risk evaluation score.","x-wix-docs":{"exposure":"PUBLIC"}},"externalFee":{"title":"externalFee","description":"Additional application-specific fee in minor units, for example, cents.","$ref":"#/components/schemas/google.protobuf.UInt64Value","x-wix-docs":{"exposure":"PUBLIC"}},"metadata":{"title":"metadata","description":"Metadata to store within the created transaction.","maxItems":16,"type":"object","format":"map","properties":{"key:value":{"type":"string","description":"\"key\" of type string, \"value\" of type string","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}},"softDescriptor":{"title":"softDescriptor","description":"Complete description that appears on the customers' statements.","maxLength":20,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"amountBreakdown":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.AmountBreakdown","summary":"amountBreakdown","description":"Amount breakdown.","x-wix-docs":{"exposure":"PUBLIC"}},"forceSca":{"title":"forceSca","description":"Prefer Strong Customer Authentication","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"oneOf":[{"description":"","summary":"transactionType","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.CreateTransactionRequest.transactionType"},{"description":"","summary":"paymentMethod","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.CreateTransactionRequest.paymentMethod"}],"required":["accountId","currency","transactionType"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.wixpay.transaction.api.v3.TransactionServiceV3","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PAYMENTS_NOT_ALLOWED"}],"exposure":"PUBLIC","permissions":["PAYMENTS.TRANSACTIONS_CREATE"],"externalPermissionScopes":[{"name":"Manage Transactions","scopeId":"SCOPE.DC-PAYMENTS.MANAGE-TRANSACTIONS"}],"protoArtifactId":"com.wixpress:transactions-proto","serviceArtifactId":"com.wixpress.wixpay.transaction-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.wixpay.transaction.api.v3.CreateTransactionRequest","responseMessage":"wix.wixpay.transaction.api.v3.CreateTransactionResponse"},"legacyExamples":[{"name":"CreateTransaction","type":"METHOD","order":3,"content":{"title":"Create authorization (setupCofOnSession)","description":"Create a transaction object and only authorize the funds with the intent for the subsequent transactions","request":"curl -X POST \\\nhttps://www.wixapis.com/payments/v3/transactions \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"items\": [\n {\n \"id\": \"3f2939f3-cbb3-46c7-9682-dbacaa52d3ca\",\n \"title\": \"Product#1\",\n \"unitPrice\": \"100\",\n \"quantity\": 1,\n \"category\": \"DIGITAL\"\n }\n ],\n \"metadata\": {\n \"metadataKey\": \"metadataValue\"\n },\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"amount\": \"100\",\n \"currency\": \"USD\",\n \"externalInvoiceId\": \"4a3f71e5-9c20-4aca-b994-3b5bbd57a2bd\",\n \"externalOrderId\": \"4a3f71e5-9c20-4aca-b994-3b5bbd57a2bd\",\n \"returnUrl\": \"https://wix.com/3ds\",\n \"paymentMethodTypeId\": \"creditCard\",\n \"card\": {\n \"numberToken\": \"675f55ed-adfe-4411-b4cf-aaa8e614a715\",\n \"expiryMonth\": 12,\n \"expiryYear\": 2025,\n \"holderName\": \"PAYMENTS TESTS\",\n \"securityCodeToken\": \"46cc9574-cf5f-4e47-bfc8-f833e1bfddb3\"\n },\n \"externalBuyerId\": \"4a3f71e5-9c20-4aca-b994-3b5bbd57a2bd\",\n \"billingAddress\": {\n \"address\": {\n \"country\": \"US\",\n \"city\": \"New York\",\n \"postalCode\": \"10003\",\n \"streetAddress\": {\n \"number\": \"20\",\n \"name\": \"Cooper Square\"\n }\n },\n \"contactDetails\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345675432\",\n \"company\": \"Company wix.com\",\n \"email\": \"john.doe@test.com\",\n \"vatId\": {\n \"id\": \"134424234\",\n \"type\": \"UNSPECIFIED\"\n }\n }\n },\n \"idempotencyKey\": \"9f5a2e55-b0ec-484e-8247-460de104f3ba\",\n \"externalTransactionId\": \"d44150d8-1cbe-4ead-9f1d-c9a673698a7f\",\n \"setupCofOnSession\": {}\n}'","response":"{\n \"transaction\": {\n \"id\": \"b3442dfc-f5a3-4c85-bd24-3a139c43dacd\",\n \"currency\": \"USD\",\n \"capturableAmount\": \"100\",\n \"refundableAmount\": \"0\",\n \"externalTransactionId\": \"d44150d8-1cbe-4ead-9f1d-c9a673698a7f\",\n \"providerTransactionId\": \"pi_1H7deCAaXaGogcA7uSlhLXm2\",\n \"metadata\": {\n \"metadataKey\": \"metadataValue\"\n },\n \"authorization\": {\n \"amount\": \"100\",\n \"status\": \"SUCCEEDED\",\n \"networkReference\": {\n \"networkTransactionId\": \"WvTnyhZlYER07Ate\"\n },\n \"authCode\": \"123456\"\n },\n \"captures\": [],\n \"refunds\": [],\n \"disputes\": [],\n \"voids\": [],\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"paymentMethod\": {\n \"typeId\": \"creditCard\"\n }\n }\n}"}},{"name":"CreateTransaction","type":"METHOD","order":1,"content":{"title":"Create authorization","description":"Create a transaction object and only authorize the funds","request":"curl -X POST \\\nhttps://www.wixapis.com/payments/v3/transactions \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"items\":[\n {\n \"id\":\"ItemID\",\n \"title\":\"ItemTitle\",\n \"unitPrice\":\"100\",\n \"quantity\":1,\n \"category\":\"DIGITAL\"\n }\n ],\n \"metadata\":{\n \"metadataKey\":\"metadataValue\"\n },\n \"accountId\":\"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"amount\":\"100\",\n \"currency\":\"USD\",\n \"externalInvoiceId\":\"4a3f71e5-9c20-4aca-b994-3b5bbd57a2bd\",\n \"externalOrderId\":\"4a3f71e5-9c20-4aca-b994-3b5bbd57a2bd\",\n \"returnUrl\":\"https://wix.com/3ds\",\n \"paymentMethodTypeId\": \"creditCard\",\n \"card\":{\n \"numberToken\":\"675f55ed-adfe-4411-b4cf-aaa8e614a715\",\n \"expiryMonth\":12,\n \"expiryYear\":2025,\n \"holderName\":\"PAYMENTS TESTS\",\n \"securityCodeToken\":\"46cc9574-cf5f-4e47-bfc8-f833e1bfddb3\"\n },\n \"externalBuyerId\":\"4a3f71e5-9c20-4aca-b994-3b5bbd57a2bd\",\n \"billingAddress\":{\n \"address\":{\n \"country\":\"US\",\n \"city\":\"New York\",\n \"postalCode\":\"10003\",\n \"streetAddress\":{\n \"number\":\"20\",\n \"name\":\"Cooper Square\"\n }\n },\n \"contactDetails\":{\n \"firstName\":\"John\",\n \"lastName\":\"Doe\",\n \"phone\":\"12345675432\",\n \"company\":\"Company wix.com\",\n \"email\":\"john.doe@test.com\",\n \"vatId\":{\n \"id\":\"134424234\",\n \"type\":\"UNSPECIFIED\"\n }\n }\n },\n \"oneTimePayment\":{\n },\n \"idempotencyKey\":\"9d47c0f7-7e89-481a-ad2d-920d97188d71\",\n \"externalTransactionId\":\"d44150d8-1cbe-4ead-9f1d-c9a673698a7f\"\n}'","response":"{\n \"transaction\": {\n \"id\": \"43075a59-6a23-4f5f-b4dd-2bb636770458\",\n \"currency\": \"USD\",\n \"capturableAmount\": \"100\",\n \"refundableAmount\": \"0\",\n \"externalTransactionId\": \"d44150d8-1cbe-4ead-9f1d-c9a673698a7f\",\n \"providerTransactionId\": \"pi_1H7db4AaXaGogcA7ZwUvuZ68\",\n \"metadata\": {\n \"metadataKey\": \"metadataValue\"\n },\n \"authorization\": {\n \"amount\": \"100\",\n \"status\": \"SUCCEEDED\",\n \"networkReference\": {\n \"networkTransactionId\": \"WvTnyhZlYER07Ate\"\n },\n \"authCode\": \"123456\"\n },\n \"captures\": [],\n \"refunds\": [],\n \"disputes\": [],\n \"voids\": [],\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"paymentMethod\": {\n \"typeId\": \"creditCard\"\n }\n }\n}"}},{"name":"CreateTransaction","type":"METHOD","order":2,"content":{"title":"Create authorization and capture","description":"Create a transaction object to authorize and capture funds","request":"curl -X POST \\\nhttps://www.wixapis.com/payments/v3/transactions \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"items\": [\n {\n \"id\": \"3f2939f3-cbb3-46c7-9682-dbacaa52d3ca\",\n \"title\": \"Product#1\",\n \"unitPrice\": \"100\",\n \"quantity\": 1,\n \"category\": \"DIGITAL\"\n }\n ],\n \"metadata\": {\n \"metadataKey\": \"metadataValue\"\n },\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"amount\": \"100\",\n \"currency\": \"USD\",\n \"externalInvoiceId\": \"4a3f71e5-9c20-4aca-b994-3b5bbd57a2bd\",\n \"externalOrderId\": \"4a3f71e5-9c20-4aca-b994-3b5bbd57a2bd\",\n \"returnUrl\": \"https://wix.com/3ds\",\n \"paymentMethodTypeId\": \"creditCard\",\n \"card\": {\n \"numberToken\": \"675f55ed-adfe-4411-b4cf-aaa8e614a715\",\n \"expiryMonth\": 12,\n \"expiryYear\": 2025,\n \"holderName\": \"PAYMENTS TESTS\",\n \"securityCodeToken\": \"46cc9574-cf5f-4e47-bfc8-f833e1bfddb3\"\n },\n \"externalBuyerId\": \"4a3f71e5-9c20-4aca-b994-3b5bbd57a2bd\",\n \"billingAddress\": {\n \"address\": {\n \"country\": \"US\",\n \"city\": \"New York\",\n \"postalCode\": \"10003\",\n \"streetAddress\": {\n \"number\": \"20\",\n \"name\": \"Cooper Square\"\n }\n },\n \"contactDetails\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345675432\",\n \"company\": \"Company wix.com\",\n \"email\": \"john.doe@test.com\",\n \"vatId\": {\n \"id\": \"134424234\",\n \"type\": \"UNSPECIFIED\"\n }\n }\n },\n \"idempotencyKey\": \"9f5a2e55-b0ec-484e-8247-460de104f3bd\",\n \"externalTransactionId\": \"d44150d8-1cbe-4ead-9f1d-c9a673698a7f\",\n \"automaticCapture\": {},\n \"oneTimePayment\": {}\n}'","response":"{\n \"transaction\": {\n \"id\": \"42610dbd-459f-4e8e-99be-d661676ce669\",\n \"currency\": \"USD\",\n \"capturableAmount\": \"0\",\n \"refundableAmount\": \"100\",\n \"externalTransactionId\": \"d44150d8-1cbe-4ead-9f1d-c9a673698a7f\",\n \"providerTransactionId\": \"pi_1H7dd6AaXaGogcA7eU3JzGl7\",\n \"metadata\": {\n \"metadataKey\": \"metadataValue\"\n },\n \"authorization\": {\n \"amount\": \"100\",\n \"status\": \"SUCCEEDED\",\n \"networkReference\": {\n \"networkTransactionId\": \"WvTnyhZlYER07Ate\"\n },\n \"authCode\": \"123456\"\n },\n \"captures\": [{\n \"id\": \"42610dbd-459f-4e8e-99be-d661676ce669\",\n \"amount\": \"100\",\n \"status\": \"SUCCEEDED\",\n \"metadata\": {}\n }],\n \"refunds\": [],\n \"disputes\": [],\n \"voids\": [],\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"paymentMethod\": {\n \"typeId\": \"creditCard\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cashier.git"},"httpMethod":"post","path":"/v3/transactions","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.wixpay.transaction.api.v3.TransactionServiceV3","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"PAYMENTS_NOT_ALLOWED"}],"exposure":"PUBLIC","permissions":["PAYMENTS.TRANSACTIONS_CREATE"],"externalPermissionScopes":[{"name":"Manage Transactions","scopeId":"SCOPE.DC-PAYMENTS.MANAGE-TRANSACTIONS"}],"protoArtifactId":"com.wixpress:transactions-proto","serviceArtifactId":"com.wixpress.wixpay.transaction-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.wixpay.transaction.api.v3.CreateTransactionRequest","responseMessage":"wix.wixpay.transaction.api.v3.CreateTransactionResponse"},"legacyExamples":[{"name":"CreateTransaction","type":"METHOD","order":3,"content":{"title":"Create authorization (setupCofOnSession)","description":"Create a transaction object and only authorize the funds with the intent for the subsequent transactions","request":"curl -X POST \\\nhttps://www.wixapis.com/payments/v3/transactions \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"items\": [\n {\n \"id\": \"3f2939f3-cbb3-46c7-9682-dbacaa52d3ca\",\n \"title\": \"Product#1\",\n \"unitPrice\": \"100\",\n \"quantity\": 1,\n \"category\": \"DIGITAL\"\n }\n ],\n \"metadata\": {\n \"metadataKey\": \"metadataValue\"\n },\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"amount\": \"100\",\n \"currency\": \"USD\",\n \"externalInvoiceId\": \"4a3f71e5-9c20-4aca-b994-3b5bbd57a2bd\",\n \"externalOrderId\": \"4a3f71e5-9c20-4aca-b994-3b5bbd57a2bd\",\n \"returnUrl\": \"https://wix.com/3ds\",\n \"paymentMethodTypeId\": \"creditCard\",\n \"card\": {\n \"numberToken\": \"675f55ed-adfe-4411-b4cf-aaa8e614a715\",\n \"expiryMonth\": 12,\n \"expiryYear\": 2025,\n \"holderName\": \"PAYMENTS TESTS\",\n \"securityCodeToken\": \"46cc9574-cf5f-4e47-bfc8-f833e1bfddb3\"\n },\n \"externalBuyerId\": \"4a3f71e5-9c20-4aca-b994-3b5bbd57a2bd\",\n \"billingAddress\": {\n \"address\": {\n \"country\": \"US\",\n \"city\": \"New York\",\n \"postalCode\": \"10003\",\n \"streetAddress\": {\n \"number\": \"20\",\n \"name\": \"Cooper Square\"\n }\n },\n \"contactDetails\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345675432\",\n \"company\": \"Company wix.com\",\n \"email\": \"john.doe@test.com\",\n \"vatId\": {\n \"id\": \"134424234\",\n \"type\": \"UNSPECIFIED\"\n }\n }\n },\n \"idempotencyKey\": \"9f5a2e55-b0ec-484e-8247-460de104f3ba\",\n \"externalTransactionId\": \"d44150d8-1cbe-4ead-9f1d-c9a673698a7f\",\n \"setupCofOnSession\": {}\n}'","response":"{\n \"transaction\": {\n \"id\": \"b3442dfc-f5a3-4c85-bd24-3a139c43dacd\",\n \"currency\": \"USD\",\n \"capturableAmount\": \"100\",\n \"refundableAmount\": \"0\",\n \"externalTransactionId\": \"d44150d8-1cbe-4ead-9f1d-c9a673698a7f\",\n \"providerTransactionId\": \"pi_1H7deCAaXaGogcA7uSlhLXm2\",\n \"metadata\": {\n \"metadataKey\": \"metadataValue\"\n },\n \"authorization\": {\n \"amount\": \"100\",\n \"status\": \"SUCCEEDED\",\n \"networkReference\": {\n \"networkTransactionId\": \"WvTnyhZlYER07Ate\"\n },\n \"authCode\": \"123456\"\n },\n \"captures\": [],\n \"refunds\": [],\n \"disputes\": [],\n \"voids\": [],\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"paymentMethod\": {\n \"typeId\": \"creditCard\"\n }\n }\n}"}},{"name":"CreateTransaction","type":"METHOD","order":1,"content":{"title":"Create authorization","description":"Create a transaction object and only authorize the funds","request":"curl -X POST \\\nhttps://www.wixapis.com/payments/v3/transactions \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"items\":[\n {\n \"id\":\"ItemID\",\n \"title\":\"ItemTitle\",\n \"unitPrice\":\"100\",\n \"quantity\":1,\n \"category\":\"DIGITAL\"\n }\n ],\n \"metadata\":{\n \"metadataKey\":\"metadataValue\"\n },\n \"accountId\":\"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"amount\":\"100\",\n \"currency\":\"USD\",\n \"externalInvoiceId\":\"4a3f71e5-9c20-4aca-b994-3b5bbd57a2bd\",\n \"externalOrderId\":\"4a3f71e5-9c20-4aca-b994-3b5bbd57a2bd\",\n \"returnUrl\":\"https://wix.com/3ds\",\n \"paymentMethodTypeId\": \"creditCard\",\n \"card\":{\n \"numberToken\":\"675f55ed-adfe-4411-b4cf-aaa8e614a715\",\n \"expiryMonth\":12,\n \"expiryYear\":2025,\n \"holderName\":\"PAYMENTS TESTS\",\n \"securityCodeToken\":\"46cc9574-cf5f-4e47-bfc8-f833e1bfddb3\"\n },\n \"externalBuyerId\":\"4a3f71e5-9c20-4aca-b994-3b5bbd57a2bd\",\n \"billingAddress\":{\n \"address\":{\n \"country\":\"US\",\n \"city\":\"New York\",\n \"postalCode\":\"10003\",\n \"streetAddress\":{\n \"number\":\"20\",\n \"name\":\"Cooper Square\"\n }\n },\n \"contactDetails\":{\n \"firstName\":\"John\",\n \"lastName\":\"Doe\",\n \"phone\":\"12345675432\",\n \"company\":\"Company wix.com\",\n \"email\":\"john.doe@test.com\",\n \"vatId\":{\n \"id\":\"134424234\",\n \"type\":\"UNSPECIFIED\"\n }\n }\n },\n \"oneTimePayment\":{\n },\n \"idempotencyKey\":\"9d47c0f7-7e89-481a-ad2d-920d97188d71\",\n \"externalTransactionId\":\"d44150d8-1cbe-4ead-9f1d-c9a673698a7f\"\n}'","response":"{\n \"transaction\": {\n \"id\": \"43075a59-6a23-4f5f-b4dd-2bb636770458\",\n \"currency\": \"USD\",\n \"capturableAmount\": \"100\",\n \"refundableAmount\": \"0\",\n \"externalTransactionId\": \"d44150d8-1cbe-4ead-9f1d-c9a673698a7f\",\n \"providerTransactionId\": \"pi_1H7db4AaXaGogcA7ZwUvuZ68\",\n \"metadata\": {\n \"metadataKey\": \"metadataValue\"\n },\n \"authorization\": {\n \"amount\": \"100\",\n \"status\": \"SUCCEEDED\",\n \"networkReference\": {\n \"networkTransactionId\": \"WvTnyhZlYER07Ate\"\n },\n \"authCode\": \"123456\"\n },\n \"captures\": [],\n \"refunds\": [],\n \"disputes\": [],\n \"voids\": [],\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"paymentMethod\": {\n \"typeId\": \"creditCard\"\n }\n }\n}"}},{"name":"CreateTransaction","type":"METHOD","order":2,"content":{"title":"Create authorization and capture","description":"Create a transaction object to authorize and capture funds","request":"curl -X POST \\\nhttps://www.wixapis.com/payments/v3/transactions \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"items\": [\n {\n \"id\": \"3f2939f3-cbb3-46c7-9682-dbacaa52d3ca\",\n \"title\": \"Product#1\",\n \"unitPrice\": \"100\",\n \"quantity\": 1,\n \"category\": \"DIGITAL\"\n }\n ],\n \"metadata\": {\n \"metadataKey\": \"metadataValue\"\n },\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"amount\": \"100\",\n \"currency\": \"USD\",\n \"externalInvoiceId\": \"4a3f71e5-9c20-4aca-b994-3b5bbd57a2bd\",\n \"externalOrderId\": \"4a3f71e5-9c20-4aca-b994-3b5bbd57a2bd\",\n \"returnUrl\": \"https://wix.com/3ds\",\n \"paymentMethodTypeId\": \"creditCard\",\n \"card\": {\n \"numberToken\": \"675f55ed-adfe-4411-b4cf-aaa8e614a715\",\n \"expiryMonth\": 12,\n \"expiryYear\": 2025,\n \"holderName\": \"PAYMENTS TESTS\",\n \"securityCodeToken\": \"46cc9574-cf5f-4e47-bfc8-f833e1bfddb3\"\n },\n \"externalBuyerId\": \"4a3f71e5-9c20-4aca-b994-3b5bbd57a2bd\",\n \"billingAddress\": {\n \"address\": {\n \"country\": \"US\",\n \"city\": \"New York\",\n \"postalCode\": \"10003\",\n \"streetAddress\": {\n \"number\": \"20\",\n \"name\": \"Cooper Square\"\n }\n },\n \"contactDetails\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"phone\": \"12345675432\",\n \"company\": \"Company wix.com\",\n \"email\": \"john.doe@test.com\",\n \"vatId\": {\n \"id\": \"134424234\",\n \"type\": \"UNSPECIFIED\"\n }\n }\n },\n \"idempotencyKey\": \"9f5a2e55-b0ec-484e-8247-460de104f3bd\",\n \"externalTransactionId\": \"d44150d8-1cbe-4ead-9f1d-c9a673698a7f\",\n \"automaticCapture\": {},\n \"oneTimePayment\": {}\n}'","response":"{\n \"transaction\": {\n \"id\": \"42610dbd-459f-4e8e-99be-d661676ce669\",\n \"currency\": \"USD\",\n \"capturableAmount\": \"0\",\n \"refundableAmount\": \"100\",\n \"externalTransactionId\": \"d44150d8-1cbe-4ead-9f1d-c9a673698a7f\",\n \"providerTransactionId\": \"pi_1H7dd6AaXaGogcA7eU3JzGl7\",\n \"metadata\": {\n \"metadataKey\": \"metadataValue\"\n },\n \"authorization\": {\n \"amount\": \"100\",\n \"status\": \"SUCCEEDED\",\n \"networkReference\": {\n \"networkTransactionId\": \"WvTnyhZlYER07Ate\"\n },\n \"authCode\": \"123456\"\n },\n \"captures\": [{\n \"id\": \"42610dbd-459f-4e8e-99be-d661676ce669\",\n \"amount\": \"100\",\n \"status\": \"SUCCEEDED\",\n \"metadata\": {}\n }],\n \"refunds\": [],\n \"disputes\": [],\n \"voids\": [],\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"paymentMethod\": {\n \"typeId\": \"creditCard\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cashier.git","contentLink":{"displayName":"Create Transaction","slugifiedName":"create-transaction"}},{"summary":"Get Transaction","description":"Retrieves transaction info by ID.","operationId":"wix.wixpay.transaction.api.v3.TransactionServiceV3.GetTransaction","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"transactionId","description":"Transaction ID.","x-wix-docs":{"exposure":"PUBLIC"}},{"name":"accountId","in":"query","description":"Wix Payments account ID.","required":true,"schema":{"title":"accountId","description":"Wix Payments account ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.GetTransactionResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/transaction-service/v3","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/transaction-service/v3","destinationPath":"/v3","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/payments/v3/transactions","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/payments/v3/transactions","destinationPath":"/v3/transactions","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.wixpay.transaction.api.v3.TransactionServiceV3","errors":[],"exposure":"PUBLIC","permissions":["PAYMENTS.TRANSACTIONS_READ"],"externalPermissionScopes":[{"name":"Manage Disputes","scopeId":"SCOPE.DC-PAYMENTS.MANAGE-DISPUTES"},{"name":"Manage Refunds","scopeId":"SCOPE.DC-PAYMENTS.MANAGE-REFUNDS"},{"name":"Manage Transactions","scopeId":"SCOPE.DC-PAYMENTS.MANAGE-TRANSACTIONS"}],"protoArtifactId":"com.wixpress:transactions-proto","serviceArtifactId":"com.wixpress.wixpay.transaction-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.wixpay.transaction.api.v3.GetTransactionRequest","responseMessage":"wix.wixpay.transaction.api.v3.GetTransactionResponse"},"legacyExamples":[{"name":"GetTransaction","type":"METHOD","order":1,"content":{"title":"Get transaction","description":"Retrieve all transaction data by ID","request":"curl -X GET \\\nhttps://www.wixapis.com/payments/v3/transactions/4f68983f-9b70-438e-8130-4fff0b97cf48?accountId=6f82b2ce-2a15-4bd7-84b5-392c74b3719c \\\n -H 'Authorization: ' \\","response":"{\n \"transaction\": {\n \"id\": \"4f68983f-9b70-438e-8130-4fff0b97cf48\",\n \"currency\": \"USD\",\n \"capturableAmount\": \"0\",\n \"refundableAmount\": \"0\",\n \"providerTransactionId\": \"pi_1H83lWAaXaGogcA7gt5WsjjP\",\n \"metadata\": {\n \"metadataKey\": \"metadataValue\"\n },\n \"authorization\": {\n \"amount\": \"200\",\n \"status\": \"SUCCEEDED\",\n \"networkReference\": {\n \"networkTransactionId\": \"WvTnyhZlYER07Ate\"\n },\n \"authCode\": \"123456\"\n },\n \"captures\": [{\n \"id\": \"4f68983f-9b70-438e-8130-4fff0b97cf48\",\n \"amount\": \"200\",\n \"status\": \"SUCCEEDED\",\n \"metadata\": {}\n }],\n \"refunds\": [{\n \"id\": \"1dd0bfdc-bf5d-47cb-8d9b-bc2c6d6591d6\",\n \"amount\": \"200\",\n \"reason\": \"BUYER_REQUEST\",\n \"status\": \"SUCCEEDED\",\n \"providerRefundId\": \"re_1H83mOAaXaGogcA7QYx89USb\",\n \"metadata\": {}\n }],\n \"disputes\": [],\n \"voids\": [],\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"paymentMethod\": {\n \"typeId\": \"creditCard\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cashier.git"},"httpMethod":"get","path":"/v3/transactions/{transactionId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.wixpay.transaction.api.v3.TransactionServiceV3","errors":[],"exposure":"PUBLIC","permissions":["PAYMENTS.TRANSACTIONS_READ"],"externalPermissionScopes":[{"name":"Manage Disputes","scopeId":"SCOPE.DC-PAYMENTS.MANAGE-DISPUTES"},{"name":"Manage Refunds","scopeId":"SCOPE.DC-PAYMENTS.MANAGE-REFUNDS"},{"name":"Manage Transactions","scopeId":"SCOPE.DC-PAYMENTS.MANAGE-TRANSACTIONS"}],"protoArtifactId":"com.wixpress:transactions-proto","serviceArtifactId":"com.wixpress.wixpay.transaction-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.wixpay.transaction.api.v3.GetTransactionRequest","responseMessage":"wix.wixpay.transaction.api.v3.GetTransactionResponse"},"legacyExamples":[{"name":"GetTransaction","type":"METHOD","order":1,"content":{"title":"Get transaction","description":"Retrieve all transaction data by ID","request":"curl -X GET \\\nhttps://www.wixapis.com/payments/v3/transactions/4f68983f-9b70-438e-8130-4fff0b97cf48?accountId=6f82b2ce-2a15-4bd7-84b5-392c74b3719c \\\n -H 'Authorization: ' \\","response":"{\n \"transaction\": {\n \"id\": \"4f68983f-9b70-438e-8130-4fff0b97cf48\",\n \"currency\": \"USD\",\n \"capturableAmount\": \"0\",\n \"refundableAmount\": \"0\",\n \"providerTransactionId\": \"pi_1H83lWAaXaGogcA7gt5WsjjP\",\n \"metadata\": {\n \"metadataKey\": \"metadataValue\"\n },\n \"authorization\": {\n \"amount\": \"200\",\n \"status\": \"SUCCEEDED\",\n \"networkReference\": {\n \"networkTransactionId\": \"WvTnyhZlYER07Ate\"\n },\n \"authCode\": \"123456\"\n },\n \"captures\": [{\n \"id\": \"4f68983f-9b70-438e-8130-4fff0b97cf48\",\n \"amount\": \"200\",\n \"status\": \"SUCCEEDED\",\n \"metadata\": {}\n }],\n \"refunds\": [{\n \"id\": \"1dd0bfdc-bf5d-47cb-8d9b-bc2c6d6591d6\",\n \"amount\": \"200\",\n \"reason\": \"BUYER_REQUEST\",\n \"status\": \"SUCCEEDED\",\n \"providerRefundId\": \"re_1H83mOAaXaGogcA7QYx89USb\",\n \"metadata\": {}\n }],\n \"disputes\": [],\n \"voids\": [],\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"paymentMethod\": {\n \"typeId\": \"creditCard\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cashier.git","contentLink":{"displayName":"Get Transaction","slugifiedName":"get-transaction"}},{"summary":"Capture Transaction","description":"Manually captures an authorized transaction by ID.","operationId":"wix.wixpay.transaction.api.v3.TransactionServiceV3.CaptureTransaction","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"transactionId","description":"Transaction ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.CaptureTransactionResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/transaction-service/v3","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/transaction-service/v3","destinationPath":"/v3","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/payments/v3/transactions","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/payments/v3/transactions","destinationPath":"/v3/transactions","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CaptureTransactionRequest","description":"","properties":{"accountId":{"title":"accountId","description":"Wix Payments account ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"amount":{"title":"amount","description":"Amount to capture in minor units (for example, cents). When not passed, the whole transaction amount will be captured.","$ref":"#/components/schemas/google.protobuf.UInt64Value","x-wix-docs":{"exposure":"PUBLIC"}},"capturableAmount":{"title":"capturableAmount","description":"Amount that can be captured or voided in minor units to place a hold on a card to reserve funds.\nSpecify the amount to prevent double partial captures.","$ref":"#/components/schemas/google.protobuf.UInt64Value","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"message":"Amount that can be captured or voided in minor units to place a hold on a card to reserve funds.\nSpecify the amount to prevent double partial captures."}}},"idempotencyKey":{"title":"idempotencyKey","description":"Key to ensure idempotency.","minLength":1,"maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"externalCaptureId":{"title":"externalCaptureId","description":"Corresponding capture ID within the external entity that initiated the transaction capture.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"metadata":{"title":"metadata","description":"Metadata to store within the created capture.","maxItems":16,"type":"object","format":"map","properties":{"key:value":{"type":"string","description":"\"key\" of type string, \"value\" of type string","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["accountId","transactionId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.wixpay.transaction.api.v3.TransactionServiceV3","errors":[{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"TRANSACTION_ALREADY_CAPTURED"}],"exposure":"PUBLIC","permissions":["PAYMENTS.TRANSACTIONS_CAPTURE"],"externalPermissionScopes":[{"name":"Manage Transactions","scopeId":"SCOPE.DC-PAYMENTS.MANAGE-TRANSACTIONS"}],"protoArtifactId":"com.wixpress:transactions-proto","serviceArtifactId":"com.wixpress.wixpay.transaction-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.wixpay.transaction.api.v3.CaptureTransactionRequest","responseMessage":"wix.wixpay.transaction.api.v3.CaptureTransactionResponse"},"legacyExamples":[{"name":"CaptureTransaction","type":"METHOD","order":1,"content":{"title":"Capture an authorized transaction","description":"Capture previously created authorized transaction","request":"curl -X POST \\\nhttps://www.wixapis.com/payments/v3/transactions/29298cc4-43b1-4ae9-bd52-be5e35cd114b/capture \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\"\n}'","response":"{\n \"transaction\": {\n \"id\": \"29298cc4-43b1-4ae9-bd52-be5e35cd114b\",\n \"currency\": \"USD\",\n \"capturableAmount\": \"0\",\n \"refundableAmount\": \"100\",\n \"providerTransactionId\": \"pi_1H7iJ4AaXaGogcA7QBfvragk\",\n \"metadata\": {\n \"metadataKey\": \"metadataValue\"\n },\n \"authorization\": {\n \"amount\": \"100\",\n \"status\": \"SUCCEEDED\",\n \"networkReference\": {\n \"networkTransactionId\": \"WvTnyhZlYER07Ate\"\n },\n \"authCode\": \"123456\"\n },\n \"captures\": [{\n \"id\": \"a885c8b6-8794-4f61-9fb0-bec93e0715b4\",\n \"amount\": \"100\",\n \"status\": \"SUCCEEDED\",\n \"metadata\": {}\n }],\n \"refunds\": [],\n \"disputes\": [],\n \"voids\": [],\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"paymentMethod\": {\n \"typeId\": \"creditCard\"\n }\n },\n \"captureId\": \"a885c8b6-8794-4f61-9fb0-bec93e0715b4\"\n}"}}],"sourceRepo":"git@github.com:wix-private/cashier.git"},"httpMethod":"post","path":"/v3/transactions/{transactionId}/capture","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.wixpay.transaction.api.v3.TransactionServiceV3","errors":[{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"TRANSACTION_ALREADY_CAPTURED"}],"exposure":"PUBLIC","permissions":["PAYMENTS.TRANSACTIONS_CAPTURE"],"externalPermissionScopes":[{"name":"Manage Transactions","scopeId":"SCOPE.DC-PAYMENTS.MANAGE-TRANSACTIONS"}],"protoArtifactId":"com.wixpress:transactions-proto","serviceArtifactId":"com.wixpress.wixpay.transaction-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.wixpay.transaction.api.v3.CaptureTransactionRequest","responseMessage":"wix.wixpay.transaction.api.v3.CaptureTransactionResponse"},"legacyExamples":[{"name":"CaptureTransaction","type":"METHOD","order":1,"content":{"title":"Capture an authorized transaction","description":"Capture previously created authorized transaction","request":"curl -X POST \\\nhttps://www.wixapis.com/payments/v3/transactions/29298cc4-43b1-4ae9-bd52-be5e35cd114b/capture \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\"\n}'","response":"{\n \"transaction\": {\n \"id\": \"29298cc4-43b1-4ae9-bd52-be5e35cd114b\",\n \"currency\": \"USD\",\n \"capturableAmount\": \"0\",\n \"refundableAmount\": \"100\",\n \"providerTransactionId\": \"pi_1H7iJ4AaXaGogcA7QBfvragk\",\n \"metadata\": {\n \"metadataKey\": \"metadataValue\"\n },\n \"authorization\": {\n \"amount\": \"100\",\n \"status\": \"SUCCEEDED\",\n \"networkReference\": {\n \"networkTransactionId\": \"WvTnyhZlYER07Ate\"\n },\n \"authCode\": \"123456\"\n },\n \"captures\": [{\n \"id\": \"a885c8b6-8794-4f61-9fb0-bec93e0715b4\",\n \"amount\": \"100\",\n \"status\": \"SUCCEEDED\",\n \"metadata\": {}\n }],\n \"refunds\": [],\n \"disputes\": [],\n \"voids\": [],\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"paymentMethod\": {\n \"typeId\": \"creditCard\"\n }\n },\n \"captureId\": \"a885c8b6-8794-4f61-9fb0-bec93e0715b4\"\n}"}}],"sourceRepo":"git@github.com:wix-private/cashier.git","contentLink":{"displayName":"Capture Transaction","slugifiedName":"capture-transaction"}},{"summary":"Void Or Refund Transaction","description":"Voids or refunds the transaction by ID. Voids if the transaction was only authorized. Refunds if the transaction was already captured.","operationId":"wix.wixpay.transaction.api.v3.TransactionServiceV3.VoidOrRefundTransaction","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"transactionId","description":"Transaction ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.VoidOrRefundTransactionResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/transaction-service/v3","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/transaction-service/v3","destinationPath":"/v3","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/payments/v3/transactions","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/payments/v3/transactions","destinationPath":"/v3/transactions","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"VoidOrRefundTransactionRequest","description":"","properties":{"accountId":{"title":"accountId","description":"Wix Payments account ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"amount":{"title":"amount","description":"Amount to capture in minor units (for example, cents). Leave empty to capture the whole transaction amount.","$ref":"#/components/schemas/google.protobuf.UInt64Value","x-wix-docs":{"exposure":"PUBLIC"}},"capturableAmount":{"title":"capturableAmount","description":"Amount that can be captured or voided in minor units to place a hold on a card to reserve funds.\nSpecify the amount to prevent double partial refunds.","$ref":"#/components/schemas/google.protobuf.UInt64Value","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"message":"Amount that can be captured or voided in minor units to place a hold on a card to reserve funds.\nSpecify the amount to prevent double partial refunds."}}},"refundableAmount":{"title":"refundableAmount","description":"Amount in minor units that can be refunded.\nSpecify the amount to prevent double partial refunds.","$ref":"#/components/schemas/google.protobuf.UInt64Value","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"message":"Amount in minor units that can be refunded.\nSpecify the amount to prevent double partial refunds."}}},"idempotencyKey":{"title":"idempotencyKey","description":"Key to ensure idempotency.","minLength":1,"maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"externalVoidOrRefundId":{"title":"externalVoidOrRefundId","description":"Corresponding void or refund ID within the external entity that made the request.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"reason":{"title":"reason","description":"Reason for void or refund.","type":"string","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.TransactionModificationReason","x-wix-docs":{"exposure":"PUBLIC"}},"metadata":{"title":"metadata","description":"Metadata to store within the created void or refund.","maxItems":16,"type":"object","format":"map","properties":{"key:value":{"type":"string","description":"\"key\" of type string, \"value\" of type string","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["accountId","transactionId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.wixpay.transaction.api.v3.TransactionServiceV3","errors":[{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"TRANSACTION_ALREADY_VOIDED"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"TRANSACTION_ALREADY_REFUNDED"}],"exposure":"PUBLIC","permissions":["PAYMENTS.TRANSACTIONS_REFUND"],"externalPermissionScopes":[{"name":"Manage Refunds","scopeId":"SCOPE.DC-PAYMENTS.MANAGE-REFUNDS"}],"protoArtifactId":"com.wixpress:transactions-proto","serviceArtifactId":"com.wixpress.wixpay.transaction-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.wixpay.transaction.api.v3.VoidOrRefundTransactionRequest","responseMessage":"wix.wixpay.transaction.api.v3.VoidOrRefundTransactionResponse"},"legacyExamples":[{"name":"VoidOrRefundTransaction","type":"METHOD","order":2,"content":{"title":"Void transaction","description":"Void previously authorized transaction","request":"curl -X POST \\\nhttps://www.wixapis.com/payments/v3/transactions/4c37853b-79d5-4f0a-aadc-e8c3c4f2c322/refund \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"reason\": \"DUPLICATE_PAYMENT\"\n}'","response":"{\n \"transaction\": {\n \"id\": \"4c37853b-79d5-4f0a-aadc-e8c3c4f2c322\",\n \"currency\": \"USD\",\n \"capturableAmount\": \"0\",\n \"refundableAmount\": \"0\",\n \"providerTransactionId\": \"pi_1H83dsAaXaGogcA79BM4BR4p\",\n \"metadata\": {\n \"metadataKey\": \"metadataValue\"\n },\n \"authorization\": {\n \"amount\": \"200\",\n \"status\": \"SUCCEEDED\",\n \"networkReference\": {\n \"networkTransactionId\": \"WvTnyhZlYER07Ate\"\n },\n \"authCode\": \"123456\"\n },\n \"captures\": [],\n \"refunds\": [],\n \"disputes\": [],\n \"voids\": [{\n \"id\": \"46680dd9-e5e2-4864-91fc-fb5f89f9ea31\",\n \"reason\": \"DUPLICATE_PAYMENT\",\n \"status\": \"SUCCEEDED\",\n \"providerVoidId\": \"re_1H83gfAaXaGogcA76YInLo5D\",\n \"metadata\": {}\n }],\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"paymentMethod\": {\n \"typeId\": \"creditCard\"\n }\n },\n \"voidId\": \"46680dd9-e5e2-4864-91fc-fb5f89f9ea31\"\n}"}},{"name":"VoidOrRefundTransaction","type":"METHOD","order":1,"content":{"title":"Refund transaction","description":"Refund previously captured transaction","request":"curl -X POST \\\nhttps://www.wixapis.com/payments/v3/transactions/4f68983f-9b70-438e-8130-4fff0b97cf48/refund \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"reason\": \"BUYER_REQUEST\"\n}'","response":"{\n \"transaction\": {\n \"id\": \"4f68983f-9b70-438e-8130-4fff0b97cf48\",\n \"currency\": \"USD\",\n \"capturableAmount\": \"0\",\n \"refundableAmount\": \"0\",\n \"providerTransactionId\": \"pi_1H83lWAaXaGogcA7gt5WsjjP\",\n \"metadata\": {\n \"metadataKey\": \"metadataValue\"\n },\n \"authorization\": {\n \"amount\": \"200\",\n \"status\": \"SUCCEEDED\",\n \"networkReference\": {\n \"networkTransactionId\": \"WvTnyhZlYER07Ate\"\n },\n \"authCode\": \"123456\"\n },\n \"captures\": [{\n \"id\": \"4f68983f-9b70-438e-8130-4fff0b97cf48\",\n \"amount\": \"200\",\n \"status\": \"SUCCEEDED\",\n \"metadata\": {}\n }],\n \"refunds\": [{\n \"id\": \"1dd0bfdc-bf5d-47cb-8d9b-bc2c6d6591d6\",\n \"amount\": \"200\",\n \"reason\": \"BUYER_REQUEST\",\n \"status\": \"SUCCEEDED\",\n \"providerRefundId\": \"re_1H83mOAaXaGogcA7QYx89USb\",\n \"metadata\": {}\n }],\n \"disputes\": [],\n \"voids\": [],\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"paymentMethod\": {\n \"typeId\": \"creditCard\"\n }\n },\n \"refundId\": \"1dd0bfdc-bf5d-47cb-8d9b-bc2c6d6591d6\"\n}"}}],"sourceRepo":"git@github.com:wix-private/cashier.git"},"httpMethod":"post","path":"/v3/transactions/{transactionId}/refund","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.wixpay.transaction.api.v3.TransactionServiceV3","errors":[{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"TRANSACTION_ALREADY_VOIDED"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"TRANSACTION_ALREADY_REFUNDED"}],"exposure":"PUBLIC","permissions":["PAYMENTS.TRANSACTIONS_REFUND"],"externalPermissionScopes":[{"name":"Manage Refunds","scopeId":"SCOPE.DC-PAYMENTS.MANAGE-REFUNDS"}],"protoArtifactId":"com.wixpress:transactions-proto","serviceArtifactId":"com.wixpress.wixpay.transaction-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.wixpay.transaction.api.v3.VoidOrRefundTransactionRequest","responseMessage":"wix.wixpay.transaction.api.v3.VoidOrRefundTransactionResponse"},"legacyExamples":[{"name":"VoidOrRefundTransaction","type":"METHOD","order":2,"content":{"title":"Void transaction","description":"Void previously authorized transaction","request":"curl -X POST \\\nhttps://www.wixapis.com/payments/v3/transactions/4c37853b-79d5-4f0a-aadc-e8c3c4f2c322/refund \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"reason\": \"DUPLICATE_PAYMENT\"\n}'","response":"{\n \"transaction\": {\n \"id\": \"4c37853b-79d5-4f0a-aadc-e8c3c4f2c322\",\n \"currency\": \"USD\",\n \"capturableAmount\": \"0\",\n \"refundableAmount\": \"0\",\n \"providerTransactionId\": \"pi_1H83dsAaXaGogcA79BM4BR4p\",\n \"metadata\": {\n \"metadataKey\": \"metadataValue\"\n },\n \"authorization\": {\n \"amount\": \"200\",\n \"status\": \"SUCCEEDED\",\n \"networkReference\": {\n \"networkTransactionId\": \"WvTnyhZlYER07Ate\"\n },\n \"authCode\": \"123456\"\n },\n \"captures\": [],\n \"refunds\": [],\n \"disputes\": [],\n \"voids\": [{\n \"id\": \"46680dd9-e5e2-4864-91fc-fb5f89f9ea31\",\n \"reason\": \"DUPLICATE_PAYMENT\",\n \"status\": \"SUCCEEDED\",\n \"providerVoidId\": \"re_1H83gfAaXaGogcA76YInLo5D\",\n \"metadata\": {}\n }],\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"paymentMethod\": {\n \"typeId\": \"creditCard\"\n }\n },\n \"voidId\": \"46680dd9-e5e2-4864-91fc-fb5f89f9ea31\"\n}"}},{"name":"VoidOrRefundTransaction","type":"METHOD","order":1,"content":{"title":"Refund transaction","description":"Refund previously captured transaction","request":"curl -X POST \\\nhttps://www.wixapis.com/payments/v3/transactions/4f68983f-9b70-438e-8130-4fff0b97cf48/refund \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Authorization: ' \\\n -d '{\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"reason\": \"BUYER_REQUEST\"\n}'","response":"{\n \"transaction\": {\n \"id\": \"4f68983f-9b70-438e-8130-4fff0b97cf48\",\n \"currency\": \"USD\",\n \"capturableAmount\": \"0\",\n \"refundableAmount\": \"0\",\n \"providerTransactionId\": \"pi_1H83lWAaXaGogcA7gt5WsjjP\",\n \"metadata\": {\n \"metadataKey\": \"metadataValue\"\n },\n \"authorization\": {\n \"amount\": \"200\",\n \"status\": \"SUCCEEDED\",\n \"networkReference\": {\n \"networkTransactionId\": \"WvTnyhZlYER07Ate\"\n },\n \"authCode\": \"123456\"\n },\n \"captures\": [{\n \"id\": \"4f68983f-9b70-438e-8130-4fff0b97cf48\",\n \"amount\": \"200\",\n \"status\": \"SUCCEEDED\",\n \"metadata\": {}\n }],\n \"refunds\": [{\n \"id\": \"1dd0bfdc-bf5d-47cb-8d9b-bc2c6d6591d6\",\n \"amount\": \"200\",\n \"reason\": \"BUYER_REQUEST\",\n \"status\": \"SUCCEEDED\",\n \"providerRefundId\": \"re_1H83mOAaXaGogcA7QYx89USb\",\n \"metadata\": {}\n }],\n \"disputes\": [],\n \"voids\": [],\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"paymentMethod\": {\n \"typeId\": \"creditCard\"\n }\n },\n \"refundId\": \"1dd0bfdc-bf5d-47cb-8d9b-bc2c6d6591d6\"\n}"}}],"sourceRepo":"git@github.com:wix-private/cashier.git","contentLink":{"displayName":"Void Or Refund Transaction","slugifiedName":"void-or-refund-transaction"}},{"summary":"Accept Dispute","description":"Accepts a dispute.","operationId":"wix.wixpay.transaction.api.v3.TransactionServiceV3.AcceptDispute","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"transactionId","description":"Transaction ID.","x-wix-docs":{"exposure":"PUBLIC"}},{"in":"path","schema":{"type":"string"},"required":true,"name":"disputeId","description":"Dispute ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.AcceptDisputeResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/transaction-service/v3","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/transaction-service/v3","destinationPath":"/v3","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/payments/v3/transactions","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/payments/v3/transactions","destinationPath":"/v3/transactions","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"AcceptDisputeRequest","description":"","properties":{"accountId":{"title":"accountId","description":"Wix Payments account ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["accountId","transactionId","disputeId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.wixpay.transaction.api.v3.TransactionServiceV3","errors":[],"exposure":"PUBLIC","permissions":["PAYMENTS.DISPUTES_ACCEPT"],"externalPermissionScopes":[{"name":"Manage Disputes","scopeId":"SCOPE.DC-PAYMENTS.MANAGE-DISPUTES"}],"protoArtifactId":"com.wixpress:transactions-proto","serviceArtifactId":"com.wixpress.wixpay.transaction-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.wixpay.transaction.api.v3.AcceptDisputeRequest","responseMessage":"wix.wixpay.transaction.api.v3.AcceptDisputeResponse"},"legacyExamples":[{"name":"AcceptDispute","type":"METHOD","order":1,"content":{"title":"Accept dispute","description":"Accept open dispute","request":"curl --request POST \\\n --url https://www.wixapis.com/payments/v3/transactions/bdba15b3-e931-4877-ae98-ce4f3f37b233/disputes/786f68e5-fa4a-45ef-a2c8-1edfb27dd5a6/accept \\\n --header 'Authorization: ' \\\n --header 'Content-Type: application/json; charset=utf-8' \\\n --data '{\n\t\"account_id\" : \"c94b4b44-4523-4826-a6ce-5fed1cc19d59\"\n}'","response":"{\n \"transaction\": {\n \"id\": \"bdba15b3-e931-4877-ae98-ce4f3f37b233\",\n \"currency\": \"USD\",\n \"capturableAmount\": \"0\",\n \"refundableAmount\": \"0\",\n \"externalOrderId\": \"e46b1600-54fd-4054-b06d-68e818345f7f\",\n \"externalTransactionId\": \"bdba15b3-e931-4877-ae98-ce4f3f37b233\",\n \"providerTransactionId\": \"pi_1Ir0jvJmzcr6KMrHuXthz9pA\",\n \"metadata\": {},\n \"authorization\": {\n \"amount\": \"12000\",\n \"status\": \"SUCCEEDED\",\n \"networkReference\": {\n \"networkTransactionId\": \"6510786985185831\"\n }\n },\n \"captures\": [\n {\n \"id\": \"bdba15b3-e931-4877-ae98-ce4f3f37b233\",\n \"amount\": \"12000\",\n \"status\": \"SUCCEEDED\",\n \"metadata\": {}\n }\n ],\n \"refunds\": [],\n \"disputes\": [\n {\n \"id\": \"786f68e5-fa4a-45ef-a2c8-1edfb27dd5a6\",\n \"amount\": \"12000\",\n \"reason\": \"OTHER\",\n \"status\": \"LOST\",\n \"statusReason\": {\n \"code\": \"Accepted\",\n \"message\": \"Accepted\"\n },\n \"providerDisputeId\": \"dp_1Ir0jxJmzcr6KMrH5thXe0S6\",\n \"chargeback\": {\n \"openingDate\": \"2021-05-14T13:07:41Z\",\n \"evidenceSubmissionDeadlineDate\": \"2021-05-23T23:59:59Z\",\n \"daysToResolution\": 65,\n \"resolutionDate\": \"2021-05-14T13:18:12.911Z\"\n }\n }\n ],\n \"voids\": [],\n \"accountId\": \"c94b4b44-4523-4826-a6ce-5fed1cc19d59\",\n \"accountProfileId\": \"3a647918-9ecf-45a2-ad7f-e8d480471dba\",\n \"paymentMethod\": {\n \"typeId\": \"creditCard\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cashier.git"},"httpMethod":"post","path":"/v3/transactions/{transactionId}/disputes/{disputeId}/accept","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.wixpay.transaction.api.v3.TransactionServiceV3","errors":[],"exposure":"PUBLIC","permissions":["PAYMENTS.DISPUTES_ACCEPT"],"externalPermissionScopes":[{"name":"Manage Disputes","scopeId":"SCOPE.DC-PAYMENTS.MANAGE-DISPUTES"}],"protoArtifactId":"com.wixpress:transactions-proto","serviceArtifactId":"com.wixpress.wixpay.transaction-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.wixpay.transaction.api.v3.AcceptDisputeRequest","responseMessage":"wix.wixpay.transaction.api.v3.AcceptDisputeResponse"},"legacyExamples":[{"name":"AcceptDispute","type":"METHOD","order":1,"content":{"title":"Accept dispute","description":"Accept open dispute","request":"curl --request POST \\\n --url https://www.wixapis.com/payments/v3/transactions/bdba15b3-e931-4877-ae98-ce4f3f37b233/disputes/786f68e5-fa4a-45ef-a2c8-1edfb27dd5a6/accept \\\n --header 'Authorization: ' \\\n --header 'Content-Type: application/json; charset=utf-8' \\\n --data '{\n\t\"account_id\" : \"c94b4b44-4523-4826-a6ce-5fed1cc19d59\"\n}'","response":"{\n \"transaction\": {\n \"id\": \"bdba15b3-e931-4877-ae98-ce4f3f37b233\",\n \"currency\": \"USD\",\n \"capturableAmount\": \"0\",\n \"refundableAmount\": \"0\",\n \"externalOrderId\": \"e46b1600-54fd-4054-b06d-68e818345f7f\",\n \"externalTransactionId\": \"bdba15b3-e931-4877-ae98-ce4f3f37b233\",\n \"providerTransactionId\": \"pi_1Ir0jvJmzcr6KMrHuXthz9pA\",\n \"metadata\": {},\n \"authorization\": {\n \"amount\": \"12000\",\n \"status\": \"SUCCEEDED\",\n \"networkReference\": {\n \"networkTransactionId\": \"6510786985185831\"\n }\n },\n \"captures\": [\n {\n \"id\": \"bdba15b3-e931-4877-ae98-ce4f3f37b233\",\n \"amount\": \"12000\",\n \"status\": \"SUCCEEDED\",\n \"metadata\": {}\n }\n ],\n \"refunds\": [],\n \"disputes\": [\n {\n \"id\": \"786f68e5-fa4a-45ef-a2c8-1edfb27dd5a6\",\n \"amount\": \"12000\",\n \"reason\": \"OTHER\",\n \"status\": \"LOST\",\n \"statusReason\": {\n \"code\": \"Accepted\",\n \"message\": \"Accepted\"\n },\n \"providerDisputeId\": \"dp_1Ir0jxJmzcr6KMrH5thXe0S6\",\n \"chargeback\": {\n \"openingDate\": \"2021-05-14T13:07:41Z\",\n \"evidenceSubmissionDeadlineDate\": \"2021-05-23T23:59:59Z\",\n \"daysToResolution\": 65,\n \"resolutionDate\": \"2021-05-14T13:18:12.911Z\"\n }\n }\n ],\n \"voids\": [],\n \"accountId\": \"c94b4b44-4523-4826-a6ce-5fed1cc19d59\",\n \"accountProfileId\": \"3a647918-9ecf-45a2-ad7f-e8d480471dba\",\n \"paymentMethod\": {\n \"typeId\": \"creditCard\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cashier.git","contentLink":{"displayName":"Accept Dispute","slugifiedName":"accept-dispute"}},{"summary":"Generate Evidence Upload Url","description":"Generates URL to upload evidence for a dispute.","operationId":"wix.wixpay.transaction.api.v3.TransactionServiceV3.GenerateEvidenceUploadUrl","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"transactionId","description":"Transaction ID.","x-wix-docs":{"exposure":"PUBLIC"}},{"in":"path","schema":{"type":"string"},"required":true,"name":"disputeId","description":"Dispute ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.GenerateEvidenceUploadUrlResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/transaction-service/v3","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/transaction-service/v3","destinationPath":"/v3","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/payments/v3/transactions","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/payments/v3/transactions","destinationPath":"/v3/transactions","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"GenerateEvidenceUploadUrlRequest","description":"","properties":{"accountId":{"title":"accountId","description":"Wix Payments account ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["accountId","transactionId","disputeId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.wixpay.transaction.api.v3.TransactionServiceV3","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DISPUTE_EVIDENCE_ARE_NOT_EXPECTED"}],"exposure":"PUBLIC","permissions":["PAYMENTS.DISPUTES_UPLOAD_EVIDENCE"],"externalPermissionScopes":[{"name":"Manage Disputes","scopeId":"SCOPE.DC-PAYMENTS.MANAGE-DISPUTES"}],"protoArtifactId":"com.wixpress:transactions-proto","serviceArtifactId":"com.wixpress.wixpay.transaction-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.wixpay.transaction.api.v3.GenerateEvidenceUploadUrlRequest","responseMessage":"wix.wixpay.transaction.api.v3.GenerateEvidenceUploadUrlResponse"},"legacyExamples":[{"name":"GenerateEvidenceUploadUrl","type":"METHOD","order":1,"content":{"title":"Generate evidence upload url","description":"Generate evidence upload url","request":"curl --request POST \\\n --url https://www.wixapis.com/payments/v3/transactions/bb4188b7-1779-44d6-961d-e3db25a6bea0/disputes/0a6f4f4a-407f-4892-836c-ad968708c679/generate-evidence-upload-url \\\n --header 'Authorization: ' \\\n --header 'Content-Type: application/json; charset=utf-8' \\\n --data '{\n\t\"account_id\" : \"c94b4b44-4523-4826-a6ce-5fed1cc19d59\"\n}'","response":"{\n \"uploadUrl\": \"https://wixmp-90ef227251107558e3a6a71f.appspot.com/_ah/upload/\",\n \"uploadToken\": \"\"\n}"}}],"sourceRepo":"git@github.com:wix-private/cashier.git"},"httpMethod":"post","path":"/v3/transactions/{transactionId}/disputes/{disputeId}/generate-evidence-upload-url","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.wixpay.transaction.api.v3.TransactionServiceV3","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DISPUTE_EVIDENCE_ARE_NOT_EXPECTED"}],"exposure":"PUBLIC","permissions":["PAYMENTS.DISPUTES_UPLOAD_EVIDENCE"],"externalPermissionScopes":[{"name":"Manage Disputes","scopeId":"SCOPE.DC-PAYMENTS.MANAGE-DISPUTES"}],"protoArtifactId":"com.wixpress:transactions-proto","serviceArtifactId":"com.wixpress.wixpay.transaction-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.wixpay.transaction.api.v3.GenerateEvidenceUploadUrlRequest","responseMessage":"wix.wixpay.transaction.api.v3.GenerateEvidenceUploadUrlResponse"},"legacyExamples":[{"name":"GenerateEvidenceUploadUrl","type":"METHOD","order":1,"content":{"title":"Generate evidence upload url","description":"Generate evidence upload url","request":"curl --request POST \\\n --url https://www.wixapis.com/payments/v3/transactions/bb4188b7-1779-44d6-961d-e3db25a6bea0/disputes/0a6f4f4a-407f-4892-836c-ad968708c679/generate-evidence-upload-url \\\n --header 'Authorization: ' \\\n --header 'Content-Type: application/json; charset=utf-8' \\\n --data '{\n\t\"account_id\" : \"c94b4b44-4523-4826-a6ce-5fed1cc19d59\"\n}'","response":"{\n \"uploadUrl\": \"https://wixmp-90ef227251107558e3a6a71f.appspot.com/_ah/upload/\",\n \"uploadToken\": \"\"\n}"}}],"sourceRepo":"git@github.com:wix-private/cashier.git","contentLink":{"displayName":"Generate Evidence Upload Url","slugifiedName":"generate-evidence-upload-url"}},{"summary":"Add Evidence","description":"Adds evidence to a dispute.","operationId":"wix.wixpay.transaction.api.v3.TransactionServiceV3.AddEvidence","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"transactionId","description":"Transaction ID.","x-wix-docs":{"exposure":"PUBLIC"}},{"in":"path","schema":{"type":"string"},"required":true,"name":"disputeId","description":"Dispute ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.AddEvidenceResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/transaction-service/v3","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/transaction-service/v3","destinationPath":"/v3","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/payments/v3/transactions","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/payments/v3/transactions","destinationPath":"/v3/transactions","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"AddEvidenceRequest","description":"","properties":{"accountId":{"title":"accountId","description":"Wix Payments account ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"evidence":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Evidence","summary":"evidence","description":"Evidence to include in the request.","x-wix-docs":{"exposure":"PUBLIC"}},"idempotencyKey":{"title":"idempotencyKey","description":"Use the same unique key when request retry is caused by technical issues like network availability.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["accountId","transactionId","disputeId","evidence","evidence.content"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.wixpay.transaction.api.v3.TransactionServiceV3","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DISPUTE_EVIDENCE_ARE_NOT_EXPECTED"}],"exposure":"PUBLIC","permissions":["PAYMENTS.DISPUTES_ADD_EVIDENCE"],"externalPermissionScopes":[{"name":"Manage Disputes","scopeId":"SCOPE.DC-PAYMENTS.MANAGE-DISPUTES"}],"protoArtifactId":"com.wixpress:transactions-proto","serviceArtifactId":"com.wixpress.wixpay.transaction-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.wixpay.transaction.api.v3.AddEvidenceRequest","responseMessage":"wix.wixpay.transaction.api.v3.AddEvidenceResponse"},"legacyExamples":[{"name":"AddEvidence","type":"METHOD","order":1,"content":{"title":"Add evidence","description":"Add evidence to the dispute","request":"curl --request POST \\\n --url https://www.wixapis.com/payments/v3/transactions/bb4188b7-1779-44d6-961d-e3db25a6bea0/disputes/0a6f4f4a-407f-4892-836c-ad968708c679/add-evidence \\\n --header 'Authorization: ' \\\n --header 'Content-Type: application/json; charset=utf-8' \\\n --data '{\n\t\"account_id\": \"c94b4b44-4523-4826-a6ce-5fed1cc19d59\",\n\t\"evidence\": {\n\t\t\"type\" : \"ACCESS_ACTIVITY_LOG\",\n\t\t\"file_id\" : \"7017b89bdd9b443c8e39fe7ba12cd197\"\n\t}\n}'","response":"{\n \"transaction\": {\n \"id\": \"5678e6b6-a329-46fc-a99c-63dce6caab9d\",\n \"currency\": \"USD\",\n \"capturableAmount\": \"0\",\n \"refundableAmount\": \"0\",\n \"externalOrderId\": \"78e1fa91-f327-4058-8e5e-d358f0a8708f\",\n \"externalTransactionId\": \"5678e6b6-a329-46fc-a99c-63dce6caab9d\",\n \"providerTransactionId\": \"pi_1IsPEeJmzcr6KMrH7WSbjL1o\",\n \"metadata\": {},\n \"authorization\": {\n \"amount\": \"24000\",\n \"status\": \"SUCCEEDED\",\n \"networkReference\": {\n \"networkTransactionId\": \"6510786985185831\"\n }\n },\n \"captures\": [\n {\n \"id\": \"5678e6b6-a329-46fc-a99c-63dce6caab9d\",\n \"amount\": \"24000\",\n \"status\": \"SUCCEEDED\",\n \"metadata\": {}\n }\n ],\n \"refunds\": [],\n \"disputes\": [\n {\n \"id\": \"95c3e26e-d133-4ecf-992e-27bb4f23e6eb\",\n \"amount\": \"24000\",\n \"reason\": \"OTHER\",\n \"status\": \"CHARGEBACK_OPEN\",\n \"providerDisputeId\": \"dp_1IsPEgJmzcr6KMrH6kRxHOH8\",\n \"chargeback\": {\n \"openingDate\": \"2021-05-18T09:29:10Z\",\n \"evidenceSubmissionDeadlineDate\": \"2021-05-27T23:59:59Z\",\n \"daysToResolution\": 65\n }\n }\n ],\n \"voids\": [],\n \"accountId\": \"c94b4b44-4523-4826-a6ce-5fed1cc19d59\",\n \"accountProfileId\": \"3a647918-9ecf-45a2-ad7f-e8d480471dba\",\n \"paymentMethod\": {\n \"typeId\": \"creditCard\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cashier.git"},"httpMethod":"post","path":"/v3/transactions/{transactionId}/disputes/{disputeId}/add-evidence","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.wixpay.transaction.api.v3.TransactionServiceV3","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"DISPUTE_EVIDENCE_ARE_NOT_EXPECTED"}],"exposure":"PUBLIC","permissions":["PAYMENTS.DISPUTES_ADD_EVIDENCE"],"externalPermissionScopes":[{"name":"Manage Disputes","scopeId":"SCOPE.DC-PAYMENTS.MANAGE-DISPUTES"}],"protoArtifactId":"com.wixpress:transactions-proto","serviceArtifactId":"com.wixpress.wixpay.transaction-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.wixpay.transaction.api.v3.AddEvidenceRequest","responseMessage":"wix.wixpay.transaction.api.v3.AddEvidenceResponse"},"legacyExamples":[{"name":"AddEvidence","type":"METHOD","order":1,"content":{"title":"Add evidence","description":"Add evidence to the dispute","request":"curl --request POST \\\n --url https://www.wixapis.com/payments/v3/transactions/bb4188b7-1779-44d6-961d-e3db25a6bea0/disputes/0a6f4f4a-407f-4892-836c-ad968708c679/add-evidence \\\n --header 'Authorization: ' \\\n --header 'Content-Type: application/json; charset=utf-8' \\\n --data '{\n\t\"account_id\": \"c94b4b44-4523-4826-a6ce-5fed1cc19d59\",\n\t\"evidence\": {\n\t\t\"type\" : \"ACCESS_ACTIVITY_LOG\",\n\t\t\"file_id\" : \"7017b89bdd9b443c8e39fe7ba12cd197\"\n\t}\n}'","response":"{\n \"transaction\": {\n \"id\": \"5678e6b6-a329-46fc-a99c-63dce6caab9d\",\n \"currency\": \"USD\",\n \"capturableAmount\": \"0\",\n \"refundableAmount\": \"0\",\n \"externalOrderId\": \"78e1fa91-f327-4058-8e5e-d358f0a8708f\",\n \"externalTransactionId\": \"5678e6b6-a329-46fc-a99c-63dce6caab9d\",\n \"providerTransactionId\": \"pi_1IsPEeJmzcr6KMrH7WSbjL1o\",\n \"metadata\": {},\n \"authorization\": {\n \"amount\": \"24000\",\n \"status\": \"SUCCEEDED\",\n \"networkReference\": {\n \"networkTransactionId\": \"6510786985185831\"\n }\n },\n \"captures\": [\n {\n \"id\": \"5678e6b6-a329-46fc-a99c-63dce6caab9d\",\n \"amount\": \"24000\",\n \"status\": \"SUCCEEDED\",\n \"metadata\": {}\n }\n ],\n \"refunds\": [],\n \"disputes\": [\n {\n \"id\": \"95c3e26e-d133-4ecf-992e-27bb4f23e6eb\",\n \"amount\": \"24000\",\n \"reason\": \"OTHER\",\n \"status\": \"CHARGEBACK_OPEN\",\n \"providerDisputeId\": \"dp_1IsPEgJmzcr6KMrH6kRxHOH8\",\n \"chargeback\": {\n \"openingDate\": \"2021-05-18T09:29:10Z\",\n \"evidenceSubmissionDeadlineDate\": \"2021-05-27T23:59:59Z\",\n \"daysToResolution\": 65\n }\n }\n ],\n \"voids\": [],\n \"accountId\": \"c94b4b44-4523-4826-a6ce-5fed1cc19d59\",\n \"accountProfileId\": \"3a647918-9ecf-45a2-ad7f-e8d480471dba\",\n \"paymentMethod\": {\n \"typeId\": \"creditCard\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cashier.git","contentLink":{"displayName":"Add Evidence","slugifiedName":"add-evidence"}},{"summary":"Submit Evidence","description":"Submits evidence and triggers the review process.","operationId":"wix.wixpay.transaction.api.v3.TransactionServiceV3.SubmitEvidence","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"transactionId","description":"Transaction ID.","x-wix-docs":{"exposure":"PUBLIC"}},{"in":"path","schema":{"type":"string"},"required":true,"name":"disputeId","description":"Dispute ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.SubmitEvidenceResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/transaction-service/v3","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/transaction-service/v3","destinationPath":"/v3","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/payments/v3/transactions","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/payments/v3/transactions","destinationPath":"/v3/transactions","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"SubmitEvidenceRequest","description":"","properties":{"accountId":{"title":"accountId","description":"Wix Payments account ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["accountId","transactionId","disputeId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.wixpay.transaction.api.v3.TransactionServiceV3","errors":[],"exposure":"PUBLIC","permissions":["PAYMENTS.DISPUTES_SUBMIT"],"externalPermissionScopes":[{"name":"Manage Disputes","scopeId":"SCOPE.DC-PAYMENTS.MANAGE-DISPUTES"}],"protoArtifactId":"com.wixpress:transactions-proto","serviceArtifactId":"com.wixpress.wixpay.transaction-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.wixpay.transaction.api.v3.SubmitEvidenceRequest","responseMessage":"wix.wixpay.transaction.api.v3.SubmitEvidenceResponse"},"legacyExamples":[{"name":"SubmitEvidence","type":"METHOD","order":1,"content":{"title":"Submit dispute","description":"Submit dispute","request":"curl --request POST \\\n --url https://www.wixapis.com/payments/v3/transactions/bb4188b7-1779-44d6-961d-e3db25a6bea0/disputes/0a6f4f4a-407f-4892-836c-ad968708c679/submit-evidence \\\n --header 'Authorization: >' \\\n --header 'Content-Type: application/json; charset=utf-8' \\\n --data '{\n\t\"account_id\": \"c94b4b44-4523-4826-a6ce-5fed1cc19d59\"\n}'","response":"{\n \"transaction\": {\n \"id\": \"5678e6b6-a329-46fc-a99c-63dce6caab9d\",\n \"currency\": \"USD\",\n \"capturableAmount\": \"0\",\n \"refundableAmount\": \"0\",\n \"externalOrderId\": \"78e1fa91-f327-4058-8e5e-d358f0a8708f\",\n \"externalTransactionId\": \"5678e6b6-a329-46fc-a99c-63dce6caab9d\",\n \"providerTransactionId\": \"pi_1IsPEeJmzcr6KMrH7WSbjL1o\",\n \"metadata\": {},\n \"authorization\": {\n \"amount\": \"24000\",\n \"status\": \"SUCCEEDED\",\n \"networkReference\": {\n \"networkTransactionId\": \"6510786985185831\"\n }\n },\n \"captures\": [\n {\n \"id\": \"5678e6b6-a329-46fc-a99c-63dce6caab9d\",\n \"amount\": \"24000\",\n \"status\": \"SUCCEEDED\",\n \"metadata\": {}\n }\n ],\n \"refunds\": [],\n \"disputes\": [\n {\n \"id\": \"95c3e26e-d133-4ecf-992e-27bb4f23e6eb\",\n \"amount\": \"24000\",\n \"reason\": \"OTHER\",\n \"status\": \"CHARGEBACK_UNDER_REVIEW\",\n \"providerDisputeId\": \"dp_1IsPEgJmzcr6KMrH6kRxHOH8\",\n \"chargeback\": {\n \"openingDate\": \"2021-05-18T09:29:10Z\",\n \"evidenceSubmissionDeadlineDate\": \"2021-05-27T23:59:59Z\",\n \"daysToResolution\": 65\n }\n }\n ],\n \"voids\": [],\n \"accountId\": \"c94b4b44-4523-4826-a6ce-5fed1cc19d59\",\n \"accountProfileId\": \"3a647918-9ecf-45a2-ad7f-e8d480471dba\",\n \"paymentMethod\": {\n \"typeId\": \"creditCard\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cashier.git"},"httpMethod":"post","path":"/v3/transactions/{transactionId}/disputes/{disputeId}/submit-evidence","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.wixpay.transaction.api.v3.TransactionServiceV3","errors":[],"exposure":"PUBLIC","permissions":["PAYMENTS.DISPUTES_SUBMIT"],"externalPermissionScopes":[{"name":"Manage Disputes","scopeId":"SCOPE.DC-PAYMENTS.MANAGE-DISPUTES"}],"protoArtifactId":"com.wixpress:transactions-proto","serviceArtifactId":"com.wixpress.wixpay.transaction-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.wixpay.transaction.api.v3.SubmitEvidenceRequest","responseMessage":"wix.wixpay.transaction.api.v3.SubmitEvidenceResponse"},"legacyExamples":[{"name":"SubmitEvidence","type":"METHOD","order":1,"content":{"title":"Submit dispute","description":"Submit dispute","request":"curl --request POST \\\n --url https://www.wixapis.com/payments/v3/transactions/bb4188b7-1779-44d6-961d-e3db25a6bea0/disputes/0a6f4f4a-407f-4892-836c-ad968708c679/submit-evidence \\\n --header 'Authorization: >' \\\n --header 'Content-Type: application/json; charset=utf-8' \\\n --data '{\n\t\"account_id\": \"c94b4b44-4523-4826-a6ce-5fed1cc19d59\"\n}'","response":"{\n \"transaction\": {\n \"id\": \"5678e6b6-a329-46fc-a99c-63dce6caab9d\",\n \"currency\": \"USD\",\n \"capturableAmount\": \"0\",\n \"refundableAmount\": \"0\",\n \"externalOrderId\": \"78e1fa91-f327-4058-8e5e-d358f0a8708f\",\n \"externalTransactionId\": \"5678e6b6-a329-46fc-a99c-63dce6caab9d\",\n \"providerTransactionId\": \"pi_1IsPEeJmzcr6KMrH7WSbjL1o\",\n \"metadata\": {},\n \"authorization\": {\n \"amount\": \"24000\",\n \"status\": \"SUCCEEDED\",\n \"networkReference\": {\n \"networkTransactionId\": \"6510786985185831\"\n }\n },\n \"captures\": [\n {\n \"id\": \"5678e6b6-a329-46fc-a99c-63dce6caab9d\",\n \"amount\": \"24000\",\n \"status\": \"SUCCEEDED\",\n \"metadata\": {}\n }\n ],\n \"refunds\": [],\n \"disputes\": [\n {\n \"id\": \"95c3e26e-d133-4ecf-992e-27bb4f23e6eb\",\n \"amount\": \"24000\",\n \"reason\": \"OTHER\",\n \"status\": \"CHARGEBACK_UNDER_REVIEW\",\n \"providerDisputeId\": \"dp_1IsPEgJmzcr6KMrH6kRxHOH8\",\n \"chargeback\": {\n \"openingDate\": \"2021-05-18T09:29:10Z\",\n \"evidenceSubmissionDeadlineDate\": \"2021-05-27T23:59:59Z\",\n \"daysToResolution\": 65\n }\n }\n ],\n \"voids\": [],\n \"accountId\": \"c94b4b44-4523-4826-a6ce-5fed1cc19d59\",\n \"accountProfileId\": \"3a647918-9ecf-45a2-ad7f-e8d480471dba\",\n \"paymentMethod\": {\n \"typeId\": \"creditCard\"\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/cashier.git","contentLink":{"displayName":"Submit Evidence","slugifiedName":"submit-evidence"}}],"webhooks":[{"summary":"Transaction Created","title":"Transaction Created","description":"","permissions":["PAYMENTS.TRANSACTIONS_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.payments.transactions.v3.transaction","serviceName":"wix.wixpay.transaction.api.v3.TransactionServiceV3","domainEvent":"CREATED","legacyExamples":[{"name":"TransactionCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"3c03d17a-4f9d-4686-86b1-7ccafe232e77\",\n \"entityFqdn\": \"wix.payments.transactions.v3.transaction\",\n \"slug\": \"created\",\n \"entityId\": \"43075a59-6a23-4f5f-b4dd-2bb636770458\",\n \"createdEvent\": {\n \"entity\": {\n \"id\": \"43075a59-6a23-4f5f-b4dd-2bb636770458\",\n \"currency\": \"USD\",\n \"capturableAmount\": \"0\",\n \"refundableAmount\": \"0\",\n \"externalTransactionId\": \"d44150d8-1cbe-4ead-9f1d-c9a673698a7f\",\n \"metadata\": {\n \"metadataKey\": \"metadataValue\"\n },\n \"authorization\": {\n \"amount\": \"100\",\n \"status\": \"PENDING\"\n },\n \"captures\": [],\n \"refunds\": [],\n \"disputes\": [],\n \"voids\": [],\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"paymentMethod\": {\n \"typeId\": \"creditCard\"\n }\n }\n },\n \"eventTime\": \"2021-01-02T01:02:03.456789Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/cashier.git","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Transaction","contentLink":{"displayName":"Transaction Created","slugifiedName":"transaction-created"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Transaction Updated","title":"Transaction Updated","description":"","permissions":["PAYMENTS.TRANSACTIONS_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.payments.transactions.v3.transaction","serviceName":"wix.wixpay.transaction.api.v3.TransactionServiceV3","domainEvent":"UPDATED","legacyExamples":[{"name":"TransactionUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"245ff9b5-8a34-43bf-97ab-35337250d7b2\",\n \"entityFqdn\": \"wix.payments.transactions.v3.transaction\",\n \"slug\": \"updated\",\n \"entityId\": \"4f68983f-9b70-438e-8130-4fff0b97cf48\",\n \"updatedEvent\": {\n \"currentEntity\": {\n \"id\": \"4f68983f-9b70-438e-8130-4fff0b97cf48\",\n \"currency\": \"USD\",\n \"capturableAmount\": \"0\",\n \"refundableAmount\": \"0\",\n \"providerTransactionId\": \"pi_1H83lWAaXaGogcA7gt5WsjjP\",\n \"metadata\": {\n \"metadataKey\": \"metadataValue\"\n },\n \"authorization\": {\n \"amount\": \"200\",\n \"status\": \"SUCCEEDED\",\n \"networkReference\": {\n \"networkTransactionId\": \"WvTnyhZlYER07Ate\"\n },\n \"authCode\": \"123456\"\n },\n \"captures\": [\n {\n \"id\": \"4f68983f-9b70-438e-8130-4fff0b97cf48\",\n \"amount\": \"200\",\n \"status\": \"SUCCEEDED\",\n \"metadata\": {}\n }\n ],\n \"refunds\": [\n {\n \"id\": \"1dd0bfdc-bf5d-47cb-8d9b-bc2c6d6591d6\",\n \"amount\": \"200\",\n \"reason\": \"BUYER_REQUEST\",\n \"status\": \"SUCCEEDED\",\n \"providerRefundId\": \"re_1H83mOAaXaGogcA7QYx89USb\",\n \"metadata\": {}\n }\n ],\n \"disputes\": [],\n \"voids\": [],\n \"accountId\": \"6f82b2ce-2a15-4bd7-84b5-392c74b3719c\",\n \"paymentMethod\": {\n \"typeId\": \"creditCard\"\n }\n }\n },\n \"eventTime\": \"2021-02-03T01:02:03.456789Z\",\n \"triggeredByAnonymizeRequest\": false\n}"}],"sourceRepo":"git@github.com:wix-private/cashier.git","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Transaction","contentLink":{"displayName":"Transaction Updated","slugifiedName":"transaction-updated"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"## About the Transactions API\nUse Wix Payments server-to-server API integration to accept different payment methods and manage transactions. Wix Payments act as a standalone solution to independently process payments, deal with chargebacks and disputes via Wix infrastructure, and can be used by any third-party.\n\n### **Wix Payments integration prerequisites**\nBefore testing the Transactions API, you need to get a Wix Payments account ID. Wix also applies a Know Your Customer (KYC) and evaluation procedure. Contact Wix via transactions-api-support@wix.com and provide the following details to start the evaluation process:\n- Put \"Wix Payments integration\" in the subject of the email.\n- Provide your name and email.\n- Include the purpose of your integration with the Transactions API.\n\n**Transactions API supports the following flows:**\n- Authorization (reserving funds)\n- Capture (transferring of reserved funds)\n- One-time transaction (Authorization and Capture)\n- Recurring transactions (MIT and CIT)\n- Refund/Void (canceling an authorized or captured transaction)\n- Dispute\n\n**Wix Payments supports the following payment methods:**\n- Card\n- ACH\n- Apple Pay\n- Boleto\n- Giropay\n- iDEAL\n- PayPal\n- Pix\n- SEPA\n- SOFORT\n\n## Terminology\n- **Merchant**: A party selling goods or services to customers via an eCommerce website, a mobile app, on the point of sale, or across all three channels. Wix Payments enable a merchant to accept payments from customers made with cards or local payment methods and manage payouts.\n- **Customer**: Someone who buys goods or services from a merchant. In terms of Transactions API, a customer makes a cashless online payment by using either cards or local payment methods to pay.\n- **Cardholder**: Customer who uses a card issued by a bank to make cashless online payments to a merchant. \n- **Transaction**: Agreement between a merchant and a customer to exchange goods, services, or financial instruments. The [transaction object](https://dev.wix.com/api/rest/wix-payments/transactions/transaction-object) contains the basic information required to securely process the payment, execute related actions (delivery, analytics, inventory management) and comply with financial regulations.\n- **Merchant Initiated Transaction** (MIT): Payment or a series of payments with fixed or variable amounts that the merchant performs without direct involvement of a customer, such as automatic account top-ups, and installments.\n- **Cardholder Initiated Transaction** (CIT): Payment initiated by the cardholder on their own after the initial successful transaction.\n- **Authorization**: Process of card issuer verifying payment details and reserving funds to capture them later. When the card is verified with the issuer, the funds are reserved for the transaction.\n- **Transaction reference**: Transaction ID of the first transaction for recurring transactions. It should be passed with each subsequent transaction.\n- **Capture**: Transfer of reserved funds from the customer to the merchant. A payment that was already authorized, must be captured to be completed.\n- **Refund** Transfer of funds from the merchant back to the customer - merchant-initated. When the merchant makes a refund, the funds are sent back to the card issuer. If an authorized payment hasn't been captured yet, a refund can't be made, but the merchant can void the payment instead.\n- **Void**: Voiding a transaction will tell the customer’s card issuing bank that the merchant does not intend to collect the transaction corresponding to the original six-digit approval code and, therefore, those held funds are made available to the customer again. Merchant can void a transaction until it is captured.\n- **Dispute**: Refers to the entire process from the moment the customer applies to their issuing bank. Dispute occurs when a cardholder questions the charge with their card issuer and initiates a chargeback. When this happens, the merchant is given the opportunity to respond to the dispute with evidence that shows that the charge is legitimate.\n- **Request for Information (RFI)**: Optional first step in a dispute, initiated when the cardholder does not recognize or disagrees with a charge and requests more information from their bank.\n- **Chargeback**: Second and primary step in a dispute. It includes a reversal of a credit card payment that comes directly from the bank. Chargeback occurs when a cardholder questions a transaction and asks their card-issuing bank to reverse it. \n- **Evidence**: Documentation in response to the dispute (RFI or chargeback steps), appropriate to the reason for the dispute. For example, evidence responding to a dispute with the reason “product not received” can include shipping information and any screenshots of package tracking. Weblogs, email communications, shipment tracking numbers, delivery confirmation, proof of prior refunds, or replacement shipments can all be helpful.\n\n## Recurring transactions\nWix Payments API allows merchants to set up recurring payments. It adds flexibility and full control of the entire business flow. For subsequent transactions, only the `card_number` should be tokenized using the [Create Card Token](https://dev.wix.com/api/rest/wix-payments/card-tokens/create-card-token) endpoint, and the appropriate token passed to the [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction).\n\n>**Note** to achieve the best approve ratio, the correct MIT/CIT flag must be passed as well.\n> To achieve the best approve ratio, pass all possible values received from the card schemes:\n>- __Network_transaction_id__\n>- __ds_transaction_id__ (in case the initial transaction was performed by the 3DS2 regulations)\n\n> [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction) endpoint is fully compatible with the new PSD2 regulations and supports 3DS 2 mechanism.\n\n## Interaction types\n| Interaction Type | Additional Parameters |Comments |\n| ------------- |-------------| -----|\n| ONE_TIME | | Regular one-time transaction|\n| SETUP_COF_ONSESSION | | Initial transaction with the subsequent CIT (setup one-click)\n| SETUP_COF_RECURRING | | Initial transaction with the subsequent MIT transactions according to a defined schedule|\n| SETUP_COF_UNSCHEDULED | | Initial transaction with the subsequent MIT transactions without the defined schedule |\n| COF_ONSESSION | transaction_reference | Subsequent transaction initiated by the customer (perform one-click) |\n| COF_RECURRING |transaction_reference | Recurring transactions initiated by the merchant according to the defined schedule|\n| COF_UNSCHEDULED | transaction_reference| Recurring transactions initiated by the merchant without a schedule|\n\n## Use cases\nCreate and manage transactions with the following flows:\n\n1. Create a one-time payment and simultaneously authorize and capture funds.\n2. Create a one-time payment. Authorize and Capture the funds separately.\n3. Create a first/initial recurring payment and subsequent one when the cardholder is not present - authorization and capture in one step.\n4. Create an initial “on session” (cardholder present) payment and notify Wix of credential storage to execute a subsequent one in the future when the cardholder is present.\n5. Charge a customer and refund funds afterwards.\n\n### 1. Create a one-time payment and simultaneously authorize and capture funds.\n\nTransaction info: $10 USD, one-time credit card transaction, using a card token. A new `card_token` must be generated for each transaction request. \n(A card token must be passed to [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction) when a credit/debit card is the chosen payment method.) \n\nTo create a transaction, call [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction). \n\nParameters to include:\n```\n{\n \"accountId\": \"81c79a2-9bd5-4852-9296-6a24c640f1ef\",\n \"amount\": \"1000\",\n \"currency\": \"USD\",\n \"paymentMethodTypeId\": \"creditCard\",\n \"card\": {\n \"numberToken\": \"41c29a2-9bd5-4552-1296-6a24c6g0f1ef\",\n \"expiryMonth\": 11,\n \"expiryYear\": 2027,\n \"holderName\": \"John Doe\",\n \"securityCodeToken\": \"71c7932-9bd5-48d2-9196-6df4c640f1ef\"\n },\n \"automaticCapture\": {},\n \"oneTimePayment\": {}\n}\n```\n> Note: Pass an empty object for the type of transaction `oneTimePayment`, but not null or missing.\n\n### 2. Create a one-time payment. Authorize and Capture the funds separately.\n\nTransaction info: $10 USD, one-time credit card transaction, using a card token. A new `card_token` must be generated for each transaction request. \n(A card token must be passed to [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction) when a credit/debit card is the chosen payment method.)\n\n1. Call [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction).\n\nParameters to include:\n```\nPOST https://www.wixapis.com/payments/v3/transactions\n\n{\n \"accountId\": \"81c79a2-9bd5-4852-9296-6a24c640f1ef\",\n \"amount\": \"1000\",\n \"currency\": \"USD\",\n \"paymentMethodTypeId\": \"creditCard\",\n \"card\": {\n \"numberToken\": \"41c29a2-9bd5-4552-1296-6a24c6g0f1ef\",\n \"expiryMonth\": 11,\n \"expiryYear\": 2027,\n \"holderName\": \"John Doe\",\n \"securityCodeToken\": \"71c7932-9bd5-48d2-9196-6df4c640f1ef\"\n },\n \"oneTimePayment\": {}\n}\n```\n\n2. Call [Capture Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/capture-transaction). Retrieve the transactionId from the step 1.\n\nParameters to include:\n```\nPOST https://www.wixapis.com/payments/v3/transactions/2ac75a2-91d5-4752-6h96-6aj74640f1ef/capture\n\n{\n \"accountId\": \"81c79a2-9bd5-4852-9296-6a24c640f1ef\"\n}\n```\n\n### 3. Create a first/initial recurring payment and subsequent one when the cardholder is not present - authorization and capture in one step.\n\nTransaction info: $10 USD, one-time credit card transaction, using a card token. A new card_token must be generated for each transaction request. \n(A card token must be passed to [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction) when a credit/debit card is the chosen payment method.) \nWhen creating a recurring transaction (MIT/CIT), you only need to tokenize the `card_number` and pass it in the Create Transaction request together with COF.\n\n1. Call [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction).\n\nParameters to include:\n```\n{\n \"accountId\": \"81c79a2-9bd5-4852-9296-6a24c640f1ef\",\n \"amount\": \"1000\",\n \"currency\": \"USD\",\n \"paymentMethodTypeId\": \"creditCard\",\n \"card\": {\n \"numberToken\": \"41c29a2-9bd5-4552-1296-6a24c6g0f1ef\",\n \"expiryMonth\": 11,\n \"expiryYear\": 2027,\n \"holderName\": \"John Doe\",\n \"securityCodeToken\": \"71c7932-9bd5-48d2-9196-6df4c640f1ef\"\n },\n \"automaticCapture\": {}\n \"setupCofRecurring\": {}\n}\n```\n\n2. Retrieve the `transactionId` of the created transaction from the response from step 1. (In this example, `transactionId` = 01csa932-9bd5-38d2-91d6-6jf5c640f1ef). You’ll need to pass it as the `transactionReference` in all subsequent transactions.\n\n3. When a subsequent payment is due, call [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction) and pass the `transactionId` from step 1 as the `transactionReference`.\n\nParameters to include:\n```\n{\n \"accountId\": \"81c79a2-9bd5-4852-9296-6a24c640f1ef\",\n \"amount\": \"1000\",\n \"currency\": \"USD\",\n \"paymentMethodTypeId\": \"creditCard\",\n \"card\": {\n \"numberToken\": \"41c29a2-9bd5-4552-1296-6a24c6g0f1ef\",\n \"expiryMonth\": 11,\n \"expiryYear\": 2027,\n \"holderName\": \"John Doe\"\n },\n \"automaticCapture\": {},\n \"cofRecurring\": {\n \"transactionReference\": {\n \"transactionId\": \"01csa932-9bd5-38d2-91d6-6jf5c640f1ef\"\n } \n }\n}\n```\n\n### 4. Create an initial “on session” (cardholder present) payment and notify Wix of credential storage to execute a subsequent one in the future when the cardholder is present.\n\nTransaction info: $10 USD, one-time credit card transaction, using a card token. A new card_token must be generated for each transaction request. \n(A card token must be passed to [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction) when a credit/debit card is the chosen payment method.) \nWhen creating a recurring transaction (MIT/CIT), you only need to tokenize the `card_number` and pass it in the Create Transaction request together with COF.\n\n1. Call [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction).\n\nParameters to include:\n```\n{\n \"accountId\": \"81c79a2-9bd5-4852-9296-6a24c640f1ef\",\n \"amount\": \"1000\",\n \"currency\": \"USD\",\n \"paymentMethodTypeId\": \"creditCard\",\n \"card\": {\n \"numberToken\": \"41c29a2-9bd5-4552-1296-6a24c6g0f1ef\",\n \"expiryMonth\": 11,\n \"expiryYear\": 2027,\n \"holderName\": \"John Doe\",\n \"securityCodeToken\": \"71c7932-9bd5-48d2-9196-6df4c640f1ef\"\n },\n \"automaticCapture\": {},\n \"setupCofOnSession\": {}\n}\n```\n\n2. Retrieve the transactionId (in this example, `transactionId` = 01csa932-9bd5-38d2-91d6-6jf5c640f1ef). You’ll need to pass it as the `transactionReference` in all subsequent transactions.\n\n3. Call [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction). \n`transactionReference` is the ID of the transaction in the response from step 1.\n\nParameters to include:\n```\n{\n \"accountId\": \"81c79a2-9bd5-4852-9296-6a24c640f1ef\",\n \"amount\": \"1000\",\n \"currency\": \"USD\",\n \"paymentMethodTypeId\": \"creditCard\",\n \"card\": {\n \"numberToken\": \"41c29a2-9bd5-4552-1296-6a24c6g0f1ef\",\n \"expiryMonth\": 11,\n \"expiryYear\": 2027,\n \"holderName\": \"John Doe\",\n \"securityCodeToken\": \"71c7932-9bd5-48d2-9196-6df4c640f1ef\"\n },\n \"automaticCapture\": {},\n \"cofOnSession\": {\n \"transactionReference\": {\n \"transactionId\": \"01csa932-9bd5-38d2-91d6-6jf5c640f1ef\"\n } \n }\n}\n```\n\n### 5. Charge a customer and refund funds afterward.\n\nTransaction info: $50 USD, one-time credit card transaction, using a card token.\n\n1. Call [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction).\n\nParameters to include:\n```\n{\n \"accountId\": \"81c79a2-9bd5-4852-9296-6a24c640f1ef\",\n \"amount\": \"5000\",\n \"currency\": \"USD\",\n \"paymentMethodTypeId\": \"creditCard\",\n \"card\": {\n \"numberToken\": \"41c29a2-9bd5-4552-1296-6a24c6g0f1ef\",\n \"expiryMonth\": 11,\n \"expiryYear\": 2027,\n \"holderName\": \"John Doe\",\n \"securityCodeToken\": \"71c7932-9bd5-48d2-9196-6df4c640f1ef\"\n },\n \"automaticCapture\": {},\n \"oneTimePayment\": {}\n}\n```\n\n2. Call [VoidOrRefund Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/void-or-refund-transaction).\n\na. For a full refund:\n```\nPOST https://www.wixapis.com/payments/v3/transactions/71c7932-9bd5-48d2-9196-6df4c640f1ef/capture\n\n{\n \"accountId\": \"81c79a2-9bd5-4852-9296-6a24c640f1ef\"\n}\n```\n\nb. For a partial refund of $25:\n```\nPOST https://www.wixapis.com/payments/v3/transactions/71c7932-9bd5-48d2-9196-6df4c640f1ef/capture\n\n{\n \"accountId\": \"81c79a2-9bd5-4852-9296-6a24c640f1ef\",\n \"amount\": 2500\n}\n```\n","sourceRepo":"git@github.com:wix-private/cashier.git","path":"docs/intro.md"},{"displayName":"Disputes Overview","slugifyName":"disputes-overview","content":"## Disputes Overview \n\n**The dispute process involves the following parties**:\n1. **Cardholder**: The owner of the card involved in a transaction.\n2. **Merchant**: The party who sold the goods or services that are under dispute.\n3. **Card Issuer**: The bank that issued the card to the cardholder.\n4. **Acquirer**: The bank tasked with acquiring payment on the merchant's behalf.\n5. **Card Association**: The card brands (Visa, Mastercard, and others) oversee the process.\n\n![Dispute lifecycle](new_dispute_lifecycle.png \"Dispute lifecycle\")\n\n### RFI\nA dispute can be created upon receiving an RFI (Request For Information), which is a preliminary step before a chargeback (no movement of funds).\n\nIt starts with *Open* status - *RFI_OPEN*. In response, the merchant can either refund the payment or upload evidence with clarifications about the purchase. \n\nIf the merchant refunds the payment, the status will be updated to *Refunded*, and the dispute will not be escalated into a chargeback.\n\nIf the merchant provided evidence, the status will be updated to *RFI_UNDER_REVIEW*. \n\nIf the evidence provided proves sufficient, depending on the Card Scheme rules, the status will be updated to *RFI_CLOSED*, which means the RFI has timed out and did not escalate into a chargeback.\n\n### Chargeback\nIn some cases, a chargeback will follow an RFI if it wasn’t resolved at the RFI stage. However, in most cases the dispute is created as a Chargeback right away with the status CHARGEBACK_OPEN, and skips the optional RFI stage. At this point, the funds are deducted from the merchant’s account, and the merchant can’t refund the money on their own.\n\nMerchants have a timeframe of 14-40 days (the time frame is being detected by the card scheme) to submit evidence against the chargeback. If no actions are taken within this timeframe, the chargeback status is updated to *LOST*.\n\nUploading evidence changes the dispute status to *CHARGEBACK_UNDER_REVIEW*. The evidence will be reviewed by the card schemes. The timeframe varies depending on the card scheme, up to 80 days in some cases.\n\nOnce the review is complete, the chargeback status will be updated to **WON** or **LOST**, as decided by the card issuer.\n\n**Dispute statuses**:\n- RFI_OPEN - expecting evidence from the client\n- RFI_UNDER_REVIEW\n- RFI_CLOSED - final status\n- CHARGEBACK_OPEN - expecting evidence from the client\n- CHARGEBACK_UNDER_REVIEW\n- WON - final status\n- LOST - final status\n\n### Responding to disputes using the API\n**Step 1: Find out when a dispute is opened**\n\nRegister the [Transaction Updated Webhook](https://dev.wix.com/api/rest/wix-payments/transactions/transaction-updated-webhook) to receive a transaction object with all the disputes statuses. All the transaction's disputes and their current status will be returned under `updatedEvent` > `currentEntity` > `disputes`.\n\n**Step 2: Decide how to deal with the dispute (accept or submit evidence).**\n\nTo accept the dispute, skip to step 4. To submit evidence, go to step 3.\n\n**Step 3: Respond to the dispute with evidence**\n\nTo respond to the RFI/chargeback, you should upload evidence, associate it with the correct dispute and submit the evidence to the issuing bank.\n\nTo upload evidence:\n\n1. Call [Generate Evidence Upload Url](https://dev.wix.com/api/rest/wix-payments/transactions/generate-evidence-upload-url). \n2. Retrieve the `upload_url` and `upload_token`.\n3. Call the retrieved `upload_url` as an HTTP POST, and pass the `upload_token` as a path parameter.\n\nFor example:\n```\ncurl --location --request POST 'https://wixmp-90ef227251107558e3a6a71f.appspot.com/_ah/upload/test_upload_token_url/' \\\n--form 'upload_token=\"test_upload_token\"' \\\n--form '=@\"/example.pdf\"'\n```\n\n![Evidence Upload](evidence_upload.png \"Evidence Upload\")\n\n\n4. Retrieve the `payload.id` from the JSON response. \nFor example:\n\n```\n{\n \"message\": \"OK\",\n \"code\": 0,\n \"payload\": {\n \"mimeType\": \"image/jpeg\",\n \"hash\": \"5d61d4349e8380b3eaa97e767391dfd9\",\n \"dateCreated\": \"2020-09-04T13:54:12Z\",\n \"id\": \"2411686768ca469dabd7cc64e52c502e\",\n \"path\": \"/tenants/a001a0c3-0ffa-4b76-8a13-aa0df0d7913c/accounts/0f226e8a-3b1f-44de-8f3f-9a4abdab5db3/transactions/a036c\n \"lifecycle\": null,\n \"size\": 3733,\n \"urn\": \"urn:file:2411686768ca469dabd7cc64e52c502e\",\n \"bucket\": null,\n \"acl\": \"private\",\n \"dateUpdated\": \"2020-09-04T13:54:12Z\",\n \"type\": \"-\"\n }\n}\n```\n\n`payload.id` should be passed as `evidence.fileId` below. (in this example, payload.id = \"2411686768ca469dabd7cc64e52c502e\")\n\n> **Important:** The evidence still needs to be associated with the relevant dispute after upload.\n\n5. Call [Add Evidence](https://dev.wix.com/api/rest/wix-payments/transactions/add-evidence) to associate the evidence you uploaded with the relevant dispute. Pass the `disputeId`, `transactionId`, and `accountId` retrieved in step 1, and map the `payload.id` retrieved above to `evidence.fileId`.\n6. When all the evidence has been uploaded and associated with the dispute, call [Submit Evidence](https://dev.wix.com/api/rest/wix-payments/transactions/submit-evidence) to trigger the submission of the evidence to the issuing bank.\n\n**Step 4: Responding to a chargeback by accepting the dispute.**\n\nAccept the dispute by calling [Accept Dispute](https://dev.wix.com/api/rest/wix-payments/transactions/accept-dispute) - relevant only when the dispute status is *CHARGEBACK_OPEN*. This action moves the dispute status to *LOST*.\n\n","sourceRepo":"git@github.com:wix-private/cashier.git","path":"docs/disputes.md"}],"components":{"schemas":{"wix.wixpay.transaction.api.v3.Transaction":{"type":"object","properties":{"id":{"title":"id","description":"Wix Payments transaction ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"currency":{"title":"currency","description":"Payment currency according to ISO 4217. For example: USD, EUR, GBP.","format":"CURRENCY","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"capturableAmount":{"title":"capturableAmount","description":"Amount that can be captured or voided in minor units.\nUsually matches authorization amount when the transaction has been authorized but not captured.","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"refundableAmount":{"title":"refundableAmount","description":"Amount that can be refunded in minor units.\nUsually matches capture amount when the transaction has been captured but not refunded or charged back.","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"externalInvoiceId":{"title":"externalInvoiceId","description":"Invoice ID provided by the external entity that initiated the transaction.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"externalOrderId":{"title":"externalOrderId","description":"Order ID provided by the external entity that initiated the transaction.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"externalTransactionId":{"title":"externalTransactionId","description":"Transaction ID provided by external entity.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"providerTransactionId":{"title":"providerTransactionId","description":"Transaction ID provided by the payment provider.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"metadata":{"title":"metadata","description":"Metadata stored when the transaction is created.","maxItems":16,"type":"object","format":"map","properties":{"key:value":{"type":"string","description":"\"key\" of type string, \"value\" of type string","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}},"authorization":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Authorization","summary":"authorization","description":"Transaction authorization information.","x-wix-docs":{"exposure":"PUBLIC"}},"captures":{"title":"captures","description":"Captures issued for the transaction.","maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Capture"},"x-wix-docs":{"exposure":"PUBLIC"}},"refunds":{"title":"refunds","description":"Refunds issued for the transaction.","maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Refund"},"x-wix-docs":{"exposure":"PUBLIC"}},"disputes":{"title":"disputes","description":"Disputes initiated for the transaction.","maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Dispute"},"x-wix-docs":{"exposure":"PUBLIC"}},"voids":{"title":"voids","description":"Voids issued for the transaction.","maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Void"},"x-wix-docs":{"exposure":"PUBLIC"}},"accountId":{"title":"accountId","description":"Wix Payments account ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"accountProfileId":{"title":"accountProfileId","description":"Wix Payments account profile ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"paymentMethod":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.PaymentMethod","summary":"paymentMethod","description":"Payment method used for payment.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Transaction","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StringValue","description":""},"wix.wixpay.transaction.api.v3.Authorization":{"type":"object","properties":{"amount":{"title":"amount","description":"Authorization amount in minor units, for example, cents.","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"status":{"title":"status","description":"Authorization status.","type":"string","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Authorization.AuthorizationStatus","x-wix-docs":{"exposure":"PUBLIC"}},"statusReason":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.StatusReason","summary":"statusReason","description":"Detailed reason for current authorization status when available. Value is empty for approved transactions.","x-wix-docs":{"exposure":"PUBLIC"}},"networkReference":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.NetworkReference","summary":"networkReference","description":"Transaction reference provided by a payment network.","x-wix-docs":{"exposure":"PUBLIC"}},"authCode":{"title":"authCode","description":"Authorization code sent by a card issuer.","minLength":2,"maxLength":6,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Authorization","description":"Authorization flow.","oneOf":[{"description":"","summary":"nextAction","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Authorization.nextAction"}]},"wix.wixpay.transaction.api.v3.Authorization.nextAction":{"type":"object","title":"nextAction","properties":{"getMethodRedirect":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.GetMethodRedirect","summary":"getMethodRedirect","description":"Next action: browser should issue an HTTP GET request and render the result.","x-wix-docs":{"exposure":"PUBLIC"}},"postMethodRedirect":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.PostMethodRedirect","summary":"postMethodRedirect","description":"Next action: browser should issue an HTTP POST request and render the result.","x-wix-docs":{"exposure":"PUBLIC"}},"barcodeDisplay":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.BarcodeDisplay","summary":"barcodeDisplay","description":"Next action: browser should show a barcode or a url to a barcode to continue payment.","x-wix-docs":{"exposure":"PUBLIC"}},"qrCodeDisplay":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.QrCodeDisplay","summary":"qrCodeDisplay","description":"Next action: browser should show a QR code to continue payment.","x-wix-docs":{"exposure":"PUBLIC"}}}},"wix.wixpay.transaction.api.v3.Authorization.AuthorizationStatus":{"type":"string","description":"","title":"AuthorizationStatus","enum":["UNDEFINED","PROCESSING","DECLINED","SUCCEEDED","CANCELED","NEEDS_ACTION","PENDING"]},"wix.wixpay.transaction.api.v3.StatusReason":{"type":"object","properties":{"code":{"title":"code","description":"Reason code.","minLength":1,"maxLength":10,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"message":{"title":"message","description":"Free-text description.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"providerResponse":{"title":"providerResponse","description":"Original response code from the issuer or card scheme.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StatusReason","description":""},"wix.wixpay.transaction.api.v3.NetworkReference":{"type":"object","properties":{"networkTransactionId":{"title":"networkTransactionId","description":"Transaction ID assigned by a card scheme (Trace ID for Mastercard or Transaction ID for Visa).","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"dsTransactionId":{"title":"dsTransactionId","description":"Transaction ID assigned by 3D Secure 2 directory server.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"NetworkReference","description":""},"wix.wixpay.transaction.api.v3.GetMethodRedirect":{"type":"object","properties":{"url":{"title":"url","description":"Encoded URL to perform an HTTP GET request.","format":"URI","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetMethodRedirect","description":""},"wix.wixpay.transaction.api.v3.PostMethodRedirect":{"type":"object","properties":{"url":{"title":"url","description":"Encoded URL to perform an HTTP POST request.","format":"URI","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fields":{"title":"fields","description":"Non-encoded form fields to send with the POST request using the application/x-www-form-urlencoded content type.","type":"array","items":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.PostMethodRedirect.FormField"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PostMethodRedirect","description":""},"wix.wixpay.transaction.api.v3.PostMethodRedirect.FormField":{"type":"object","properties":{"name":{"title":"name","description":"Field name (not encoded).","minLength":1,"maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"value":{"title":"value","description":"Field value (not encoded).","maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FormField","description":""},"wix.wixpay.transaction.api.v3.BarcodeDisplay":{"type":"object","properties":{"barcode":{"title":"barcode","description":"Barcode.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"barcodeUrl":{"title":"barcodeUrl","description":"Barcode URL.","format":"URI","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"expirationDate":{"title":"expirationDate","description":"Expiration timestamp.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BarcodeDisplay","description":"Barcode additional data."},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"title":"seconds","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"nanos":{"title":"nanos","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Timestamp","description":""},"wix.wixpay.transaction.api.v3.QrCodeDisplay":{"type":"object","properties":{"payload":{"title":"payload","description":"QR code raw text payload.\nYou can use any QR code generator library to convert it to an image.\nTo see more details read [this article](https://www.thonky.com/qr-code-tutorial/introduction).","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"expirationDate":{"title":"expirationDate","description":"Expiration timestamp.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QrCodeDisplay","description":"QR code data."},"wix.wixpay.transaction.api.v3.Capture":{"type":"object","properties":{"id":{"title":"id","description":"Capture ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"amount":{"title":"amount","description":"Capture amount in minor units, for example, cents.","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"status":{"title":"status","description":"Capture status.","type":"string","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Capture.CaptureStatus","x-wix-docs":{"exposure":"PUBLIC"}},"statusReason":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.StatusReason","summary":"statusReason","description":"Detailed reason for current capture status. Value is empty for approved transactions.","x-wix-docs":{"exposure":"PUBLIC"}},"externalCaptureId":{"title":"externalCaptureId","description":"Capture ID provided by the external entity that initiated the capture.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"providerCaptureId":{"title":"providerCaptureId","description":"Capture ID provided by the payment provider that initiated the capture.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"metadata":{"title":"metadata","description":"Metadata stored when the capture was created.","maxItems":16,"type":"object","format":"map","properties":{"key:value":{"type":"string","description":"\"key\" of type string, \"value\" of type string","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Capture","description":"Capture flow."},"wix.wixpay.transaction.api.v3.Capture.CaptureStatus":{"type":"string","description":"","title":"CaptureStatus","enum":["UNDEFINED","PENDING","FAILED","SUCCEEDED","REVERSED"]},"wix.wixpay.transaction.api.v3.Refund":{"type":"object","properties":{"id":{"title":"id","description":"Refund ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"amount":{"title":"amount","description":"Refund amount in minor units, e.g. cents.","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"reason":{"title":"reason","description":"Reason for refund.","type":"string","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.TransactionModificationReason","x-wix-docs":{"exposure":"PUBLIC"}},"status":{"title":"status","description":"Refund status.","type":"string","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Refund.RefundStatus","x-wix-docs":{"exposure":"PUBLIC"}},"statusReason":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.StatusReason","summary":"statusReason","description":"Detailed reason for current refund status. Value is empty for approved transactions.","x-wix-docs":{"exposure":"PUBLIC"}},"externalRefundId":{"title":"externalRefundId","description":"Refund ID provided by the external entity that initiated the refund.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"providerRefundId":{"title":"providerRefundId","description":"Refund ID provided by the payment provider that initiated the refund.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"metadata":{"title":"metadata","description":"Metadata stored when the refund was created.","maxItems":16,"type":"object","format":"map","properties":{"key:value":{"type":"string","description":"\"key\" of type string, \"value\" of type string","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Refund","description":"Refund flow."},"wix.wixpay.transaction.api.v3.TransactionModificationReason":{"type":"string","description":"","title":"TransactionModificationReason","enum":["OTHER","FRAUD","COMPLIANCE","DUPLICATE_PAYMENT","ABANDONED_PAYMENT","MERCHANT_REQUEST","BUYER_REQUEST"]},"wix.wixpay.transaction.api.v3.Refund.RefundStatus":{"type":"string","description":"","title":"RefundStatus","enum":["UNDEFINED","PENDING","FAILED","SUCCEEDED","REVERSED","CANCELED"]},"wix.wixpay.transaction.api.v3.Dispute":{"type":"object","properties":{"id":{"title":"id","description":"Dispute ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"amount":{"title":"amount","description":"Dispute amount in minor units, for example, cents.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"reason":{"title":"reason","description":"Reason for dispute.","type":"string","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Dispute.DisputeReason","x-wix-docs":{"exposure":"PUBLIC"}},"status":{"title":"status","description":"Dispute status.","type":"string","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Dispute.DisputeStatus","x-wix-docs":{"exposure":"PUBLIC"}},"statusReason":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.StatusReason","summary":"statusReason","description":"Detailed reason for current refund status.","x-wix-docs":{"exposure":"PUBLIC"}},"providerDisputeId":{"title":"providerDisputeId","description":"Dispute ID provided by the payment provider that initiated the dispute.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"rfi":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.RfiTiming","summary":"rfi","description":"Date/time frames for RFI (request for information) flow.","x-wix-docs":{"exposure":"PUBLIC"}},"chargeback":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.ChargebackTiming","summary":"chargeback","description":"Date/time frames for chargeback flow.","x-wix-docs":{"exposure":"PUBLIC"}},"preArbitration":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.PreArbitrationTiming","summary":"preArbitration","description":"Date/time frames for pre-arbitration flow.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Dispute","description":"Dispute flow."},"wix.wixpay.transaction.api.v3.Dispute.DisputeReason":{"type":"string","description":"","title":"DisputeReason","enum":["OTHER","FRAUD_CARD_PRESENT","FRAUD_CARD_ABSENT","DUPLICATE_PROCESSING","SERVICES_NOT_PROVIDED","CANCELED_RECURRING","NOT_AS_DESCRIBED","COUNTERFEIT","MISREPRESENTATION","CANCELED"]},"wix.wixpay.transaction.api.v3.Dispute.DisputeStatus":{"type":"string","description":"","title":"DisputeStatus","enum":["UNDEFINED","RFI_OPEN","RFI_UNDER_REVIEW","RFI_CLOSED","CHARGEBACK_OPEN","CHARGEBACK_UNDER_REVIEW","WON","LOST","PRE_ARBITRATION_UNDER_REVIEW","PRE_ARBITRATION_WON","PRE_ARBITRATION_LOST"]},"wix.wixpay.transaction.api.v3.RfiTiming":{"type":"object","properties":{"openingDate":{"title":"openingDate","description":"RFI (request for information) received date.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"evidenceSubmissionDeadlineDate":{"title":"evidenceSubmissionDeadlineDate","description":"Evidence submission deadline.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"daysToResolution":{"title":"daysToResolution","description":"Number of days between evidence submission and final decision for a dispute.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"evidenceSubmissionDate":{"title":"evidenceSubmissionDate","description":"Date for evidence submission.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"resolutionDate":{"title":"resolutionDate","description":"Date that RFI resolution occurred (final dispute status).","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"RfiTiming","description":""},"wix.wixpay.transaction.api.v3.ChargebackTiming":{"type":"object","properties":{"openingDate":{"title":"openingDate","description":"Chargeback received date.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"evidenceSubmissionDeadlineDate":{"title":"evidenceSubmissionDeadlineDate","description":"Evidence submission deadline.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"daysToResolution":{"title":"daysToResolution","description":"Number of days between evidence submission and final decision for a dispute.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"evidenceSubmissionDate":{"title":"evidenceSubmissionDate","description":"Date for evidence submission.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"resolutionDate":{"title":"resolutionDate","description":"Date a dispute was lost (accepted, expired, etc.) or date of dispute final resolution.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ChargebackTiming","description":""},"wix.wixpay.transaction.api.v3.PreArbitrationTiming":{"type":"object","properties":{"openingDate":{"title":"openingDate","description":"Pre arbitration (request for information) received date.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"resolutionDate":{"title":"resolutionDate","description":"Date that Pre arbitration resolution occurred (final dispute status).","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PreArbitrationTiming","description":""},"wix.wixpay.transaction.api.v3.Void":{"type":"object","properties":{"id":{"title":"id","description":"Void ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"reason":{"title":"reason","description":"Void reason.","type":"string","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.TransactionModificationReason","x-wix-docs":{"exposure":"PUBLIC"}},"status":{"title":"status","description":"Void status.","type":"string","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Void.VoidStatus","x-wix-docs":{"exposure":"PUBLIC"}},"statusReason":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.StatusReason","summary":"statusReason","description":"Detailed reason for current void status.","x-wix-docs":{"exposure":"PUBLIC"}},"externalVoidId":{"title":"externalVoidId","description":"Void ID provided by the external entity.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"providerVoidId":{"title":"providerVoidId","description":"Void ID provided by the payment provider.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"metadata":{"title":"metadata","description":"Metadata stored when the void was initiated.","maxItems":16,"type":"object","format":"map","properties":{"key:value":{"type":"string","description":"\"key\" of type string, \"value\" of type string","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Void","description":"Void flow."},"wix.wixpay.transaction.api.v3.Void.VoidStatus":{"type":"string","description":"","title":"VoidStatus","enum":["UNDEFINED","PENDING","FAILED","SUCCEEDED"]},"wix.wixpay.transaction.api.v3.PaymentMethod":{"type":"object","properties":{"type":{"title":"type","description":"Do not use this field.","type":"string","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"message":"Do not use this field."}}},"typeId":{"title":"typeId","description":"Type ID of payment method used.\nSupported values are `creditCard`, `cardReader`, `ach`, `applePay`, `boleto`, `giropay`, `iDeal`, `payPal`, `pix`, `sepa`, `sofort`, 'tapToPay'","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"displayName":{"title":"displayName","description":"Payment method display name.\nCan be masked card number or IBAN, wallet owner email address, etc.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PaymentMethod","description":"","oneOf":[{"description":"","summary":"info","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.PaymentMethod.info"}]},"wix.wixpay.transaction.api.v3.PaymentMethod.info":{"type":"object","title":"info","properties":{"card":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.CardPaymentInfo","summary":"card","description":"Credit card payment data.","x-wix-docs":{"exposure":"PUBLIC"}},"sofort":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.SofortPaymentInfo","summary":"sofort","description":"SOFORT bank transfer payment data.","x-wix-docs":{"exposure":"PUBLIC"}},"payPal":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.PayPalPaymentInfo","summary":"payPal","description":"PayPal account used for payment.","x-wix-docs":{"exposure":"PUBLIC"}},"cardReader":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.CardReaderInfo","summary":"cardReader","description":"Card Reader payment method.","x-wix-docs":{"exposure":"PUBLIC"}},"tapToPay":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.TapToPayInfo","summary":"tapToPay","description":"Tap to pay payment method.","x-wix-docs":{"exposure":"PUBLIC"}}}},"wix.wixpay.transaction.api.v3.CardPaymentInfo":{"type":"object","properties":{"bin":{"title":"bin","description":"Credit card's BIN (Bank Identification Number).","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"lastDigits":{"title":"lastDigits","description":"The last 4 digits of the card number.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"expiryMonth":{"title":"expiryMonth","description":"Card expiration month.","minimum":1,"maximum":12,"$ref":"#/components/schemas/google.protobuf.UInt32Value","x-wix-docs":{"exposure":"PUBLIC"}},"expiryYear":{"title":"expiryYear","description":"Card expiration year (4 digits, for example, 2022, 2025).","minimum":2000,"maximum":2099,"$ref":"#/components/schemas/google.protobuf.UInt32Value","x-wix-docs":{"exposure":"PUBLIC"}},"holderName":{"title":"holderName","description":"Cardholder name printed on the card.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"brandId":{"title":"brandId","description":"Card issuer's brand.\nSupported values are `MasterCard`, `Visa`, `Electron`, `Amex`, `Diners`, `Discover`, `Jcb`, `ChinaUnionPay`, `Maestro`, `CartesBancaires`.","minLength":1,"maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CardPaymentInfo","description":""},"google.protobuf.UInt32Value":{"type":"object","properties":{"value":{"title":"value","description":"","type":"number","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UInt32Value","description":""},"wix.wixpay.transaction.api.v3.SofortPaymentInfo":{"type":"object","properties":{"bankAccountOwnerName":{"title":"bankAccountOwnerName","description":"Name of the bank account owner.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"iban":{"title":"iban","description":"International bank account number.","minLength":1,"maxLength":34,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"ibanLastDigits":{"title":"ibanLastDigits","description":"International bank account number last 4 digits for display.","minLength":4,"maxLength":4,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SofortPaymentInfo","description":"SOFORT bank transfer payment data."},"wix.wixpay.transaction.api.v3.PayPalPaymentInfo":{"type":"object","properties":{"payerId":{"title":"payerId","description":"PayPal-assigned payer ID.","minLength":13,"maxLength":13,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"email":{"title":"email","description":"Payer email address.","minLength":1,"maxLength":254,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PayPalPaymentInfo","description":"PayPal account used for payment."},"wix.wixpay.transaction.api.v3.CardReaderInfo":{"type":"object","properties":{"readerToken":{"title":"readerToken","description":"Card reader token.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"network":{"title":"network","description":"Card reader network","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"lastDigits":{"title":"lastDigits","description":"The last 4 digits of the card number.","minLength":1,"maxLength":20,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"expiryMonth":{"title":"expiryMonth","description":"Card expiration month.","minimum":1,"maximum":12,"$ref":"#/components/schemas/google.protobuf.UInt32Value","x-wix-docs":{"exposure":"PUBLIC"}},"expiryYear":{"title":"expiryYear","description":"Card expiration year (4 digits, for example, 2022, 2025).","minimum":2000,"maximum":2099,"$ref":"#/components/schemas/google.protobuf.UInt32Value","x-wix-docs":{"exposure":"PUBLIC"}},"holderName":{"title":"holderName","description":"Cardholder name printed on the card.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"brandId":{"title":"brandId","description":"Card issuer's brand.\nSupported values are `MasterCard`, `Visa`, `Electron`, `Amex`, `Diners`, `Discover`, `Jcb`, `ChinaUnionPay`, `Maestro`, `CartesBancaires`.","minLength":1,"maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"receipt":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.CardReaderReceipt","summary":"receipt","description":"Card reader receipt","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CardReaderInfo","description":"Card Reader payment method info."},"wix.wixpay.transaction.api.v3.CardReaderReceipt":{"type":"object","properties":{"applicationCryptogram":{"title":"applicationCryptogram","description":"cryptogram generated by the integrated circuit chip.","minLength":1,"maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"applicationPreferredName":{"title":"applicationPreferredName","description":"Mnenomic of the Application Identifier.","minLength":1,"maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"authorizationCode":{"title":"authorizationCode","description":"Identifier for this transaction.","minLength":1,"maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"dedicatedFileName":{"title":"dedicatedFileName","description":"Similar to the application identifier stored on the integrated circuit chip.","minLength":1,"maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CardReaderReceipt","description":"Additinal information about card reader transaction"},"wix.wixpay.transaction.api.v3.TapToPayInfo":{"type":"object","properties":{"readerToken":{"title":"readerToken","description":"Tap to pay reader token.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"network":{"title":"network","description":"Tap to pay payment card network","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"TapToPayInfo","description":"Tap to pay payment method info."},"wix.wixpay.transaction.api.v3.AuthorizationChanged":{"type":"object","properties":{"transaction":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Transaction","summary":"transaction","description":"","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AuthorizationChanged","description":""},"wix.wixpay.transaction.api.v3.CaptureChanged":{"type":"object","properties":{"transaction":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Transaction","summary":"transaction","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"captureId":{"title":"captureId","description":"","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CaptureChanged","description":""},"wix.wixpay.transaction.api.v3.RefundChanged":{"type":"object","properties":{"transaction":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Transaction","summary":"transaction","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"refundId":{"title":"refundId","description":"","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"RefundChanged","description":""},"wix.wixpay.transaction.api.v3.DisputeChanged":{"type":"object","properties":{"transaction":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Transaction","summary":"transaction","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"disputeId":{"title":"disputeId","description":"","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DisputeChanged","description":""},"wix.wixpay.transaction.api.v3.VoidChanged":{"type":"object","properties":{"transaction":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Transaction","summary":"transaction","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"voidId":{"title":"voidId","description":"","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"VoidChanged","description":""},"wix.wixpay.transaction.api.v3.CreateTransactionRequest":{"type":"object","properties":{"accountId":{"title":"accountId","description":"Wix Payments account ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"paymentMethodType":{"title":"paymentMethodType","description":"Do not use this field.","type":"string","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"message":"Do not use this field."}}},"paymentMethodTypeId":{"title":"paymentMethodTypeId","description":"Type ID of payment method to use.\nSupported values are `creditCard`, `cardReader`, `ach`, `applePay`, `googlePay`, `boleto`, `giropay`, `iDeal`, `payPal`, `pix`, `sepa`, `sofort`.\nPass specific data for each payment method type using a corresponding parameter.\nFor example, pass the parameter `card` when passing `creditCard` for this field.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"amount":{"title":"amount","description":"Payment amount in minor units, for example, cents.","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"currency":{"title":"currency","description":"Payment currency according to ISO 4217. For example: USD, EUR, GBP.","format":"CURRENCY","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"idempotencyKey":{"title":"idempotencyKey","description":"Key to ensure idempotency.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"externalTransactionId":{"title":"externalTransactionId","description":"Corresponding transaction ID within the external entity that initiated the transaction.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"externalInvoiceId":{"title":"externalInvoiceId","description":"Corresponding invoice ID within the external entity that made the request.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"externalOrderId":{"title":"externalOrderId","description":"Order ID provided by the external entity that initiated the request.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"externalBuyerId":{"title":"externalBuyerId","description":"Customer ID provided by the external entity that initiated the request.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"automaticCapture":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.AutomaticCapture","summary":"automaticCapture","description":"Whether to capture this transaction automatically. When not passed, the transaction can be manually captured later.","x-wix-docs":{"exposure":"PUBLIC"}},"returnUrl":{"title":"returnUrl","description":"URL to return to after redirection to the payment approval page.","format":"URI","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"installmentCount":{"title":"installmentCount","description":"Number of installments (must be greater than 1 to trigger payment in installments).","minimum":2,"maximum":1000,"$ref":"#/components/schemas/google.protobuf.UInt32Value","x-wix-docs":{"exposure":"PUBLIC"}},"items":{"title":"items","description":"Order line items.","maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Item"},"x-wix-docs":{"exposure":"PUBLIC"}},"billingAddress":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.AddressDetails","summary":"billingAddress","description":"Billing address.","x-wix-docs":{"exposure":"PUBLIC"}},"shippingAddress":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.AddressDetails","summary":"shippingAddress","description":"Shipping address.","x-wix-docs":{"exposure":"PUBLIC"}},"riskData":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.RiskData","summary":"riskData","description":"Payment information for the transaction's risk evaluation score.","x-wix-docs":{"exposure":"PUBLIC"}},"externalFee":{"title":"externalFee","description":"Additional application-specific fee in minor units, for example, cents.","$ref":"#/components/schemas/google.protobuf.UInt64Value","x-wix-docs":{"exposure":"PUBLIC"}},"metadata":{"title":"metadata","description":"Metadata to store within the created transaction.","maxItems":16,"type":"object","format":"map","properties":{"key:value":{"type":"string","description":"\"key\" of type string, \"value\" of type string","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}},"softDescriptor":{"title":"softDescriptor","description":"Complete description that appears on the customers' statements.","maxLength":20,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"amountBreakdown":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.AmountBreakdown","summary":"amountBreakdown","description":"Amount breakdown.","x-wix-docs":{"exposure":"PUBLIC"}},"forceSca":{"title":"forceSca","description":"Prefer Strong Customer Authentication","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateTransactionRequest","description":"","oneOf":[{"description":"","summary":"transactionType","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.CreateTransactionRequest.transactionType"},{"description":"","summary":"paymentMethod","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.CreateTransactionRequest.paymentMethod"}]},"wix.wixpay.transaction.api.v3.CreateTransactionRequest.transactionType":{"type":"object","title":"transactionType","properties":{"oneTimePayment":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.OneTimePayment","summary":"oneTimePayment","description":"One-time on-session payment.","x-wix-docs":{"exposure":"PUBLIC"}},"setupCofOnSession":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.SetupCofOnSession","summary":"setupCofOnSession","description":"On-session payment followed by the storing of credentials to enable future transactions initiated by the cardholder. For example, one-click purchases.","x-wix-docs":{"exposure":"PUBLIC"}},"setupCofRecurring":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.SetupCofRecurring","summary":"setupCofRecurring","description":"On-session payment followed by the storing of credentials to enable future recurring transactions initiated by the merchant. For example, regular subscription charges.","x-wix-docs":{"exposure":"PUBLIC"}},"setupCofUnscheduled":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.SetupCofUnscheduled","summary":"setupCofUnscheduled","description":"On-session payment followed by the storing of credentials to enable future unscheduled transactions initiated by the merchant. For example, automatic top-ups.","x-wix-docs":{"exposure":"PUBLIC"}},"cofOnSession":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.CofOnSession","summary":"cofOnSession","description":"On-session transaction initiated by the cardholder. For example, a one-click purchase.","x-wix-docs":{"exposure":"PUBLIC"}},"cofRecurring":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.CofRecurring","summary":"cofRecurring","description":"Off-session recurring transaction initiated by the merchant. For example, a regular subscription charge.","x-wix-docs":{"exposure":"PUBLIC"}},"cofUnscheduled":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.CofUnscheduled","summary":"cofUnscheduled","description":"Off-session unscheduled transaction initiated by the merchant. For example, an automatic top-up.","x-wix-docs":{"exposure":"PUBLIC"}}}},"wix.wixpay.transaction.api.v3.CreateTransactionRequest.paymentMethod":{"type":"object","title":"paymentMethod","properties":{"card":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.CardPayment","summary":"card","description":"Credt/debit card information.","x-wix-docs":{"exposure":"PUBLIC"}},"cardReader":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.CardReaderPayment","summary":"cardReader","description":"Point of sale with Wix Payments.","x-wix-docs":{"exposure":"PUBLIC"}},"ideal":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.IDealPayment","summary":"ideal","description":"iDEAL is an online payment method in Netherlands.","x-wix-docs":{"exposure":"PUBLIC"}},"ach":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.AchPayment","summary":"ach","description":"ACH network.","x-wix-docs":{"exposure":"PUBLIC"}},"applePay":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.ApplePayPayment","summary":"applePay","description":"Mobile payment and digital wallet service provided by Apple Inc.","x-wix-docs":{"exposure":"PUBLIC"}},"googlePay":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.GooglePayPayment","summary":"googlePay","description":"Mobile payment and digital wallet service provided by Google LLC.","x-wix-docs":{"exposure":"PUBLIC"}},"boleto":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.BoletoPayment","summary":"boleto","description":"Boleto Bancário, commonly known as Boleto, is a popular Brazilian cash-based payment method.","x-wix-docs":{"exposure":"PUBLIC"}},"sepa":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.SepaPayment","summary":"sepa","description":"The Single Euro Payments Area (SEPA) is a payment-integration initiative of the European Union for simplification of bank transfers denominated in euro.","x-wix-docs":{"exposure":"PUBLIC"}},"pix":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.PixPayment","summary":"pix","description":"Pix is a popular Brazilian QR Code based payment method.","x-wix-docs":{"exposure":"PUBLIC"}},"tokenized":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.TokenizedPayment","summary":"tokenized","description":"payment method tokenized by caller and it's token is passed instead","x-wix-docs":{"exposure":"PUBLIC"}}}},"wix.wixpay.transaction.api.v3.AutomaticCapture":{"type":"object","properties":{},"title":"AutomaticCapture","description":"Authorize and capture transaction."},"wix.wixpay.transaction.api.v3.Item":{"type":"object","properties":{"id":{"title":"id","description":"Item ID.","minLength":1,"maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"title":{"title":"title","description":"Item title.","minLength":1,"maxLength":1200,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"unitPrice":{"title":"unitPrice","description":"Single item price in minor units (e.g., cents).","$ref":"#/components/schemas/google.protobuf.UInt64Value","x-wix-docs":{"exposure":"PUBLIC"}},"quantity":{"title":"quantity","description":"Item unit quantity.","minimum":1,"$ref":"#/components/schemas/google.protobuf.UInt32Value","x-wix-docs":{"exposure":"PUBLIC"}},"category":{"title":"category","description":"Item category.","type":"string","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Item.Category","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Item","description":""},"google.protobuf.UInt64Value":{"type":"object","properties":{"value":{"title":"value","description":"","type":"number","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UInt64Value","description":""},"wix.wixpay.transaction.api.v3.Item.Category":{"type":"string","description":"","title":"Category","enum":["UNDEFINED","PHYSICAL","DIGITAL"]},"wix.wixpay.transaction.api.v3.AddressDetails":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/wix.common.Address","summary":"address","description":"Physical address.","x-wix-docs":{"exposure":"PUBLIC"}},"contactDetails":{"$ref":"#/components/schemas/wix.common.FullAddressContactDetails","summary":"contactDetails","description":"Contact details.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AddressDetails","description":""},"wix.common.Address":{"type":"object","properties":{"country":{"title":"country","description":"Country code.","format":"COUNTRY","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"subdivision":{"title":"subdivision","description":"Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"city":{"title":"city","description":"City name.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"postalCode":{"title":"postalCode","description":"Zip/postal code.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"addressLine2":{"title":"addressLine2","description":"Free text providing more detailed address info. Usually contains Apt, Suite, and Floor.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Address","description":"Physical address","oneOf":[{"description":"","summary":"street","$ref":"#/components/schemas/wix.common.Address.street"}]},"wix.common.Address.street":{"type":"object","title":"street","properties":{"streetAddress":{"$ref":"#/components/schemas/wix.common.StreetAddress","summary":"streetAddress","description":"Street name and number.","x-wix-docs":{"exposure":"PUBLIC"}},"addressLine":{"title":"addressLine","description":"Main address line, usually street and number as free text.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}}},"wix.common.StreetAddress":{"type":"object","properties":{"number":{"title":"number","description":"Street number.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"title":"name","description":"Street name.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StreetAddress","description":""},"wix.common.AddressLocation":{"type":"object","properties":{"latitude":{"title":"latitude","description":"Address latitude.","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC"}},"longitude":{"title":"longitude","description":"Address longitude.","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AddressLocation","description":""},"google.protobuf.DoubleValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"number","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DoubleValue","description":""},"wix.common.Subdivision":{"type":"object","properties":{"code":{"title":"code","description":"Short subdivision code.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"title":"name","description":"Subdivision full name.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Subdivision","description":""},"wix.common.Subdivision.SubdivisionType":{"type":"string","description":"","title":"SubdivisionType","enum":["UNKNOWN_SUBDIVISION_TYPE","ADMINISTRATIVE_AREA_LEVEL_1","ADMINISTRATIVE_AREA_LEVEL_2","ADMINISTRATIVE_AREA_LEVEL_3","ADMINISTRATIVE_AREA_LEVEL_4","ADMINISTRATIVE_AREA_LEVEL_5","COUNTRY"]},"wix.common.FullAddressContactDetails":{"type":"object","properties":{"firstName":{"title":"firstName","description":"Contact's first name.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"lastName":{"title":"lastName","description":"Contact's last name.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"phone":{"title":"phone","description":"Contact's phone number.","format":"PHONE","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"company":{"title":"company","description":"Contact's company name.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"email":{"title":"email","description":"Email associated with the address.","format":"EMAIL","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"vatId":{"$ref":"#/components/schemas/wix.common.VatId","summary":"vatId","description":"Tax info. Currently usable only in Brazil.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FullAddressContactDetails","description":"Full contact details for an address"},"wix.common.VatId":{"type":"object","properties":{"id":{"title":"id","description":"Customer's tax ID.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"type":{"title":"type","description":"Tax type.\n\nSupported values:\n+ `CPF`: for individual tax payers\n+ `CNPJ`: for corporations","type":"string","$ref":"#/components/schemas/wix.common.VatType","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"VatId","description":""},"wix.common.VatType":{"type":"string","description":"tax info types","title":"VatType","enum":["UNSPECIFIED","CPF","CNPJ"]},"wix.wixpay.transaction.api.v3.RiskData":{"type":"object","properties":{"userAgent":{"title":"userAgent","description":"\"User-Agent\" HTTP header of a buyer request (**required**).","minLength":1,"maxLength":500,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"referrerHeader":{"title":"referrerHeader","description":"\"Referrer\" HTTP header of a buyer request (**required**).","minLength":1,"maxLength":4096,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"acceptHeader":{"title":"acceptHeader","description":"\"Accept\" HTTP header of a buyer request.","minLength":1,"maxLength":200,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"ipAddress":{"title":"ipAddress","description":"Buyer's IP address.","minLength":1,"maxLength":39,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"deviceFingerprint":{"title":"deviceFingerprint","description":"Device fingerprint.","minLength":1,"maxLength":200,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"merchantChargebackCount":{"title":"merchantChargebackCount","description":"Merchant chargeback count.","$ref":"#/components/schemas/google.protobuf.UInt32Value","x-wix-docs":{"exposure":"PUBLIC"}},"buyerChargebackCount":{"title":"buyerChargebackCount","description":"Buyer chargeback count.","$ref":"#/components/schemas/google.protobuf.UInt32Value","x-wix-docs":{"exposure":"PUBLIC"}},"firstEmailPurchaseDate":{"title":"firstEmailPurchaseDate","description":"Timestamp of first purchase from this buyer's email.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"firstIpPurchaseDate":{"title":"firstIpPurchaseDate","description":"Timestamp of first purchase using the same IP address.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"firstMerchantTransactionDate":{"title":"firstMerchantTransactionDate","description":"Timestamp of merchant's first transaction.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"merchantCreatedDate":{"title":"merchantCreatedDate","description":"Creation date of the merchant within the request originator.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"siteCreatedDate":{"title":"siteCreatedDate","description":"Creation date of the site where customer made the purchase.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"fulfillmentDate":{"title":"fulfillmentDate","description":"Fullfilment date of the purchased event.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"riskProviderData":{"title":"riskProviderData","description":"Provider-specific data. Available keys:\nforter_token_cookie – Token cookie provided by Forter SDK\nforter_mobile_uid - Device identifier such as IMEI for Android or vendor identifier for iOS. The deviceId sent via mobile events API must be passed for this field. For mobile transactions only.","maxItems":16,"type":"object","format":"map","properties":{"key:value":{"type":"string","description":"\"key\" of type string, \"value\" of type string","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"RiskData","description":"Additional information regarding a payment to properly evaluate risk score of the transaction."},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BoolValue","description":""},"wix.wixpay.transaction.api.v3.AmountBreakdown":{"type":"object","properties":{"shipping":{"title":"shipping","description":"Shipping amount.","$ref":"#/components/schemas/google.protobuf.UInt64Value","x-wix-docs":{"exposure":"PUBLIC"}},"tax":{"title":"tax","description":"Tax amount.","$ref":"#/components/schemas/google.protobuf.UInt64Value","x-wix-docs":{"exposure":"PUBLIC"}},"discount":{"title":"discount","description":"Discount for the items.","$ref":"#/components/schemas/google.protobuf.UInt64Value","x-wix-docs":{"exposure":"PUBLIC"}},"shippingDiscount":{"title":"shippingDiscount","description":"Shipping discount.","$ref":"#/components/schemas/google.protobuf.UInt64Value","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AmountBreakdown","description":"Amount breakdown."},"wix.wixpay.transaction.api.v3.OneTimePayment":{"type":"object","properties":{"moto":{"title":"moto","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"OneTimePayment","description":""},"wix.wixpay.transaction.api.v3.SetupCofOnSession":{"type":"object","properties":{"moto":{"title":"moto","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SetupCofOnSession","description":""},"wix.wixpay.transaction.api.v3.SetupCofRecurring":{"type":"object","properties":{"moto":{"title":"moto","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"mandateOptions":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.MandateOptions","summary":"mandateOptions","description":"a record of the permission a customer has given to debit his payment method","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SetupCofRecurring","description":""},"wix.wixpay.transaction.api.v3.MandateOptions":{"type":"object","properties":{"description":{"title":"description","description":"a description of the mandate or subscription that is meant to be displayed to the customer","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"amount":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.MandateOptions.Amount","summary":"amount","description":"payment amount","x-wix-docs":{"exposure":"PUBLIC"}},"interval":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.MandateOptions.Interval","summary":"interval","description":"specifies time ranges for future payments","x-wix-docs":{"exposure":"PUBLIC"}},"frequency":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.MandateOptions.Frequency","summary":"frequency","description":"specifies frequency of payments","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"MandateOptions","description":""},"wix.wixpay.transaction.api.v3.MandateOptions.Amount.Type":{"type":"string","description":"","title":"Type","enum":["UNKNOWN","FIXED","MAXIMUM"]},"wix.wixpay.transaction.api.v3.MandateOptions.Frequency.Type":{"type":"string","description":"","title":"Type","enum":["UNKNOWN","DAY","WEEK","MONTH","YEAR","SPORADIC"]},"wix.wixpay.transaction.api.v3.MandateOptions.Amount":{"type":"object","properties":{"value":{"title":"value","description":"amount in minor units to be charged for future payments","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"type":{"title":"type","description":"if `FIXED`, the `amount` parameter refers to the exact amount to be charged in future payments\nif `MAXIMUM`, the amount charged can be up to the value passed for the `amount` parameter","type":"string","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.MandateOptions.Amount.Type","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Amount","description":""},"wix.wixpay.transaction.api.v3.MandateOptions.Interval":{"type":"object","properties":{"startDate":{"title":"startDate","description":"start date of the mandate or subscription","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"endDate":{"title":"endDate","description":"end date of the mandate or subscription. If not provided, the mandate will be active until canceled","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Interval","description":""},"wix.wixpay.transaction.api.v3.MandateOptions.Frequency":{"type":"object","properties":{"count":{"title":"count","description":"the number of intervals between payments. For example, `type=MONTH` and `count=3` indicates one payment every three months\nmaximum of one year interval allowed (1 year, 12 months, or 52 weeks)\nthis parameter is optional only when `type=SPORADIC`","minimum":1,"maximum":365,"$ref":"#/components/schemas/google.protobuf.UInt32Value","x-wix-docs":{"exposure":"PUBLIC"}},"type":{"title":"type","description":"","type":"string","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.MandateOptions.Frequency.Type","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Frequency","description":""},"wix.wixpay.transaction.api.v3.SetupCofUnscheduled":{"type":"object","properties":{"moto":{"title":"moto","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"mandateOptions":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.MandateOptions","summary":"mandateOptions","description":"a record of the permission a customer has given to debit his payment method","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SetupCofUnscheduled","description":""},"wix.wixpay.transaction.api.v3.CofOnSession":{"type":"object","properties":{"transactionReference":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.TransactionReference","summary":"transactionReference","description":"Reference to the initial transaction.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CofOnSession","description":""},"wix.wixpay.transaction.api.v3.TransactionReference":{"type":"object","properties":{},"title":"TransactionReference","description":"","oneOf":[{"description":"","summary":"reference","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.TransactionReference.reference"}]},"wix.wixpay.transaction.api.v3.TransactionReference.reference":{"type":"object","title":"reference","properties":{"transactionId":{"title":"transactionId","description":"Previously created transaction's ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"networkReference":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.NetworkReference","summary":"networkReference","description":"Transaction reference provided by a payment network.","x-wix-docs":{"exposure":"PUBLIC"}}}},"wix.wixpay.transaction.api.v3.CofRecurring":{"type":"object","properties":{"transactionReference":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.TransactionReference","summary":"transactionReference","description":"Reference to the initial transaction.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CofRecurring","description":""},"wix.wixpay.transaction.api.v3.CofUnscheduled":{"type":"object","properties":{"transactionReference":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.TransactionReference","summary":"transactionReference","description":"Reference to the initial transaction.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CofUnscheduled","description":""},"wix.wixpay.transaction.api.v3.CardPayment":{"type":"object","properties":{"numberToken":{"title":"numberToken","description":"Credit/debit card number token.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"expiryMonth":{"title":"expiryMonth","description":"Card expiration month.","minimum":1,"maximum":12,"type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"expiryYear":{"title":"expiryYear","description":"Card expiration year (4 digits, for example, 2022, 2025).","minimum":2000,"maximum":2099,"type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"holderName":{"title":"holderName","description":"Cardholder name printed on the card.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"securityCodeToken":{"title":"securityCodeToken","description":"Security code (CVV/CVC/CID) token.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CardPayment","description":"Card payment."},"wix.wixpay.transaction.api.v3.CardReaderPayment":{"type":"object","properties":{"locationId":{"title":"locationId","description":"Location ID.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"terminalId":{"title":"terminalId","description":"Terminal ID.","minLength":1,"maxLength":50,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"serviceId":{"title":"serviceId","description":"Service ID.","minLength":1,"maxLength":50,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CardReaderPayment","description":"Manage your offline business with the Wix Payments solution."},"wix.wixpay.transaction.api.v3.IDealPayment":{"type":"object","properties":{"issuingBank":{"title":"issuingBank","description":"Code of the specified issuing bank to process transaction.","minLength":1,"maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"IDealPayment","description":"iDEAL is an online payment method that enables consumers to pay online through their own bank in the Netherlands."},"wix.wixpay.transaction.api.v3.AchPayment":{"type":"object","properties":{"bankAccountNumber":{"title":"bankAccountNumber","description":"Bank account number.","minLength":4,"maxLength":17,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"bankRoutingNumber":{"title":"bankRoutingNumber","description":"Bank routing number of the account.","minLength":9,"maxLength":9,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"bankAccountOwnerName":{"title":"bankAccountOwnerName","description":"The name on the bank account.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AchPayment","description":"The ACH network."},"wix.wixpay.transaction.api.v3.ApplePayPayment":{"type":"object","properties":{"dpanToken":{"title":"dpanToken","description":"D-PAN token","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"expiryYear":{"title":"expiryYear","description":"Full year of the D-PAN card expiration date.","minimum":2000,"maximum":2099,"type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"expiryMonth":{"title":"expiryMonth","description":"Month of the D-PAN card expiration date.","minimum":1,"maximum":12,"type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"onlinePaymentCryptogram":{"title":"onlinePaymentCryptogram","description":"Online payment cryptogram aka 3ds 2.0 challenge result.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"eci":{"title":"eci","description":"ECI indicator.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"cardholderName":{"title":"cardholderName","description":"Card holder name","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ApplePayPayment","description":"Integrate a mobile payment and digital wallet service by Apple Inc. that allows users to make payments in person, in iOS apps, and on the web although."},"wix.wixpay.transaction.api.v3.GooglePayPayment":{"type":"object","properties":{"panToken":{"title":"panToken","description":"PAN token","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"expiryYear":{"title":"expiryYear","description":"Full year of the PAN card expiration date.","minimum":2000,"maximum":2099,"type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"expiryMonth":{"title":"expiryMonth","description":"Month of the PAN card expiration date.","minimum":1,"maximum":12,"type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"authMethod":{"title":"authMethod","description":"Auth method","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"onlinePaymentCryptogram":{"title":"onlinePaymentCryptogram","description":"Online payment cryptogram aka 3ds 2.0 challenge result.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"eci":{"title":"eci","description":"ECI indicator.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"accountVerified":{"title":"accountVerified","description":"Is Account verified","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"cardHolderAuthenticated":{"title":"cardHolderAuthenticated","description":"Is cardholder authenticated","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GooglePayPayment","description":"Integrate a mobile payment and digital wallet service by Google Inc. that allows users to make payments in person, in Android apps, and on the web"},"wix.wixpay.transaction.api.v3.BoletoPayment":{"type":"object","properties":{"expirationDate":{"title":"expirationDate","description":"Boleto barcode expiration date.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BoletoPayment","description":"Boleto Bancário, commonly known as Boleto, is a popular Brazilian cash-based payment method."},"wix.wixpay.transaction.api.v3.SepaPayment":{"type":"object","properties":{"bankAccountOwnerName":{"title":"bankAccountOwnerName","description":"Bank account owner name.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"iban":{"title":"iban","description":"International bank account number.","minLength":1,"maxLength":34,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SepaPayment","description":"The Single Euro Payments Area (SEPA) is a payment-integration initiative of the European Union for simplification of bank transfers denominated in euro."},"wix.wixpay.transaction.api.v3.PixPayment":{"type":"object","properties":{"expirationDate":{"title":"expirationDate","description":"Pix QR code expiration date.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PixPayment","description":"Pix is a popular Brazilian QR Code based payment method."},"wix.wixpay.transaction.api.v3.TokenizedPayment":{"type":"object","properties":{"tokens":{"title":"tokens","description":"Provider-specific tokens:\n* Stripe - `paymentMethodId`","type":"object","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"TokenizedPayment","description":""},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"title":"fields","description":"","type":"object","format":"map","properties":{"key:value":{"type":"object","description":"\"key\" of type string, \"value\" of type object","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"title":"nullValue","description":"","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC"}},"numberValue":{"title":"numberValue","description":"","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"stringValue":{"title":"stringValue","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"boolValue":{"title":"boolValue","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"structValue":{"title":"structValue","description":"","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"listValue":{"title":"listValue","description":"","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"title":"values","description":"","$ref":"#/components/schemas/google.protobuf.Value","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListValue","description":""},"wix.wixpay.transaction.api.v3.CreateTransactionResponse":{"type":"object","properties":{"transaction":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Transaction","summary":"transaction","description":"Transaction information.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateTransactionResponse","description":""},"wix.wixpay.transaction.api.v3.GetTransactionRequest":{"type":"object","properties":{"accountId":{"title":"accountId","description":"Wix Payments account ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"transactionId":{"title":"transactionId","description":"Transaction ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetTransactionRequest","description":""},"wix.wixpay.transaction.api.v3.GetTransactionResponse":{"type":"object","properties":{"transaction":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Transaction","summary":"transaction","description":"Transaction information.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetTransactionResponse","description":""},"wix.wixpay.transaction.api.v3.CaptureTransactionRequest":{"type":"object","properties":{"accountId":{"title":"accountId","description":"Wix Payments account ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"transactionId":{"title":"transactionId","description":"Transaction ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"amount":{"title":"amount","description":"Amount to capture in minor units (for example, cents). When not passed, the whole transaction amount will be captured.","$ref":"#/components/schemas/google.protobuf.UInt64Value","x-wix-docs":{"exposure":"PUBLIC"}},"capturableAmount":{"title":"capturableAmount","description":"Amount that can be captured or voided in minor units to place a hold on a card to reserve funds.\nSpecify the amount to prevent double partial captures.","$ref":"#/components/schemas/google.protobuf.UInt64Value","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"message":"Amount that can be captured or voided in minor units to place a hold on a card to reserve funds.\nSpecify the amount to prevent double partial captures."}}},"idempotencyKey":{"title":"idempotencyKey","description":"Key to ensure idempotency.","minLength":1,"maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"externalCaptureId":{"title":"externalCaptureId","description":"Corresponding capture ID within the external entity that initiated the transaction capture.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"metadata":{"title":"metadata","description":"Metadata to store within the created capture.","maxItems":16,"type":"object","format":"map","properties":{"key:value":{"type":"string","description":"\"key\" of type string, \"value\" of type string","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CaptureTransactionRequest","description":""},"wix.wixpay.transaction.api.v3.CaptureTransactionResponse":{"type":"object","properties":{"transaction":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Transaction","summary":"transaction","description":"Captured transaction information.","x-wix-docs":{"exposure":"PUBLIC"}},"captureId":{"title":"captureId","description":"Capture ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CaptureTransactionResponse","description":""},"wix.wixpay.transaction.api.v3.VoidOrRefundTransactionRequest":{"type":"object","properties":{"accountId":{"title":"accountId","description":"Wix Payments account ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"transactionId":{"title":"transactionId","description":"Transaction ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"amount":{"title":"amount","description":"Amount to capture in minor units (for example, cents). Leave empty to capture the whole transaction amount.","$ref":"#/components/schemas/google.protobuf.UInt64Value","x-wix-docs":{"exposure":"PUBLIC"}},"capturableAmount":{"title":"capturableAmount","description":"Amount that can be captured or voided in minor units to place a hold on a card to reserve funds.\nSpecify the amount to prevent double partial refunds.","$ref":"#/components/schemas/google.protobuf.UInt64Value","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"message":"Amount that can be captured or voided in minor units to place a hold on a card to reserve funds.\nSpecify the amount to prevent double partial refunds."}}},"refundableAmount":{"title":"refundableAmount","description":"Amount in minor units that can be refunded.\nSpecify the amount to prevent double partial refunds.","$ref":"#/components/schemas/google.protobuf.UInt64Value","x-wix-docs":{"exposure":"PUBLIC","deprecated":{"message":"Amount in minor units that can be refunded.\nSpecify the amount to prevent double partial refunds."}}},"idempotencyKey":{"title":"idempotencyKey","description":"Key to ensure idempotency.","minLength":1,"maxLength":100,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"externalVoidOrRefundId":{"title":"externalVoidOrRefundId","description":"Corresponding void or refund ID within the external entity that made the request.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"reason":{"title":"reason","description":"Reason for void or refund.","type":"string","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.TransactionModificationReason","x-wix-docs":{"exposure":"PUBLIC"}},"metadata":{"title":"metadata","description":"Metadata to store within the created void or refund.","maxItems":16,"type":"object","format":"map","properties":{"key:value":{"type":"string","description":"\"key\" of type string, \"value\" of type string","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"VoidOrRefundTransactionRequest","description":""},"wix.wixpay.transaction.api.v3.VoidOrRefundTransactionResponse":{"type":"object","properties":{"transaction":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Transaction","summary":"transaction","description":"Voided or refunded transaction information.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"VoidOrRefundTransactionResponse","description":"","oneOf":[{"description":"","summary":"resultId","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.VoidOrRefundTransactionResponse.resultId"}]},"wix.wixpay.transaction.api.v3.VoidOrRefundTransactionResponse.resultId":{"type":"object","title":"resultId","properties":{"voidId":{"title":"voidId","description":"Void Id.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"refundId":{"title":"refundId","description":"Refund ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}}},"wix.wixpay.transaction.api.v3.AcceptDisputeRequest":{"type":"object","properties":{"accountId":{"title":"accountId","description":"Wix Payments account ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"transactionId":{"title":"transactionId","description":"Transaction ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"disputeId":{"title":"disputeId","description":"Dispute ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AcceptDisputeRequest","description":""},"wix.wixpay.transaction.api.v3.AcceptDisputeResponse":{"type":"object","properties":{"transaction":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Transaction","summary":"transaction","description":"Transaction information.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AcceptDisputeResponse","description":""},"wix.wixpay.transaction.api.v3.StartEvidenceUploadRequest":{"type":"object","properties":{"accountId":{"title":"accountId","description":"Wix Payments account ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"transactionId":{"title":"transactionId","description":"Transaction ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"disputeId":{"title":"disputeId","description":"Dispute ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StartEvidenceUploadRequest","description":""},"wix.wixpay.transaction.api.v3.StartEvidenceUploadResponse":{"type":"object","properties":{"uploadUrl":{"title":"uploadUrl","description":"Evidence upload URL.","format":"URI","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"uploadToken":{"title":"uploadToken","description":"Evidence upload token.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StartEvidenceUploadResponse","description":""},"wix.wixpay.transaction.api.v3.GenerateEvidenceUploadUrlRequest":{"type":"object","properties":{"accountId":{"title":"accountId","description":"Wix Payments account ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"transactionId":{"title":"transactionId","description":"Transaction ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"disputeId":{"title":"disputeId","description":"Dispute ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GenerateEvidenceUploadUrlRequest","description":""},"wix.wixpay.transaction.api.v3.GenerateEvidenceUploadUrlResponse":{"type":"object","properties":{"uploadUrl":{"title":"uploadUrl","description":"Evidence upload URL.","format":"URI","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"uploadToken":{"title":"uploadToken","description":"Evidence upload token.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GenerateEvidenceUploadUrlResponse","description":""},"wix.wixpay.transaction.api.v3.AddEvidenceRequest":{"type":"object","properties":{"accountId":{"title":"accountId","description":"Wix Payments account ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"transactionId":{"title":"transactionId","description":"Transaction ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"disputeId":{"title":"disputeId","description":"Dispute ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"evidence":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Evidence","summary":"evidence","description":"Evidence to include in the request.","x-wix-docs":{"exposure":"PUBLIC"}},"idempotencyKey":{"title":"idempotencyKey","description":"Use the same unique key when request retry is caused by technical issues like network availability.","minLength":1,"maxLength":36,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AddEvidenceRequest","description":""},"wix.wixpay.transaction.api.v3.Evidence":{"type":"object","properties":{"type":{"title":"type","description":"","type":"string","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Evidence.EvidenceType","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Evidence","description":"","oneOf":[{"description":"","summary":"content","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Evidence.content"}]},"wix.wixpay.transaction.api.v3.Evidence.content":{"type":"object","title":"content","properties":{"fileId":{"title":"fileId","description":"File ID.","minLength":1,"maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"text":{"title":"text","description":"Evidence content text.","minLength":1,"maxLength":100000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}}},"wix.wixpay.transaction.api.v3.Evidence.EvidenceType":{"type":"string","description":"","title":"EvidenceType","enum":["OTHER","ACCESS_ACTIVITY_LOG","BILLING_ADDRESS","CANCELLATION_POLICY","CANCELLATION_POLICY_DISCLOSURE","CANCELLATION_REBUTTAL","CUSTOMER_COMMUNICATION","CUSTOMER_EMAIL_ADDRESS","CUSTOMER_NAME","CUSTOMER_PURCHASE_IP","CUSTOMER_SIGNATURE","DUPLICATE_CHARGE_DOCUMENTATION","DUPLICATE_CHARGE_EXPLANATION","DUPLICATE_CHARGE_ID","PRODUCT_DESCRIPTION","RECEIPT","REFUND_POLICY","REFUND_POLICY_DISCLOSURE","REFUND_REFUSAL_EXPLANATION","SERVICE_DATE","SERVICE_DOCUMENTATION","SHIPPING_ADDRESS","SHIPPING_CARRIER","SHIPPING_DATE","SHIPPING_DOCUMENTATION","SHIPPING_TRACKING_NUMBER"]},"wix.wixpay.transaction.api.v3.AddEvidenceResponse":{"type":"object","properties":{"transaction":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Transaction","summary":"transaction","description":"Transaction information.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AddEvidenceResponse","description":""},"wix.wixpay.transaction.api.v3.SubmitEvidenceRequest":{"type":"object","properties":{"accountId":{"title":"accountId","description":"Wix Payments account ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"transactionId":{"title":"transactionId","description":"Transaction ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"disputeId":{"title":"disputeId","description":"Dispute ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SubmitEvidenceRequest","description":""},"wix.wixpay.transaction.api.v3.SubmitEvidenceResponse":{"type":"object","properties":{"transaction":{"$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.Transaction","summary":"transaction","description":"Transaction information.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SubmitEvidenceResponse","description":""},"wix.wixpay.transaction.api.v3.AnonymizeTransactionsRequest":{"type":"object","properties":{"accountId":{"title":"accountId","description":"Wix Payments account ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"transactionIds":{"title":"transactionIds","description":"Transaction IDs.","format":"GUID","minItems":1,"maxItems":1000,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AnonymizeTransactionsRequest","description":""},"wix.wixpay.transaction.api.v3.AnonymizeTransactionsResponse":{"type":"object","properties":{"results":{"title":"results","description":"Map with transaction IDs as keys and results of anonymization as values.","maxItems":1000,"type":"object","format":"map","properties":{"key:value":{"type":"object","description":"\"key\" of type string, \"value\" of type object","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AnonymizeTransactionsResponse","description":""},"wix.wixpay.transaction.api.v3.AnonymizeTransactionResult":{"type":"object","properties":{"status":{"title":"status","description":"Anonymization status.","type":"string","$ref":"#/components/schemas/wix.wixpay.transaction.api.v3.AnonymizeTransactionResult.Status","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AnonymizeTransactionResult","description":""},"wix.wixpay.transaction.api.v3.AnonymizeTransactionResult.Status":{"type":"string","description":"","title":"Status","enum":["UNKNOWN","SUCCEEDED","NOT_FOUND"]}}},"title":"Transaction","description":"","fqdn":"wix.payments.transactions.v3.transaction"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"## About the Transactions API\nUse Wix Payments server-to-server API integration to accept different payment methods and manage transactions. Wix Payments act as a standalone solution to independently process payments, deal with chargebacks and disputes via Wix infrastructure, and can be used by any third-party.\n\n### **Wix Payments integration prerequisites**\nBefore testing the Transactions API, you need to get a Wix Payments account ID. Wix also applies a Know Your Customer (KYC) and evaluation procedure. Contact Wix via transactions-api-support@wix.com and provide the following details to start the evaluation process:\n- Put \"Wix Payments integration\" in the subject of the email.\n- Provide your name and email.\n- Include the purpose of your integration with the Transactions API.\n\n**Transactions API supports the following flows:**\n- Authorization (reserving funds)\n- Capture (transferring of reserved funds)\n- One-time transaction (Authorization and Capture)\n- Recurring transactions (MIT and CIT)\n- Refund/Void (canceling an authorized or captured transaction)\n- Dispute\n\n**Wix Payments supports the following payment methods:**\n- Card\n- ACH\n- Apple Pay\n- Boleto\n- Giropay\n- iDEAL\n- PayPal\n- Pix\n- SEPA\n- SOFORT\n\n## Terminology\n- **Merchant**: A party selling goods or services to customers via an eCommerce website, a mobile app, on the point of sale, or across all three channels. Wix Payments enable a merchant to accept payments from customers made with cards or local payment methods and manage payouts.\n- **Customer**: Someone who buys goods or services from a merchant. In terms of Transactions API, a customer makes a cashless online payment by using either cards or local payment methods to pay.\n- **Cardholder**: Customer who uses a card issued by a bank to make cashless online payments to a merchant. \n- **Transaction**: Agreement between a merchant and a customer to exchange goods, services, or financial instruments. The [transaction object](https://dev.wix.com/api/rest/wix-payments/transactions/transaction-object) contains the basic information required to securely process the payment, execute related actions (delivery, analytics, inventory management) and comply with financial regulations.\n- **Merchant Initiated Transaction** (MIT): Payment or a series of payments with fixed or variable amounts that the merchant performs without direct involvement of a customer, such as automatic account top-ups, and installments.\n- **Cardholder Initiated Transaction** (CIT): Payment initiated by the cardholder on their own after the initial successful transaction.\n- **Authorization**: Process of card issuer verifying payment details and reserving funds to capture them later. When the card is verified with the issuer, the funds are reserved for the transaction.\n- **Transaction reference**: Transaction ID of the first transaction for recurring transactions. It should be passed with each subsequent transaction.\n- **Capture**: Transfer of reserved funds from the customer to the merchant. A payment that was already authorized, must be captured to be completed.\n- **Refund** Transfer of funds from the merchant back to the customer - merchant-initated. When the merchant makes a refund, the funds are sent back to the card issuer. If an authorized payment hasn't been captured yet, a refund can't be made, but the merchant can void the payment instead.\n- **Void**: Voiding a transaction will tell the customer’s card issuing bank that the merchant does not intend to collect the transaction corresponding to the original six-digit approval code and, therefore, those held funds are made available to the customer again. Merchant can void a transaction until it is captured.\n- **Dispute**: Refers to the entire process from the moment the customer applies to their issuing bank. Dispute occurs when a cardholder questions the charge with their card issuer and initiates a chargeback. When this happens, the merchant is given the opportunity to respond to the dispute with evidence that shows that the charge is legitimate.\n- **Request for Information (RFI)**: Optional first step in a dispute, initiated when the cardholder does not recognize or disagrees with a charge and requests more information from their bank.\n- **Chargeback**: Second and primary step in a dispute. It includes a reversal of a credit card payment that comes directly from the bank. Chargeback occurs when a cardholder questions a transaction and asks their card-issuing bank to reverse it. \n- **Evidence**: Documentation in response to the dispute (RFI or chargeback steps), appropriate to the reason for the dispute. For example, evidence responding to a dispute with the reason “product not received” can include shipping information and any screenshots of package tracking. Weblogs, email communications, shipment tracking numbers, delivery confirmation, proof of prior refunds, or replacement shipments can all be helpful.\n\n## Recurring transactions\nWix Payments API allows merchants to set up recurring payments. It adds flexibility and full control of the entire business flow. For subsequent transactions, only the `card_number` should be tokenized using the [Create Card Token](https://dev.wix.com/api/rest/wix-payments/card-tokens/create-card-token) endpoint, and the appropriate token passed to the [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction).\n\n>**Note** to achieve the best approve ratio, the correct MIT/CIT flag must be passed as well.\n> To achieve the best approve ratio, pass all possible values received from the card schemes:\n>- __Network_transaction_id__\n>- __ds_transaction_id__ (in case the initial transaction was performed by the 3DS2 regulations)\n\n> [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction) endpoint is fully compatible with the new PSD2 regulations and supports 3DS 2 mechanism.\n\n## Interaction types\n| Interaction Type | Additional Parameters |Comments |\n| ------------- |-------------| -----|\n| ONE_TIME | | Regular one-time transaction|\n| SETUP_COF_ONSESSION | | Initial transaction with the subsequent CIT (setup one-click)\n| SETUP_COF_RECURRING | | Initial transaction with the subsequent MIT transactions according to a defined schedule|\n| SETUP_COF_UNSCHEDULED | | Initial transaction with the subsequent MIT transactions without the defined schedule |\n| COF_ONSESSION | transaction_reference | Subsequent transaction initiated by the customer (perform one-click) |\n| COF_RECURRING |transaction_reference | Recurring transactions initiated by the merchant according to the defined schedule|\n| COF_UNSCHEDULED | transaction_reference| Recurring transactions initiated by the merchant without a schedule|\n\n## Use cases\nCreate and manage transactions with the following flows:\n\n1. Create a one-time payment and simultaneously authorize and capture funds.\n2. Create a one-time payment. Authorize and Capture the funds separately.\n3. Create a first/initial recurring payment and subsequent one when the cardholder is not present - authorization and capture in one step.\n4. Create an initial “on session” (cardholder present) payment and notify Wix of credential storage to execute a subsequent one in the future when the cardholder is present.\n5. Charge a customer and refund funds afterwards.\n\n### 1. Create a one-time payment and simultaneously authorize and capture funds.\n\nTransaction info: $10 USD, one-time credit card transaction, using a card token. A new `card_token` must be generated for each transaction request. \n(A card token must be passed to [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction) when a credit/debit card is the chosen payment method.) \n\nTo create a transaction, call [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction). \n\nParameters to include:\n```\n{\n \"accountId\": \"81c79a2-9bd5-4852-9296-6a24c640f1ef\",\n \"amount\": \"1000\",\n \"currency\": \"USD\",\n \"paymentMethodTypeId\": \"creditCard\",\n \"card\": {\n \"numberToken\": \"41c29a2-9bd5-4552-1296-6a24c6g0f1ef\",\n \"expiryMonth\": 11,\n \"expiryYear\": 2027,\n \"holderName\": \"John Doe\",\n \"securityCodeToken\": \"71c7932-9bd5-48d2-9196-6df4c640f1ef\"\n },\n \"automaticCapture\": {},\n \"oneTimePayment\": {}\n}\n```\n> Note: Pass an empty object for the type of transaction `oneTimePayment`, but not null or missing.\n\n### 2. Create a one-time payment. Authorize and Capture the funds separately.\n\nTransaction info: $10 USD, one-time credit card transaction, using a card token. A new `card_token` must be generated for each transaction request. \n(A card token must be passed to [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction) when a credit/debit card is the chosen payment method.)\n\n1. Call [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction).\n\nParameters to include:\n```\nPOST https://www.wixapis.com/payments/v3/transactions\n\n{\n \"accountId\": \"81c79a2-9bd5-4852-9296-6a24c640f1ef\",\n \"amount\": \"1000\",\n \"currency\": \"USD\",\n \"paymentMethodTypeId\": \"creditCard\",\n \"card\": {\n \"numberToken\": \"41c29a2-9bd5-4552-1296-6a24c6g0f1ef\",\n \"expiryMonth\": 11,\n \"expiryYear\": 2027,\n \"holderName\": \"John Doe\",\n \"securityCodeToken\": \"71c7932-9bd5-48d2-9196-6df4c640f1ef\"\n },\n \"oneTimePayment\": {}\n}\n```\n\n2. Call [Capture Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/capture-transaction). Retrieve the transactionId from the step 1.\n\nParameters to include:\n```\nPOST https://www.wixapis.com/payments/v3/transactions/2ac75a2-91d5-4752-6h96-6aj74640f1ef/capture\n\n{\n \"accountId\": \"81c79a2-9bd5-4852-9296-6a24c640f1ef\"\n}\n```\n\n### 3. Create a first/initial recurring payment and subsequent one when the cardholder is not present - authorization and capture in one step.\n\nTransaction info: $10 USD, one-time credit card transaction, using a card token. A new card_token must be generated for each transaction request. \n(A card token must be passed to [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction) when a credit/debit card is the chosen payment method.) \nWhen creating a recurring transaction (MIT/CIT), you only need to tokenize the `card_number` and pass it in the Create Transaction request together with COF.\n\n1. Call [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction).\n\nParameters to include:\n```\n{\n \"accountId\": \"81c79a2-9bd5-4852-9296-6a24c640f1ef\",\n \"amount\": \"1000\",\n \"currency\": \"USD\",\n \"paymentMethodTypeId\": \"creditCard\",\n \"card\": {\n \"numberToken\": \"41c29a2-9bd5-4552-1296-6a24c6g0f1ef\",\n \"expiryMonth\": 11,\n \"expiryYear\": 2027,\n \"holderName\": \"John Doe\",\n \"securityCodeToken\": \"71c7932-9bd5-48d2-9196-6df4c640f1ef\"\n },\n \"automaticCapture\": {}\n \"setupCofRecurring\": {}\n}\n```\n\n2. Retrieve the `transactionId` of the created transaction from the response from step 1. (In this example, `transactionId` = 01csa932-9bd5-38d2-91d6-6jf5c640f1ef). You’ll need to pass it as the `transactionReference` in all subsequent transactions.\n\n3. When a subsequent payment is due, call [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction) and pass the `transactionId` from step 1 as the `transactionReference`.\n\nParameters to include:\n```\n{\n \"accountId\": \"81c79a2-9bd5-4852-9296-6a24c640f1ef\",\n \"amount\": \"1000\",\n \"currency\": \"USD\",\n \"paymentMethodTypeId\": \"creditCard\",\n \"card\": {\n \"numberToken\": \"41c29a2-9bd5-4552-1296-6a24c6g0f1ef\",\n \"expiryMonth\": 11,\n \"expiryYear\": 2027,\n \"holderName\": \"John Doe\"\n },\n \"automaticCapture\": {},\n \"cofRecurring\": {\n \"transactionReference\": {\n \"transactionId\": \"01csa932-9bd5-38d2-91d6-6jf5c640f1ef\"\n } \n }\n}\n```\n\n### 4. Create an initial “on session” (cardholder present) payment and notify Wix of credential storage to execute a subsequent one in the future when the cardholder is present.\n\nTransaction info: $10 USD, one-time credit card transaction, using a card token. A new card_token must be generated for each transaction request. \n(A card token must be passed to [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction) when a credit/debit card is the chosen payment method.) \nWhen creating a recurring transaction (MIT/CIT), you only need to tokenize the `card_number` and pass it in the Create Transaction request together with COF.\n\n1. Call [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction).\n\nParameters to include:\n```\n{\n \"accountId\": \"81c79a2-9bd5-4852-9296-6a24c640f1ef\",\n \"amount\": \"1000\",\n \"currency\": \"USD\",\n \"paymentMethodTypeId\": \"creditCard\",\n \"card\": {\n \"numberToken\": \"41c29a2-9bd5-4552-1296-6a24c6g0f1ef\",\n \"expiryMonth\": 11,\n \"expiryYear\": 2027,\n \"holderName\": \"John Doe\",\n \"securityCodeToken\": \"71c7932-9bd5-48d2-9196-6df4c640f1ef\"\n },\n \"automaticCapture\": {},\n \"setupCofOnSession\": {}\n}\n```\n\n2. Retrieve the transactionId (in this example, `transactionId` = 01csa932-9bd5-38d2-91d6-6jf5c640f1ef). You’ll need to pass it as the `transactionReference` in all subsequent transactions.\n\n3. Call [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction). \n`transactionReference` is the ID of the transaction in the response from step 1.\n\nParameters to include:\n```\n{\n \"accountId\": \"81c79a2-9bd5-4852-9296-6a24c640f1ef\",\n \"amount\": \"1000\",\n \"currency\": \"USD\",\n \"paymentMethodTypeId\": \"creditCard\",\n \"card\": {\n \"numberToken\": \"41c29a2-9bd5-4552-1296-6a24c6g0f1ef\",\n \"expiryMonth\": 11,\n \"expiryYear\": 2027,\n \"holderName\": \"John Doe\",\n \"securityCodeToken\": \"71c7932-9bd5-48d2-9196-6df4c640f1ef\"\n },\n \"automaticCapture\": {},\n \"cofOnSession\": {\n \"transactionReference\": {\n \"transactionId\": \"01csa932-9bd5-38d2-91d6-6jf5c640f1ef\"\n } \n }\n}\n```\n\n### 5. Charge a customer and refund funds afterward.\n\nTransaction info: $50 USD, one-time credit card transaction, using a card token.\n\n1. Call [Create Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/create-transaction).\n\nParameters to include:\n```\n{\n \"accountId\": \"81c79a2-9bd5-4852-9296-6a24c640f1ef\",\n \"amount\": \"5000\",\n \"currency\": \"USD\",\n \"paymentMethodTypeId\": \"creditCard\",\n \"card\": {\n \"numberToken\": \"41c29a2-9bd5-4552-1296-6a24c6g0f1ef\",\n \"expiryMonth\": 11,\n \"expiryYear\": 2027,\n \"holderName\": \"John Doe\",\n \"securityCodeToken\": \"71c7932-9bd5-48d2-9196-6df4c640f1ef\"\n },\n \"automaticCapture\": {},\n \"oneTimePayment\": {}\n}\n```\n\n2. Call [VoidOrRefund Transaction](https://dev.wix.com/api/rest/wix-payments/transactions/void-or-refund-transaction).\n\na. For a full refund:\n```\nPOST https://www.wixapis.com/payments/v3/transactions/71c7932-9bd5-48d2-9196-6df4c640f1ef/capture\n\n{\n \"accountId\": \"81c79a2-9bd5-4852-9296-6a24c640f1ef\"\n}\n```\n\nb. For a partial refund of $25:\n```\nPOST https://www.wixapis.com/payments/v3/transactions/71c7932-9bd5-48d2-9196-6df4c640f1ef/capture\n\n{\n \"accountId\": \"81c79a2-9bd5-4852-9296-6a24c640f1ef\",\n \"amount\": 2500\n}\n```\n"},{"displayName":"Disputes Overview","slugifyName":"disputes-overview","content":"## Disputes Overview \n\n**The dispute process involves the following parties**:\n1. **Cardholder**: The owner of the card involved in a transaction.\n2. **Merchant**: The party who sold the goods or services that are under dispute.\n3. **Card Issuer**: The bank that issued the card to the cardholder.\n4. **Acquirer**: The bank tasked with acquiring payment on the merchant's behalf.\n5. **Card Association**: The card brands (Visa, Mastercard, and others) oversee the process.\n\n![Dispute lifecycle](new_dispute_lifecycle.png \"Dispute lifecycle\")\n\n### RFI\nA dispute can be created upon receiving an RFI (Request For Information), which is a preliminary step before a chargeback (no movement of funds).\n\nIt starts with *Open* status - *RFI_OPEN*. In response, the merchant can either refund the payment or upload evidence with clarifications about the purchase. \n\nIf the merchant refunds the payment, the status will be updated to *Refunded*, and the dispute will not be escalated into a chargeback.\n\nIf the merchant provided evidence, the status will be updated to *RFI_UNDER_REVIEW*. \n\nIf the evidence provided proves sufficient, depending on the Card Scheme rules, the status will be updated to *RFI_CLOSED*, which means the RFI has timed out and did not escalate into a chargeback.\n\n### Chargeback\nIn some cases, a chargeback will follow an RFI if it wasn’t resolved at the RFI stage. However, in most cases the dispute is created as a Chargeback right away with the status CHARGEBACK_OPEN, and skips the optional RFI stage. At this point, the funds are deducted from the merchant’s account, and the merchant can’t refund the money on their own.\n\nMerchants have a timeframe of 14-40 days (the time frame is being detected by the card scheme) to submit evidence against the chargeback. If no actions are taken within this timeframe, the chargeback status is updated to *LOST*.\n\nUploading evidence changes the dispute status to *CHARGEBACK_UNDER_REVIEW*. The evidence will be reviewed by the card schemes. The timeframe varies depending on the card scheme, up to 80 days in some cases.\n\nOnce the review is complete, the chargeback status will be updated to **WON** or **LOST**, as decided by the card issuer.\n\n**Dispute statuses**:\n- RFI_OPEN - expecting evidence from the client\n- RFI_UNDER_REVIEW\n- RFI_CLOSED - final status\n- CHARGEBACK_OPEN - expecting evidence from the client\n- CHARGEBACK_UNDER_REVIEW\n- WON - final status\n- LOST - final status\n\n### Responding to disputes using the API\n**Step 1: Find out when a dispute is opened**\n\nRegister the [Transaction Updated Webhook](https://dev.wix.com/api/rest/wix-payments/transactions/transaction-updated-webhook) to receive a transaction object with all the disputes statuses. All the transaction's disputes and their current status will be returned under `updatedEvent` > `currentEntity` > `disputes`.\n\n**Step 2: Decide how to deal with the dispute (accept or submit evidence).**\n\nTo accept the dispute, skip to step 4. To submit evidence, go to step 3.\n\n**Step 3: Respond to the dispute with evidence**\n\nTo respond to the RFI/chargeback, you should upload evidence, associate it with the correct dispute and submit the evidence to the issuing bank.\n\nTo upload evidence:\n\n1. Call [Generate Evidence Upload Url](https://dev.wix.com/api/rest/wix-payments/transactions/generate-evidence-upload-url). \n2. Retrieve the `upload_url` and `upload_token`.\n3. Call the retrieved `upload_url` as an HTTP POST, and pass the `upload_token` as a path parameter.\n\nFor example:\n```\ncurl --location --request POST 'https://wixmp-90ef227251107558e3a6a71f.appspot.com/_ah/upload/test_upload_token_url/' \\\n--form 'upload_token=\"test_upload_token\"' \\\n--form '=@\"/example.pdf\"'\n```\n\n![Evidence Upload](evidence_upload.png \"Evidence Upload\")\n\n\n4. Retrieve the `payload.id` from the JSON response. \nFor example:\n\n```\n{\n \"message\": \"OK\",\n \"code\": 0,\n \"payload\": {\n \"mimeType\": \"image/jpeg\",\n \"hash\": \"5d61d4349e8380b3eaa97e767391dfd9\",\n \"dateCreated\": \"2020-09-04T13:54:12Z\",\n \"id\": \"2411686768ca469dabd7cc64e52c502e\",\n \"path\": \"/tenants/a001a0c3-0ffa-4b76-8a13-aa0df0d7913c/accounts/0f226e8a-3b1f-44de-8f3f-9a4abdab5db3/transactions/a036c\n \"lifecycle\": null,\n \"size\": 3733,\n \"urn\": \"urn:file:2411686768ca469dabd7cc64e52c502e\",\n \"bucket\": null,\n \"acl\": \"private\",\n \"dateUpdated\": \"2020-09-04T13:54:12Z\",\n \"type\": \"-\"\n }\n}\n```\n\n`payload.id` should be passed as `evidence.fileId` below. (in this example, payload.id = \"2411686768ca469dabd7cc64e52c502e\")\n\n> **Important:** The evidence still needs to be associated with the relevant dispute after upload.\n\n5. Call [Add Evidence](https://dev.wix.com/api/rest/wix-payments/transactions/add-evidence) to associate the evidence you uploaded with the relevant dispute. Pass the `disputeId`, `transactionId`, and `accountId` retrieved in step 1, and map the `payload.id` retrieved above to `evidence.fileId`.\n6. When all the evidence has been uploaded and associated with the dispute, call [Submit Evidence](https://dev.wix.com/api/rest/wix-payments/transactions/submit-evidence) to trigger the submission of the evidence to the issuing bank.\n\n**Step 4: Responding to a chargeback by accepting the dispute.**\n\nAccept the dispute by calling [Accept Dispute](https://dev.wix.com/api/rest/wix-payments/transactions/accept-dispute) - relevant only when the dispute status is *CHARGEBACK_OPEN*. This action moves the dispute status to *LOST*.\n\n"}]},"reviewStatus":"APPROVED","isLocked":true}

Submit Evidence

Permission Scopes