Documentation

Webhooks Event Payloads

PPRO sends webhooks to notify you of changes across the payment, agreement, instrument, funds, reporting, and dispute lifecycles. Each webhook includes an eventType that identifies what happened and a payload with the current resource state.

Use this page as a reference for every supported event type and when you should expect to receive it.

The source, id, type, subject, time, specversion, and datacontenttype fields are common to all PPRO webhooks. Each webhook also contains the data object, which exposes different fields depending on the webhook type

Payment charge

Events for a single payment attempt—from creation through authorization, capture, void, and refund.

Event typeWhen you receive it
PAYMENT_CHARGE_CREATEDA new payment charge was created and recorded in PPRO.
PAYMENT_CHARGE_AUTHENTICATION_PENDINGThe payment charge is awaiting consumer authentication before authorization can proceed.
PAYMENT_CHARGE_DISCARDEDAuthentication was not completed in time, or the discard endpoint was called. The payload includes discardType to indicate which case occurred. See the payment method guides for method-specific timeout limits.
PAYMENT_CHARGE_DISCARD_FAILEDThe discard request failed.
PAYMENT_CHARGE_PROVIDER_CONFIRMATION_PENDINGThe authorization request was sent and is awaiting a definitive success or failure from the payment provider (the provider could not respond immediately).
PAYMENT_CHARGE_AUTHORIZATION_SUCCEEDEDAuthorization completed successfully. The payload indicates whether the payment is multi-step and requires a separate capture. If auto-capture was not enabled, send an explicit capture request for multi-step methods.
PAYMENT_CHARGE_AUTHORIZATION_FAILEDAuthorization failed. The payload includes an error object with failure details.
PAYMENT_CHARGE_CAPTURE_SUCCEEDEDThe requested amount was captured successfully.
PAYMENT_CHARGE_CAPTURE_FAILEDCapture failed for the requested amount.
PAYMENT_CHARGE_VOID_SUCCEEDEDThe payment charge was voided, canceling the authorization before capture.
PAYMENT_CHARGE_VOID_FAILEDThe void attempt failed; the authorization remains active.
PAYMENT_CHARGE_REFUND_PENDINGA refund was requested and is awaiting processing by PPRO or the provider.
PAYMENT_CHARGE_REFUND_SUCCEEDEDThe refund was processed successfully.
PAYMENT_CHARGE_REFUND_FAILEDThe refund attempt failed. The payload includes an error object with failure details.
{
  "specversion": "1.0.2",
  "source": "https://www.ppro.com",
  "datacontenttype": "application/json",
  "id": "p2enTSNZMUXf9VJFUqCeq",
  "type": "PAYMENT_CHARGE_CREATED",
  "subject": "charge_df0FELNuG0L6ENt0Wzs4T",
  "time": "2026-04-13T19:40:38.021Z",
  "data": {
    "paymentChargeId": "charge_df0FELNuG0L6ENt0Wzs4T",
    "paymentChargeStatus": "AUTHORIZATION_PROCESSING",
    "paymentMethod": "IDEAL",
    "merchantId": "MERCHANT_ID",
    "merchantPaymentChargeReference": "ABCD-1234-PQRS-5678",
    "type": "PAYMENT_CHARGE_CREATED",
    "paymentMedium": "ECOMMERCE",
    "paymentDescriptor": "Acme Inc - Order No 12345",
    "amount": {
      "value": 10000,
      "currency": "EUR"
    },
    "consumer": {
      "name": "Julia Nowak",
      "email": "[email protected]",
      "country": "NL"
    },
    "authenticationSettings": [
      {
        "settings": {
          "returnUrl": "https://www.ppro.com/"
        },
        "type": "REDIRECT"
      }
    ],
    "instrument": {
      "id": "instr_hlhPqhOoU4unj5cH3uybm",
      "type": "BANK_ACCOUNT"
    }
  }
}
{
  "specversion": "1.0.2",
  "source": "https://www.ppro.com",
  "datacontenttype": "application/json",
  "id": "lul53W0G5GOeL49bko0bo",
  "type": "PAYMENT_CHARGE_AUTHENTICATION_PENDING",
  "subject": "charge_4s20gLu6wxBjTvGZSRq7F",
  "time": "2026-04-13T19:28:13.711Z",
  "data": {
    "paymentChargeId": "charge_4s20gLu6wxBjTvGZSRq7F",
    "paymentChargeStatus": "AUTHENTICATION_PENDING",
    "paymentMethod": "IDEAL",
    "merchantId": "MERCHANT_ID",
    "merchantPaymentChargeReference": "ABCD-1234-PQRS-5678",
    "type": "PAYMENT_CHARGE_AUTHENTICATION_PENDING",
    "authorizationId": "authz_fRKZ98Q040jxxOske3eNq",
    "amount": {
      "value": 10000,
      "currency": "EUR"
    },
    "authenticationMethods": [
      {
        "details": {
          "requestUrl": "https://authman.sandbox.lp-pl.ppro.com/f?redirection_token=eyJhbGciOiJIUzUxMiJ9.eyJzZXNzaW9uIjp7InIiOiJjaGFyZ2VfNHMyMGdMdTZ3eEJqVHZHWlNScTdGIn19.UX9ZNvhLuGThAgIXUA9A5JojcQYcflkeOEvZpL0AVK7qSxdeUTPDcf3b7D55PbQ_wKr9u7caPJ5IIbiOjaMClg",
          "requestMethod": "GET"
        },
        "type": "REDIRECT"
      }
    ]
  }
}
{
  "specversion": "1.0.2",
  "source": "https://www.ppro.com",
  "datacontenttype": "application/json",
  "id": "QVtqk5RsgXl7E0AjOierm",
  "type": "PAYMENT_CHARGE_AUTHORIZATION_SUCCEEDED",
  "subject": "charge_4s20gLu6wxBjTvGZSRq7F",
  "time": "2026-04-13T19:30:15.674Z",
  "data": {
    "paymentChargeId": "charge_4s20gLu6wxBjTvGZSRq7F",
    "paymentChargeStatus": "CAPTURED",
    "paymentMethod": "IDEAL",
    "merchantId": "MERCHANT_ID",
    "merchantPaymentChargeReference": "ABCD-1234-PQRS-5678",
    "type": "PAYMENT_CHARGE_AUTHORIZATION_SUCCEEDED",
    "authorizationId": "authz_OWo9qLp4i5WjaIVxtsewQ",
    "amount": {
      "value": 10000,
      "currency": "EUR"
    },
    "isMultiStep": false
  }
}
{
  "specversion": "1.0.2",
  "source": "https://www.ppro.com",
  "datacontenttype": "application/json",
  "id": "cf58tintUBxm8cvnNnM1S",
  "type": "PAYMENT_CHARGE_CAPTURE_SUCCEEDED",
  "subject": "charge_4s20gLu6wxBjTvGZSRq7F",
  "time": "2026-04-13T19:30:16.729Z",
  "data": {
    "paymentChargeId": "charge_4s20gLu6wxBjTvGZSRq7F",
    "paymentChargeStatus": "CAPTURED",
    "paymentMethod": "IDEAL",
    "merchantId": "MERCHANT_ID",
    "merchantPaymentChargeReference": "ABCD-1234-PQRS-5678",
    "type": "PAYMENT_CHARGE_CAPTURE_SUCCEEDED",
    "captureId": "capture_zlI2krAD8etu6LATynmvU",
    "amount": {
      "value": 10000,
      "currency": "EUR"
    },
    "merchantCaptureReference": "ABCD-1234-PQRS-5678"
  }
}
{
  "source": "https://www.ppro.com",
  "id": "s3BJsvyiYRBJOvQTLk8oa",
  "type": "PAYMENT_CHARGE_DISCARDED",
  "subject": "charge_NlB91cmKbL4v0tUHtho3d",
  "time": "2025-10-27T14:46:11.752Z",
  "data": {
    "paymentChargeId": "charge_NlB91cmKbL4v0tUHtho3d",
    "paymentChargeStatus": "DISCARDED",
    "paymentMethod": "IDEAL",
    "merchantId": "MERCHANT_ID",
    "type": "PAYMENT_CHARGE_DISCARDED",
    "discardType": "MERCHANT_INITIATED_DISCARD",
    "authorizationId": "authz_sLC4hEmEp79zXznsJrQ9O",
    "amount": {
      "value": 1000,
      "currency": "CHF"
    },
    "merchantDiscardReference": "Discard test"
  },
  "specversion": "1.0.2",
  "datacontenttype": "application/json"
}
{
  "source": "https://www.ppro.com",
  "id": "3sReOGKGY6kPTEUH8j8mZ",
  "type": "PAYMENT_CHARGE_VOID_SUCCEEDED",
  "subject": "PAYMENT_CHARGE_VOID_SUCCEEDED",
  "time": "2024-01-08T23:45:39.014Z",
  "data": {
    "paymentChargeId": "charge_75HV7qzznWIN5hIWbmhXw",
    "paymentChargeStatus": "VOIDED",
    "paymentMethod": "IDEAL",
    "merchantId": "MERCHANT_ID",
    "merchantPaymentChargeReference": "YOUR_REFERENCE_HERE",
    "type": "PAYMENT_CHARGE_VOID_SUCCEEDED",
    "voidId": "void_cy0R2EcqD8J1kteCBkHse",
    "amount": {
      "value": 1000,
      "currency": "BRL"
    },
    "merchantVoidReference": "optional_different_refence_for_operation"
  },
  "specversion": "1.0.2",
  "datacontenttype": "application/json"
}
{
  "specversion": "1.0.2",
  "source": "https://www.ppro.com",
  "datacontenttype": "application/json",
  "id": "NfnZIHdNf3OTqRr0ajrzX",
  "type": "PAYMENT_CHARGE_VOID_FAILED",
  "subject": "charge_KaFzYH0ui2B6Tflhjlash",
  "time": "2025-12-17T09:44:47.144Z",
  "data": {
    "paymentChargeId": "charge_KaFzYH0ui2B6Tflhjlash",
    "paymentChargeStatus": "AUTHENTICATION_PENDING",
    "paymentMethod": "IDEAL",
    "merchantId": "MERCHANT_ID",
    "merchantPaymentChargeReference": "YOUR_ORDER_NUMBER",
    "orderReferenceNumber": "ORDER TEST",
    "type": "PAYMENT_CHARGE_VOID_FAILED",
    "voidId": "void_KvXg3HVwrqThIwp04E10X",
    "amount": {
      "value": 89912,
      "currency": "PLN"
    },
    "failure": {
      "failureType": "INTERNAL_DECLINE",
      "failureCode": "NO_AUTHORIZED_AMOUNT",
      "failureMessage": "Unexpected charge status while processing void request: AUTHENTICATION_PENDING"
    },
    "merchantVoidReference": "YOUR_REFUND_REFERENCE"
  }
}
{
  "specversion": "1.0.2",
  "source": "https://www.ppro.com",
  "datacontenttype": "application/json",
  "id": "3yITrEH8M7jp5FnSlCtZ9",
  "type": "PAYMENT_CHARGE_AUTHORIZATION_FAILED",
  "subject": "charge_kupE1TgAZwDHGlFo0ZCgQ",
  "time": "2026-04-13T19:31:55.076Z",
  "data": {
    "paymentChargeId": "charge_kupE1TgAZwDHGlFo0ZCgQ",
    "paymentChargeStatus": "FAILED",
    "paymentMethod": "IDEAL",
    "merchantId": "MERCHANT_ID",
    "merchantPaymentChargeReference": "ABCD-1234-PQRS-5678",
    "type": "PAYMENT_CHARGE_AUTHORIZATION_FAILED",
    "authorizationId": "authz_Rj0LEjpCVo4kyAsbaiegL",
    "amount": {
      "value": 10000,
      "currency": "EUR"
    },
    "failure": {
      "failureType": "PROVIDER_DECLINE",
      "failureCode": "GENERIC_DECLINE",
      "failureMessage": "Generic decline"
    }
  }
}
{
  "specversion": "1.0.2",
  "source": "https://www.ppro.com",
  "datacontenttype": "application/json",
  "id": "aGT3L3P8cbR41ZNCORV45",
  "type": "PAYMENT_CHARGE_CAPTURE_FAILED",
  "subject": "charge_KaFzYH0ui2B6Tflhjlash",
  "time": "2025-12-17T09:43:52.591Z",
  "data": {
    "paymentChargeId": "charge_KaFzYH0ui2B6Tflhjlash",
    "paymentChargeStatus": "AUTHENTICATION_PENDING",
    "paymentMethod": "IDEAL",
    "merchantId": "MERCHANT_ID",
    "merchantPaymentChargeReference": "YOUR_ORDER_NUMBER",
    "orderReferenceNumber": "ORDER TEST",
    "type": "PAYMENT_CHARGE_CAPTURE_FAILED",
    "captureId": "capture_79vKuFCfFeUpqXeucRoag",
    "amount": {
      "value": 123123,
      "currency": "PLN"
    },
    "failure": {
      "failureType": "INTERNAL_DECLINE",
      "failureCode": "NO_AUTHORIZED_AMOUNT",
      "failureMessage": "Unexpected charge status while processing capture request: AUTHENTICATION_PENDING"
    },
    "merchantCaptureReference": "YOUR_CAPTURE_REFERENCE"
  }
}
{
  "source": "https://www.ppro.com",
  "id": "1eyjX7KcrPk7UFz0NuQwj",
  "type": "PAYMENT_CHARGE_REFUND_SUCCEEDED",
  "subject": "PAYMENT_CHARGE_REFUND_SUCCEEDED",
  "time": "2024-01-08T23:18:14.847Z",
  "data": {
    "paymentChargeId": "charge_suhuFV3903klVteuCvDp7",
    "paymentChargeStatus": "REFUNDED",
    "paymentMethod": "IDEAL",
    "merchantId": "MERCHANT_ID",
    "merchantPaymentChargeReference": "YOUR_REFERENCE_HERE",
    "type": "PAYMENT_CHARGE_REFUND_SUCCEEDED",
    "refundId": "refund_xAlYloaS9RSAdzSFB5fJh",
    "amount": {
      "value": 1000,
      "currency": "EUR"
    },
    "merchantRefundReference": "optional_set_different_reference_for_operation"
  },
  "specversion": "1.0.2",
  "datacontenttype": "application/json"
}
{
  "specversion": "1.0.2",
  "source": "https://www.ppro.com",
  "datacontenttype": "application/json",
  "id": "BwkDaHlMeFGJpDuFQyqRP",
  "type": "PAYMENT_CHARGE_REFUND_FAILED",
  "subject": "charge_kupE1TgAZwDHGlFo0ZCgQ",
  "time": "2026-04-13T19:32:57.124Z",
  "data": {
    "paymentChargeId": "charge_kupE1TgAZwDHGlFo0ZCgQ",
    "paymentChargeStatus": "FAILED",
    "paymentMethod": "IDEAL",
    "merchantId": "MERCHANT_ID",
    "merchantPaymentChargeReference": "ABCD-1234-PQRS-5678",
    "type": "PAYMENT_CHARGE_REFUND_FAILED",
    "refundId": "refund_lcjKavXFR8GJWxqbUb004",
    "amount": {
      "value": 10,
      "currency": "EUR"
    },
    "failure": {
      "failureType": "INTERNAL_DECLINE",
      "failureCode": "NO_CAPTURED_AMOUNT",
      "failureMessage": "Unexpected charge status while processing refund request: FAILED"
    },
    "merchantRefundReference": "74a6d7bd-84bd-4318-92a7-aeaa4f3c941c"
  }
}
{
  "specversion": "1.0.2",
  "source": "https://www.ppro.com",
  "datacontenttype": "application/json",
  "id": "HCrrl1F7SgJsijAJ1cpgW",
  "type": "PAYMENT_CHARGE_REFUND_PENDING",
  "subject": "charge_K3ATK7gpkLUNm0eFNGMCF",
  "time": "2026-04-13T19:33:49.319Z",
  "data": {
    "paymentChargeId": "charge_K3ATK7gpkLUNm0eFNGMCF",
    "paymentChargeStatus": "CAPTURED",
    "paymentMethod": "IDEAL",
    "merchantId": "MERCHANT_ID",
    "merchantPaymentChargeReference": "ABCD-1234-PQRS-5678",
    "type": "PAYMENT_CHARGE_REFUND_PENDING",
    "refundId": "refund_i6fWj9BPMijOL1FS4RDUX",
    "amount": {
      "value": 10,
      "currency": "EUR"
    },
    "merchantRefundReference": "de45b2b8-1a1f-456b-9349-b4ec2b26bfe2"
  }
}

Payment agreement

Events for recurring or mandate-based payment agreements.

Event typeWhen you receive it
PAYMENT_AGREEMENT_CREATEDA new payment agreement was created and recorded in PPRO.
PAYMENT_AGREEMENT_AUTHENTICATION_PENDINGThe consumer must complete additional authentication before the agreement becomes active.
PAYMENT_AGREEMENT_ACTIVEThe agreement is active and can be used for subsequent payment charges.
PAYMENT_AGREEMENT_FAILEDAgreement setup failed—typically because details could not be validated by PPRO or the provider, or limits were exceeded.
PAYMENT_AGREEMENT_REVOKED_BY_CONSUMERThe consumer canceled the subscription or mandate through their payment app or bank.
PAYMENT_AGREEMENT_REVOKED_BY_MERCHANTThe merchant revoked the agreement, canceling future scheduled or merchant-initiated charges.
PAYMENT_AGREEMENT_REVOKED_BY_PROVIDERThe provider or scheme revoked the agreement, typically for compliance or regulatory reasons.
{
  "specversion": "1.0.2",
  "source": "https://www.ppro.com",
  "datacontenttype": "application/json",
  "id": "mTF3uW83S6nG3uBr1npsx",
  "type": "PAYMENT_AGREEMENT_CREATED",
  "subject": "agr_zFfuEHbCLxUBVa6rU7YJf",
  "time": "2026-04-13T19:41:56.310Z",
  "data": {
    "paymentAgreementId": "agr_zFfuEHbCLxUBVa6rU7YJf",
    "paymentAgreementStatus": "INITIALIZING",
    "paymentMethod": "IDEAL",
    "type": "PAYMENT_AGREEMENT_CREATED",
    "merchantId": "MERCHANT_ID",
    "instrument": {
      "id": "instr_k9aBvxESa1pCcHXD1839s",
      "type": "BANK_ACCOUNT",
      "details": {
        "debitMandateId": "ADOBE-12345-Photoshop"
      }
    },
    "startDate": "2026-04-13T19:41:55.049Z",
    "amount": {
      "value": 1500,
      "currency": "EUR"
    },
    "consumer": {
      "country": "NL"
    }
  }
}
{
  "specversion": "1.0.2",
  "source": "https://www.ppro.com",
  "datacontenttype": "application/json",
  "id": "N4LQXJWscXIUQtwsQy110",
  "type": "PAYMENT_AGREEMENT_AUTHENTICATION_PENDING",
  "subject": "agr_zFfuEHbCLxUBVa6rU7YJf",
  "time": "2026-04-13T19:41:57.381Z",
  "data": {
    "paymentAgreementId": "agr_zFfuEHbCLxUBVa6rU7YJf",
    "paymentAgreementStatus": "AUTHENTICATION_PENDING",
    "paymentMethod": "IDEAL",
    "type": "PAYMENT_AGREEMENT_AUTHENTICATION_PENDING",
    "merchantId": "MERCHANT_ID",
    "authenticationMethods": [
      {
        "details": {
          "requestUrl": "https://authman.sandbox.lp-pl.ppro.com/f?redirection_token=eyJhbGciOiJIUzUxMiJ9.eyJzZXNzaW9uIjp7InIiOiJjaGFyZ2VfaXlBU2hmT09wMUpwR1dwaVlGSVg0In19.EkGk8nyeZGDnpZMfX8rL8tGbK91V7DbdxHt5ieYh1u_CPStTGV6rF9bQYWtzXrUYhHWmRfu0LPEIDJRT4-SFaA",
          "requestMethod": "GET"
        },
        "type": "REDIRECT"
      }
    ]
  }
}
{
  "specversion": "1.0.2",
  "source": "https://www.ppro.com",
  "datacontenttype": "application/json",
  "id": "j1xXZXzOiBPygTuNZa5vD",
  "type": "PAYMENT_AGREEMENT_ACTIVE",
  "subject": "agr_zFfuEHbCLxUBVa6rU7YJf",
  "time": "2026-04-13T19:43:14.013Z",
  "data": {
    "paymentAgreementId": "agr_zFfuEHbCLxUBVa6rU7YJf",
    "paymentAgreementStatus": "ACTIVE",
    "paymentMethod": "IDEAL",
    "type": "PAYMENT_AGREEMENT_ACTIVE",
    "merchantId": "MERCHANT_ID"
  }
}
{
    "specversion": "1.0.2",
    "source": "global-payment-gateway/0.0.0",
    "datacontenttype": "application/json",
    "id": "060ac805cf0b0455a9a92",
    "type": "PAYMENT_AGREEMENT_FAILED",
    "subject": "PAYMENT_AGREEMENT_FAILED",
    "time": "2022-11-03T11:23:47.123Z",
    "data": {
      "paymentAgreementId": "agr_FlTZQyHL4DeUYLYtXmOdq",
      "paymentAgreementStatus": "FAILED",
      "type": "PAYMENT_AGREEMENT_FAILED",
      "merchantId": "MERCHANT_ID",
      "failure": {
        "failureType": "PROVIDER_ERROR",
        "failureCode": "internal-failure-code",
        "providerFailureCode": "provider-failure-code",
        "failureMessage": "Failed to authorize agreement"
      }
    }
  }
{
  "source": "https://www.ppro.com",
  "id": "0OyISq3CF24QAeTPTie8T",
  "type": "PAYMENT_AGREEMENT_REVOKED_BY_CONSUMER",
  "subject": "PAYMENT_AGREEMENT_REVOKED_BY_CONSUMER",
  "time": "2024-01-10T10:57:10.403Z",
  "data": {
    "paymentAgreementId": "agr_f8MckPveVACvBfzkHLdMB",
    "paymentAgreementStatus": "REVOKED",
    "type": "PAYMENT_AGREEMENT_REVOKED_BY_CONSUMER",
    "merchantId": "MERCHANT_ID",
  },
  "specversion": "1.0.2",
  "datacontenttype": "application/json"
}
{
  "specversion": "1.0.2",
  "source": "https://www.ppro.com",
  "datacontenttype": "application/json",
  "id": "4PzCrXlq2JJl4W4eVUwv3",
  "type": "PAYMENT_AGREEMENT_REVOKED_BY_MERCHANT",
  "subject": "agr_zFfuEHbCLxUBVa6rU7YJf",
  "time": "2026-04-13T19:44:34.220Z",
  "data": {
    "paymentAgreementId": "agr_zFfuEHbCLxUBVa6rU7YJf",
    "paymentAgreementStatus": "REVOKED_BY_MERCHANT",
    "paymentMethod": "IDEAL",
    "type": "PAYMENT_AGREEMENT_REVOKED_BY_MERCHANT",
    "merchantId": "MERCHANT_ID"
  }
}
{
  "specversion": "1.0.2",
  "source": "https://www.ppro.com",
  "datacontenttype": "application/json",
  "id": "4PzCrXlq2JJl4W4eVUwv3",
  "type": "PAYMENT_AGREEMENT_REVOKED_BY_PROVIDER",
  "subject": "agr_zFfuEHbCLxUBVa6rU7YJf",
  "time": "2026-04-13T19:44:34.220Z",
  "data": {
    "paymentAgreementId": "agr_zFfuEHbCLxUBVa6rU7YJf",
    "paymentAgreementStatus": "REVOKED_BY_MERCHANT",
    "paymentMethod": "IDEAL",
    "type": "PAYMENT_AGREEMENT_REVOKED_BY_MERCHANT",
    "merchantId": "MERCHANT_ID"
  }
}

Payment instrument

Events for stored payment methods (for example, cards or bank accounts).

Event typeWhen you receive it
PAYMENT_INSTRUMENT_CREATEDA new payment instrument was created and securely stored.
PAYMENT_INSTRUMENT_DETAILS_UPDATEDInstrument details were updated—either by an explicit merchant request or automatically when PPRO receives updated information from the provider or scheme.
PAYMENT_INSTRUMENT_DELETEDA stored payment instrument was permanently removed and can no longer be used for payment charges.
{
  "source": "https://www.ppro.com",
  "id": "PFDkXMQe1CFqcECSH89di",
  "type": "PAYMENT_INSTRUMENT_DETAILS_UPDATED",
  "subject": "PAYMENT_INSTRUMENT_DETAILS_UPDATED",
  "time": "2025-05-26T07:31:47.767Z",
  "data": {
    "paymentInstrumentId": "instr_FlTZQyHL4DeUYLYtXmOdq",
    "updateTimestamp": "2025-05-26T07:31:47.123Z",
    "merchantId": "MERCHANT_ID",
    "details": {
      "type": "CARD_PPRO_VAULTED",
      "details": {
        "brand": "VISA",
        "bin": "44443333",
        "last4Digits": "1111",
        "expiryMonth": 1,
        "expiryYear": 2030,
        "holderName": "John Doe",
        "panAlias": "ppro_tkn_06cf6d1",
        "isCvvPresent": false
    },
  },
  "specversion": "1.0.2",
  "datacontenttype": "application/json"
}

Fund state

Event typeWhen you receive it
FUNDS_STATE_CHANGEDThe funds status of a capture or refund was updated—when PPRO received captured funds from the scheme, or when refunded funds were sent back to the consumer.
{
  "source": "https://www.ppro.com",
  "id": "PFDkXMQe1CFqcECSH89di",
  "type": "FUNDS_STATE_CHANGED",
  "subject": "FUNDS_STATE_CHANGED",
  "time": "2024-01-08T23:56:10.106Z",
  "data": {
    "paymentChargeId": "charge_5fZInvMbTGGNvMaaXJYsK",
    "merchantId": "MERCHANT_ID",
    "paymentChargeStatus": "CAPTURE_PENDING",
    "paymentMethod": "CARD",
    "merchantPaymentChargeReference": "YOUR_REFERENCE_HERE",
    "type": "FUNDS_STATE_CHANGED",
    "fundsState": "FUNDS_RECEIVED",
    "fundsStateChangedTimestamp": "2024-01-08T23:56:09.106Z",
    "captureId": "capture_bHuFnULwQCSGcar1beMVt",
    "amount": {
      "value": 1000,
      "currency": "BRL"
    },
  },
  "specversion": "1.0.2",
  "datacontenttype": "application/json"
}

Report

Events for asynchronously generated report files.

Event typeWhen you receive it
REPORT_PROCESSEDThe report was generated successfully and is ready to download via downloadUrl.
REPORT_FAILEDReport generation failed. The payload may include failure details.
REPORT_EXPIREDThe report download link has expired and is no longer accessible.
{
    "source": "gpg-payment-reports/0.0.0",
    "id": "0OyISq3CF27GAeTPTie8T",
    "type": "REPORT_PROCESSED",
    "subject": "REPORT_PROCESSED",
    "time": "2022-11-03T11:23:47.123Z",
    "specversion": "1.0.2",
    "datacontenttype": "application/json",
    "data": {
      "reportId": "report_0OyISq3CF24QAeTPTd48T",
      "merchantId": "MERCHANT_ID",
      "status": "PROCESSED",
      "operationType": "CAPTURE",
      "startDate": "2023-01-10T10:57:10.403Z",
      "endDate": "2024-01-10T10:57:10.403Z",
      "downloadUrl": "http://payment-reports-bucket/...",
      "contentLength": "${contentLength}",
      "type": "REPORT_PROCESSED"
    }
  }
{
    "source": "gpg-payment-reports/0.0.0",
    "id": "0OyISq3CF24TAeTPTie8T",
    "type": "REPORT_EXPIRED",
    "subject": "REPORT_EXPIRED",
    "time": "2022-11-03T11:23:47.123Z",
    "specversion": "1.0.2",
    "datacontenttype": "application/json",
    "data": {
      "reportId": "report_0OyISq3CF24QAeTPTd48T",
      "merchantId": "MERCHANT_ID",
      "status": "EXPIRED",
      "operationType": "CAPTURE",
      "startDate": "2023-01-10T10:57:10.403Z",
      "endDate": "2024-01-10T10:57:10.403Z",
      "type": "REPORT_EXPIRED"
    }
  }
{
    "source": "gpg-payment-reports/0.0.0",
    "id": "0OyISq3H627GAeTPTie8T",
    "type": "REPORT_FAILED",
    "subject": "REPORT_FAILED",
    "time": "2022-11-03T11:23:47.123Z",
    "specversion": "1.0.2",
    "datacontenttype": "application/json",
    "data": {
      "reportId": "report_0OyISq3CF24QAeTPTd48T",
      "merchantId": "MERCHANT_ID",
      "status": "FAILED",
      "operationType": "CAPTURE",
      "startDate": "2023-01-10T10:57:10.403Z",
      "endDate": "2024-01-10T10:57:10.403Z",
      "type": "REPORT_FAILED"
    }
  }

Dispute

Events for chargebacks and disputes after they enter the formal dispute flow.

Event typeWhen you receive it
DISPUTE_ACTION_REQUIREDA new dispute was created and requires your action.
DISPUTE_ACCEPT_PROCESSINGYou accepted the dispute.
DISPUTE_CHALLENGE_PROCESSINGYou submitted a challenge with evidence.
DISPUTE_UNDER_REVIEWThe provider or consumer is reviewing the evidence.
DISPUTE_WONThe dispute was resolved in the merchant's favor.
DISPUTE_LOSTThe dispute was resolved in the consumer's favor.
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "DISPUTE_OPEN",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "DISPUTE",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
  }
}
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "DISPUTE_ACCEPT_PROCESSING",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "DISPUTE",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
  }
}
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "DISPUTE_CHALLENGE_PROCESSING",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "DISPUTE",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
  }
}
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "DISPUTE_UNDER_REVIEW",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "DISPUTE",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
  }
}
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "DISPUTE_WON",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "DISPUTE",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
  }
}
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "DISPUTE_LOST",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "DISPUTE",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
  }
}
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "DISPUTE_UPDATED",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "DISPUTE",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
  }
}

Pre-dispute

Events for pre-dispute programs (for example, early resolution before a formal chargeback).

Event typeWhen you receive it
PRE_DISPUTE_ACTION_REQUIREDA new pre-dispute was created and requires your action.
PRE_DISPUTE_ACCEPT_PROCESSINGYou accepted the pre-dispute.
PRE_DISPUTE_CHALLENGE_PROCESSINGYou submitted a challenge with evidence.
PRE_DISPUTE_OFFER_PROCESSINGYou submitted a custom offer.
PRE_DISPUTE_UNDER_REVIEWThe provider or consumer is reviewing the evidence.
PRE_DISPUTE_OFFER_ACCEPTEDThe consumer accepted your custom offer.
PRE_DISPUTE_OFFER_REJECTEDThe consumer rejected your custom offer.
PRE_DISPUTE_WONThe pre-dispute was resolved in the merchant's favor.
PRE_DISPUTE_LOSTThe pre-dispute was resolved in the consumer's favor.
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "PRE_DISPUTE_OPEN",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "PRE_DISPUTE",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
  }
}
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "PRE_DISPUTE_ACCEPT_PROCESSING",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "PRE_DISPUTE",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
  }
}
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "PRE_DISPUTE_CHALLENGE_PROCESSING",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "PRE_DISPUTE",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
  }
}
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "PRE_DISPUTE_OFFER_PROCESSING",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "PRE_DISPUTE",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
  }
}
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "PRE_DISPUTE_UNDER_REVIEW",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "PRE_DISPUTE",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
  }
}
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "PRE_DISPUTE_OFFER_ACCEPTED",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "PRE_DISPUTE",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
  }
}
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "PRE_DISPUTE_OFFER_REJECTED",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "PRE_DISPUTE",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****"
  }
}
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "PRE_DISPUTE_WON",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "PRE_DISPUTE",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****"
  }
}
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "PRE_DISPUTE_LOST",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "PRE_DISPUTE",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****"
  }
}
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "PRE_DISPUTE_UPDATED",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "PRE_DISPUTE",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
  }
}

Arbitration

{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "ARBITRATION_OPEN",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "ARBITRATION",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
  }
}
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "ARBITRATION_ACCEPT_PROCESSING",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "ARBITRATION",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
  }
}
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "ARBITRATION_CHALLENGE_PROCESSING",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "ARBITRATION",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
  }
}
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "ARBITRATION_UNDER_REVIEW",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "ARBITRATION",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
  }
}
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "ARBITRATION_WON",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "ARBITRATION",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
  }
}
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "ARBITRATION_LOST",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "ARBITRATION",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
  }
}
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "ARBITRATION_UPDATED",
  "subject": "dispute_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
    "eventId": "event_*****",
    "disputeId": "dispute_*****",
    "phase": "ARBITRATION",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
  }
}

Chargebacks

{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "CHARGEBACK_CREATED",
  "subject": "cb_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
		"eventId": "event_*****",
    "entityId": "cb_*****",
    "disputeId": "dispute_*****",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
    "type": "CHARGEBACK_CREATED",
    "generatedAt": "2025-10-23T10:15:30Z"
  }
}
{
  "source": "https://www.ppro.com",
  "id": "event_*****",
  "type": "CHARGEBACK_REVERSAL_CREATED",
  "subject": "cr_*****",
  "time": "2025-10-23T10:15:30Z",
  "specversion": "1.0.2",
  "datacontenttype": "application/json",
  "data": {
		"eventId": "event_*****",
    "entityId": "cr_*****",
    "disputeId": "dispute_*****",
    "paymentChargeId": "charge_*****",
    "merchantPaymentChargeReference": "txp_*****",
    "merchantId": "123***",
    "type": "CHARGEBACK_REVERSAL_CREATED",
    "generatedAt": "2025-10-23T10:15:30Z"
  }
}