> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # Package: wixPaymentsProvider # Namespace: transactions # Webhook link: https://dev.wix.com/docs/api-reference/business-management/payments/wix-payments-provider/transactions/transaction-updated.md ## Introduction # Webhook Permissions Scopes IDs: Manage Transactions: SCOPE.DC-PAYMENTS.MANAGE-TRANSACTIONS --- ## REST API ### Schema ``` Webhook: Transaction Updated Description: Event body: - name: id | type: string | description: Unique event ID. Allows clients to ignore duplicate events. - name: entityFqdn | type: string | description: Fully qualified domain name of the entity associated with the event. - name: slug | type: string | description: Event name. - name: entityId | type: string | description: ID of the entity associated with the event. - name: eventTime | type: string (date-time) | description: Event timestamp. - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application such as GDPR. - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event. - name: updatedEvent | type: object | description: Updated event details. - name: currentEntity | type: Transaction | description: The entity after the update. - name: id | type: string | description: Wix Payments transaction GUID. - name: currency | type: string | description: Payment currency according to ISO 4217. For example: USD, EUR, GBP. - name: capturableAmount | type: number | description: Amount that can be captured or voided in minor units. Usually matches authorization amount when the transaction has been authorized but not captured. - name: refundableAmount | type: number | description: Amount that can be refunded in minor units. Usually matches capture amount when the transaction has been captured but not refunded or charged back. - name: externalInvoiceId | type: string | description: Invoice GUID provided by the external entity that initiated the transaction. - name: externalOrderId | type: string | description: Order GUID provided by the external entity that initiated the transaction. - name: externalTransactionId | type: string | description: Transaction GUID provided by external entity. - name: providerTransactionId | type: string | description: Transaction GUID provided by the payment provider. - name: metadata | type: object | description: Metadata stored when the transaction is created. - name: authorization | type: Authorization | description: Transaction authorization information. - ONE-OF: - name: getMethodRedirect | type: GetMethodRedirect | description: Next action: browser should issue an HTTP GET request and render the result. - name: url | type: string | description: Encoded URL to perform an HTTP GET request. - name: postMethodRedirect | type: PostMethodRedirect | description: Next action: browser should issue an HTTP POST request and render the result. - name: url | type: string | description: Encoded URL to perform an HTTP POST request. - name: fields | type: array | description: Non-encoded form fields to send with the POST request using the application/x-www-form-urlencoded content type. - name: name | type: string | description: Field name (not encoded). - name: value | type: string | description: Field value (not encoded). - name: barcodeDisplay | type: BarcodeDisplay | description: Next action: browser should show a barcode or a url to a barcode to continue payment. - name: barcode | type: string | description: Barcode. - name: barcodeUrl | type: string | description: Barcode URL. - name: expirationDate | type: string | description: Expiration timestamp. - name: qrCodeDisplay | type: QrCodeDisplay | description: Next action: browser should show a QR code to continue payment. - name: payload | type: string | description: QR code raw text payload. You can use any QR code generator library to convert it to an image. To see more details read [this article](https://www.thonky.com/qr-code-tutorial/introduction). - name: expirationDate | type: string | description: Expiration timestamp. - name: payPalWindow | type: PayPalWindow | description: Next action: browser should issue a PayPal express checkout - name: payPalOrderId | type: string | description: Order Id for initiating PayPal express flow - name: amount | type: number | description: Authorization amount in minor units, for example, cents. - name: status | type: AuthorizationStatus | description: Authorization status. - enum: UNDEFINED, PROCESSING, DECLINED, SUCCEEDED, CANCELED, NEEDS_ACTION, PENDING - name: statusReason | type: StatusReason | description: Detailed reason for current authorization status when available. Value is empty for approved transactions. - name: code | type: string | description: Reason code. - name: message | type: string | description: Free-text description. - name: providerResponse | type: string | description: Original response code from the issuer or card scheme. - name: networkReference | type: NetworkReference | description: Transaction reference provided by a payment network. - name: networkTransactionId | type: string | description: Transaction GUID assigned by a card scheme (Trace GUID for Mastercard or Transaction GUID for Visa). - name: dsTransactionId | type: string | description: Transaction GUID assigned by 3D Secure 2 directory server. - name: transactionLinkId | type: string | description: Transaction Link Identifier assigned by Mastercard. - name: authCode | type: string | description: Authorization code sent by a card issuer. - name: captures | type: array | description: Captures issued for the transaction. - name: id | type: string | description: Capture GUID. - name: amount | type: number | description: Capture amount in minor units, for example, cents. - name: status | type: CaptureStatus | description: Capture status. - enum: UNDEFINED, PENDING, FAILED, SUCCEEDED, REVERSED - name: statusReason | type: StatusReason | description: Detailed reason for current capture status. Value is empty for approved transactions. - name: externalCaptureId | type: string | description: Capture GUID provided by the external entity that initiated the capture. - name: providerCaptureId | type: string | description: Capture GUID provided by the payment provider that initiated the capture. - name: metadata | type: object | description: Metadata stored when the capture was created. - name: refunds | type: array | description: Refunds issued for the transaction. - name: id | type: string | description: Refund GUID. - name: amount | type: number | description: Refund amount in minor units, e.g. cents. - name: reason | type: TransactionModificationReason | description: Reason for refund. - enum: OTHER, FRAUD, COMPLIANCE, DUPLICATE_PAYMENT, ABANDONED_PAYMENT, MERCHANT_REQUEST, BUYER_REQUEST - name: status | type: RefundStatus | description: Refund status. - enum: UNDEFINED, PENDING, FAILED, SUCCEEDED, REVERSED, CANCELED - name: statusReason | type: StatusReason | description: Detailed reason for current refund status. Value is empty for approved transactions. - name: externalRefundId | type: string | description: Refund GUID provided by the external entity that initiated the refund. - name: providerRefundId | type: string | description: Refund GUID provided by the payment provider that initiated the refund. - name: metadata | type: object | description: Metadata stored when the refund was created. - name: disputes | type: array | description: Disputes initiated for the transaction. - name: id | type: string | description: Dispute GUID. - name: amount | type: string | description: Dispute amount in minor units, for example, cents. - name: reason | type: DisputeReason | description: Reason for dispute. - enum: OTHER, FRAUD_CARD_PRESENT, FRAUD_CARD_ABSENT, DUPLICATE_PROCESSING, SERVICES_NOT_PROVIDED, CANCELED_RECURRING, NOT_AS_DESCRIBED, COUNTERFEIT, MISREPRESENTATION, CANCELED - name: networkReasonCode | type: string | description: Reason code for dispute from card network if present - name: status | type: DisputeStatus | description: Dispute status. - 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 - name: statusReason | type: StatusReason | description: Detailed reason for current refund status. - name: providerDisputeId | type: string | description: Dispute GUID provided by the payment provider that initiated the dispute. - name: rfi | type: RfiTiming | description: Date/time frames for RFI (request for information) flow. - name: openingDate | type: string | description: RFI (request for information) received date. - name: evidenceSubmissionDeadlineDate | type: string | description: Evidence submission deadline. - name: daysToResolution | type: integer | description: Number of days between evidence submission and final decision for a dispute. - name: evidenceSubmissionDate | type: string | description: Date for evidence submission. - name: resolutionDate | type: string | description: Date that RFI resolution occurred (final dispute status). - name: chargeback | type: ChargebackTiming | description: Date/time frames for chargeback flow. - name: openingDate | type: string | description: Chargeback received date. - name: evidenceSubmissionDeadlineDate | type: string | description: Evidence submission deadline. - name: daysToResolution | type: integer | description: Number of days between evidence submission and final decision for a dispute. - name: evidenceSubmissionDate | type: string | description: Date for evidence submission. - name: resolutionDate | type: string | description: Date a dispute was lost (accepted, expired, etc.) or date of dispute final resolution. - name: preArbitration | type: PreArbitrationTiming | description: Date/time frames for pre-arbitration flow. - name: openingDate | type: string | description: Pre arbitration (request for information) received date. - name: resolutionDate | type: string | description: Date that Pre arbitration resolution occurred (final dispute status). - name: voids | type: array | description: Voids issued for the transaction. - name: id | type: string | description: Void GUID. - name: reason | type: TransactionModificationReason | description: Void reason. - enum: OTHER, FRAUD, COMPLIANCE, DUPLICATE_PAYMENT, ABANDONED_PAYMENT, MERCHANT_REQUEST, BUYER_REQUEST - name: status | type: VoidStatus | description: Void status. - enum: UNDEFINED, PENDING, FAILED, SUCCEEDED - name: statusReason | type: StatusReason | description: Detailed reason for current void status. - name: externalVoidId | type: string | description: Void GUID provided by the external entity. - name: providerVoidId | type: string | description: Void GUID provided by the payment provider. - name: metadata | type: object | description: Metadata stored when the void was initiated. - name: accountId | type: string | description: Wix Payments account GUID. - name: accountProfileId | type: string | description: Wix Payments account profile GUID. - name: paymentMethod | type: PaymentMethod | description: Payment method used for payment. - ONE-OF: - name: card | type: CardPaymentInfo | description: Credit card payment data. - name: bin | type: string | description: Credit card's BIN (Bank Identification Number). - name: lastDigits | type: string | description: The last 4 digits of the card number. - name: expiryMonth | type: integer | description: Card expiration month. - name: expiryYear | type: integer | description: Card expiration year (4 digits, for example, 2022, 2025). - name: holderName | type: string | description: Cardholder name printed on the card. - name: brandId | type: string | description: Card issuer's brand. Supported values are `MasterCard`, `Visa`, `Electron`, `Amex`, `Diners`, `Discover`, `Jcb`, `ChinaUnionPay`, `Maestro`, `CartesBancaires`. - name: sofort | type: SofortPaymentInfo | description: SOFORT bank transfer payment data. - name: bankAccountOwnerName | type: string | description: Name of the bank account owner. - name: iban | type: string | description: International bank account number. - name: ibanLastDigits | type: string | description: International bank account number last 4 digits for display. - name: payPal | type: PayPalPaymentInfo | description: PayPal account used for payment. - name: payerId | type: string | description: PayPal-assigned payer GUID. - name: email | type: string | description: Payer email address. - name: fundingSource | type: string | description: PayPal funding source e.g. `paypal`, `venmo`. - name: cardReader | type: CardReaderInfo | description: Card Reader payment method. - name: readerToken | type: string | description: Card reader token. - name: network | type: string | description: Card reader network - name: lastDigits | type: string | description: The last 4 digits of the card number. - name: expiryMonth | type: integer | description: Card expiration month. - name: expiryYear | type: integer | description: Card expiration year (4 digits, for example, 2022, 2025). - name: holderName | type: string | description: Cardholder name printed on the card. - name: brandId | type: string | description: Card issuer's brand. Supported values are `MasterCard`, `Visa`, `Electron`, `Amex`, `Diners`, `Discover`, `Jcb`, `ChinaUnionPay`, `Maestro`, `CartesBancaires`. - name: receipt | type: CardReaderReceipt | description: Card reader receipt - name: applicationCryptogram | type: string | description: cryptogram generated by the integrated circuit chip. - name: applicationPreferredName | type: string | description: Mnenomic of the Application Identifier. - name: authorizationCode | type: string | description: Identifier for this transaction. - name: dedicatedFileName | type: string | description: Similar to the application identifier stored on the integrated circuit chip. - name: tapToPay | type: TapToPayInfo | description: Tap to pay payment method. - name: readerToken | type: string | description: Tap to pay reader token. - name: network | type: string | description: Tap to pay payment card network - name: typeId | type: string | description: Type GUID of payment method used. Supported values are `creditCard`, `cardReader`, `ach`, `applePay`, `boleto`, `giropay`, `iDeal`, `payPal`, `pix`, `sepa`, `sofort`, 'tapToPay', `razorpay`. - name: displayName | type: string | description: Payment method display name. Can be masked card number or IBAN, wallet owner email address, etc. - name: notificationOfFraud | type: NotificationOfFraud | description: Visa TC40 and Mastercard SAFE notifications. - name: reason | type: NotificationOfFraudReason | description: Fraud notification reason. - enum: CARD_NEVER_RECEIVED, FRAUDULENT_CARD_APPLICATION, MADE_WITH_COUNTERFEIT_CARD, MADE_WITH_LOST_CARD, MADE_WITH_STOLEN_CARD, MISCELLANEOUS, UNAUTHORIZED_USE_OF_CARD, FRAUD, ACCOUNT_TAKEOVER_FRAUD, CARD_NOT_PRESENT_FRAUD, MULTIPLE_IMPRINT_FRAUD, BUST_OUT_COLLUSIVE_MERCHANT, FRAUDULENT_USE_OF_ACCOUNT_NUMBER, INCORRECT_PROCESSING, MERCHANT_MISREPRESENTATION, ACQUIRER_REPORTED_COUNTERFEIT - name: receiveDate | type: string | description: Notification issue date. - name: billingAddress | type: AddressDetails | description: Billing address. - name: address | type: Address | description: Physical address. - ONE-OF: - name: streetAddress | type: StreetAddress | description: Street name and number. - name: number | type: string | description: Street number. - name: name | type: string | description: Street name. - name: addressLine | type: string | description: Main address line, usually street and number as free text. - name: country | type: string | description: Country code. - name: subdivision | type: string | description: Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY - name: city | type: string | description: City name. - name: postalCode | type: string | description: Zip/postal code. - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. - name: contactDetails | type: FullAddressContactDetails | description: Contact details. - name: firstName | type: string | description: Contact's first name. - name: lastName | type: string | description: Contact's last name. - name: phone | type: string | description: Contact's phone number. - name: company | type: string | description: Contact's company name. - name: email | type: string | description: Email associated with the address. - name: vatId | type: VatId | description: Tax info. Currently usable only in Brazil. - name: id | type: string | description: Customer's tax GUID. - name: type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations - enum: - UNSPECIFIED: - CPF: CPF - for individual tax payers. - CNPJ: CNPJ - for corporations - name: shippingAddress | type: AddressDetails | description: Shipping address. ``` ### Examples ```curl { "id": "245ff9b5-8a34-43bf-97ab-35337250d7b2", "entityFqdn": "wix.payments.transactions.v3.transaction", "slug": "updated", "entityId": "4f68983f-9b70-438e-8130-4fff0b97cf48", "updatedEvent": { "currentEntity": { "id": "4f68983f-9b70-438e-8130-4fff0b97cf48", "currency": "USD", "capturableAmount": "0", "refundableAmount": "0", "providerTransactionId": "pi_1H83lWAaXaGogcA7gt5WsjjP", "metadata": { "metadataKey": "metadataValue" }, "authorization": { "amount": "200", "status": "SUCCEEDED", "networkReference": { "networkTransactionId": "WvTnyhZlYER07Ate" }, "authCode": "123456" }, "captures": [ { "id": "4f68983f-9b70-438e-8130-4fff0b97cf48", "amount": "200", "status": "SUCCEEDED", "metadata": {} } ], "refunds": [ { "id": "1dd0bfdc-bf5d-47cb-8d9b-bc2c6d6591d6", "amount": "200", "reason": "BUYER_REQUEST", "status": "SUCCEEDED", "providerRefundId": "re_1H83mOAaXaGogcA7QYx89USb", "metadata": {} } ], "disputes": [], "voids": [], "accountId": "6f82b2ce-2a15-4bd7-84b5-392c74b3719c", "paymentMethod": { "typeId": "creditCard" } } }, "eventTime": "2021-02-03T01:02:03.456789Z", "triggeredByAnonymizeRequest": false } ``` ---