{"openapi":"3.1.0","info":{"title":"Webhooks","version":"v1"},"tags":[{"name":"Payment Agreements"},{"name":"Chargebacks"},{"name":"Payment Charges"},{"name":"Fund Statuses"},{"name":"Payment Instruments"},{"name":"Payment Reports"}],"components":{"schemas":{"AgreementActiveEventRequestDetails":{"properties":{"paymentAgreementId":{"type":"string","description":"The payment agreement ID","example":"agr_BlTZQyHL9DeUYPYtXmOdq"},"paymentAgreementStatus":{"type":"string","description":"The payment agreement status","enum":["INITIALIZING","AUTHENTICATION_PENDING","ACTIVE","REVOKED_BY_CONSUMER","REVOKED_BY_MERCHANT","REVOKED_BY_PROVIDER","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment agreement","example":"IDEAL"},"type":{"type":"string","description":"The payment agreement event type","example":"PAYMENT_AGREEMENT_ACTIVE"},"paymentSessionId":{"type":"string","description":"The payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"merchantPaymentAgreementReference":{"type":"string","description":"The merchant payment agreement reference","example":"5c019979-0751-469e-96e0-b67f1d95c577"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"}}},"AgreementAuthenticationPendingEventRequestDetails":{"properties":{"paymentAgreementId":{"type":"string","description":"The payment agreement ID","example":"agr_BlTZQyHL9DeUYPYtXmOdq"},"paymentAgreementStatus":{"type":"string","description":"The payment agreement status","enum":["INITIALIZING","AUTHENTICATION_PENDING","ACTIVE","REVOKED_BY_CONSUMER","REVOKED_BY_MERCHANT","REVOKED_BY_PROVIDER","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment agreement","example":"IDEAL"},"type":{"type":"string","description":"The payment agreement event type","example":"PAYMENT_AGREEMENT_AUTHENTICATION_PENDING"},"paymentSessionId":{"type":"string","description":"The payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"merchantPaymentAgreementReference":{"type":"string","description":"The merchant payment agreement reference","example":"5c019979-0751-469e-96e0-b67f1d95c577"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"authenticationMethods":{"type":"array","description":"The available authentication methods for the authorization","items":{"$ref":"#/components/schemas/AuthenticationMethodRequest"}}}},"AppIntentAuthenticationDetailsRequest":{"description":"The APP_INTENT authentication details","properties":{"mobileIntentUri":{"type":"string","description":"Intent URI to be used for app-to-app mobile flows","example":"upiGlobal://pay?tr=123&from_app=true"}}},"AppIntentAuthenticationMethodRequest":{"allOf":[{"type":"object","properties":{"details":{"$ref":"#/components/schemas/AppIntentAuthenticationDetailsRequest"},"type":{"type":"string","description":"The APP_INTENT authentication type","enum":["APP_INTENT"]}}}]},"AppNotificationAuthenticationMethodRequest":{"allOf":[{"type":"object","properties":{"type":{"type":"string","description":"The APP_NOTIFICATION authentication type","enum":["APP_NOTIFICATION"]}}}]},"AuthenticationMethodRequest":{"description":"The available authentication methods for the authorization","discriminator":{"propertyName":"type","mapping":{"REDIRECT":"#/components/schemas/RedirectAuthenticationMethodRequest","SCAN_CODE":"#/components/schemas/ScanCodeAuthenticationMethodRequest","APP_INTENT":"#/components/schemas/AppIntentAuthenticationMethodRequest","APP_NOTIFICATION":"#/components/schemas/AppNotificationAuthenticationMethodRequest","MULTI_FACTOR":"#/components/schemas/MultiFactorAuthenticationMethodRequest","3DS":"#/components/schemas/ThreeDsAuthenticationMethodRequest"}},"oneOf":[{"allOf":[{"$ref":"#/components/schemas/RedirectAuthenticationMethodRequest"}],"title":"Authentication Method"},{"allOf":[{"$ref":"#/components/schemas/ScanCodeAuthenticationMethodRequest"}],"title":"Authentication Method"},{"allOf":[{"$ref":"#/components/schemas/AppIntentAuthenticationMethodRequest"}],"title":"Authentication Method"},{"allOf":[{"$ref":"#/components/schemas/AppNotificationAuthenticationMethodRequest"}],"title":"Authentication Method"},{"allOf":[{"$ref":"#/components/schemas/MultiFactorAuthenticationMethodRequest"}],"title":"Authentication Method"},{"allOf":[{"$ref":"#/components/schemas/ThreeDsAuthenticationMethodRequest"}],"title":"Authentication Method"}],"required":["type"]},"MultiFactorAuthenticationMethodRequest":{"allOf":[{"type":"object","properties":{"type":{"type":"string","description":"The MULTI_FACTOR authentication type","enum":["MULTI_FACTOR"]}}}]},"RedirectAuthenticationDetailsRequest":{"description":"The REDIRECT authentication details","properties":{"requestUrl":{"type":"string","description":"The URL where the consumer should be redirected in order to authenticate the payment","example":"https://pay.playground.klarna.com/eu/hpp/payments/123abc"},"requestMethod":{"type":"string","description":"The redirect HTTP method","enum":["GET","POST"]}}},"RedirectAuthenticationMethodRequest":{"allOf":[{"type":"object","properties":{"details":{"$ref":"#/components/schemas/RedirectAuthenticationDetailsRequest"},"type":{"type":"string","description":"The REDIRECT authentication type","enum":["REDIRECT"]}}}]},"ScanCodeAuthenticationDetailsRequest":{"description":"The SCAN_CODE authentication details","properties":{"codeType":{"type":"string","description":"The type of the scan or of the code payload","enum":["QR","UPC","ITF","CODE128","PAYMENT_REFERENCE"]},"codeImage":{"type":"string","description":"The pre-generated scan code image for the ease of integration","example":"https://authman-mobileapp.ppro.com/qr.png?payload=dXBpR2xvYmFsOi8vc3RhcnRfdHJhbnNhY3Rpb24/dHI9MTIzJmZyb21fcXI9dHJ1ZQ=="},"codePayload":{"type":"string","description":"The payload for the scan code or for the reference to construct the image or the UX on the partners side","example":"upiGlobal://pay?tr=123&from_desktop=true"},"codeDocument":{"type":"string","description":"The URL of the pdf/html pay slip document","example":"https://urltodocument.com"},"codeProviderEntityId":{"type":"string","description":"The identifier of the code provider entity","example":"45648"},"scanBy":{"type":"string","format":"date-time","description":"The custom expiry timestamp (ISO 8601 format) before which the consumer is expected to complete the payment","example":"2026-06-03T11:23:47.123Z"}}},"ScanCodeAuthenticationMethodRequest":{"allOf":[{"type":"object","properties":{"details":{"$ref":"#/components/schemas/ScanCodeAuthenticationDetailsRequest"},"type":{"type":"string","description":"The SCAN_CODE authentication type","enum":["SCAN_CODE"]}}}]},"ThreeDsAuthenticationMethodDetailsRequest":{"description":"The 3DS authentication details","properties":{"requestUrl":{"type":"string","description":"The URL where the consumer should be redirected in order to authenticate the payment","example":"https://pay.playground.klarna.com/eu/hpp/payments/123abc"},"requestMethod":{"type":"string","description":"The redirect HTTP method","enum":["GET","POST"]}}},"ThreeDsAuthenticationMethodRequest":{"allOf":[{"type":"object","properties":{"details":{"$ref":"#/components/schemas/ThreeDsAuthenticationMethodDetailsRequest"},"type":{"type":"string","description":"The 3DS authentication type","enum":["3DS"]}}}]},"AddressRequest":{"description":"Defines the billing address of the consumer","properties":{"firstName":{"type":"string","description":"The first name of the individual associated with the address","example":"John"},"lastName":{"type":"string","description":"The last name of the individual associated with the address","example":"Smith"},"phoneNumber":{"type":"string","description":"The phone number of the individual associated with the address","example":"+491521111111"},"street":{"type":"string","description":"The street name and number of the address","example":"Maple Street 102/B"},"postalCode":{"type":"string","description":"The postal or ZIP code","example":"41460"},"city":{"type":"string","description":"The city of the address","example":"Berlin"},"region":{"type":"string","description":"The region of the address","example":"Berlin"},"country":{"type":"string","description":"The country of the address, represented as a two-letter ISO 3166-1 alpha-2 country code","example":"DE"}}},"AgreementCreatedEventRequestDetails":{"properties":{"paymentAgreementId":{"type":"string","description":"The payment agreement ID","example":"agr_BlTZQyHL9DeUYPYtXmOdq"},"paymentAgreementStatus":{"type":"string","description":"The payment agreement status","enum":["INITIALIZING","AUTHENTICATION_PENDING","ACTIVE","REVOKED_BY_CONSUMER","REVOKED_BY_MERCHANT","REVOKED_BY_PROVIDER","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment agreement","example":"IDEAL"},"type":{"type":"string","description":"The payment agreement event type","example":"PAYMENT_AGREEMENT_CREATED"},"paymentSessionId":{"type":"string","description":"The payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"merchantPaymentAgreementReference":{"type":"string","description":"The merchant payment agreement reference","example":"5c019979-0751-469e-96e0-b67f1d95c577"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"description":{"type":"string","description":"The description of the agreement"},"instrument":{"$ref":"#/components/schemas/InstrumentDetailsRequest"},"startDate":{"type":"string","format":"date-time","description":"The start date of the agreement","example":"2026-06-03T11:23:47.123Z"},"endDate":{"type":"string","format":"date-time","description":"The end date of the agreement","example":"2026-06-03T11:23:47.123Z"},"frequency":{"$ref":"#/components/schemas/FrequencyRequest"},"amount":{"$ref":"#/components/schemas/MoneyRequest"},"amountType":{"type":"string","description":"Defines if the provided 'amount' is a maximum value or an exact value","enum":["MAX","EXACT","VARIABLE"]},"consumer":{"$ref":"#/components/schemas/ConsumerRequest"}}},"AmazonPayInstrumentDetailsRequest":{"allOf":[{"type":"object","properties":{"details":{"$ref":"#/components/schemas/AmazonPayRequest"},"type":{"type":"string","description":"The AMAZON_PAY instrument type","enum":["AMAZON_PAY"]}}}]},"AmazonPayRequest":{"description":"The AMAZON_PAY instrument details","properties":{"consumerEmail":{"type":"string","description":"The consumer's email for Amazon Pay"}}},"BancontactAccountInstrumentDetailsRequest":{"allOf":[{"type":"object","properties":{"details":{"$ref":"#/components/schemas/BancontactAccountRequest"},"type":{"type":"string","description":"The BANCONTACT_ACCOUNT instrument type","enum":["BANCONTACT_ACCOUNT"]}}}]},"BancontactAccountRequest":{"description":"The BANCONTACT_ACCOUNT instrument details","properties":{"bin":{"type":"string","description":"The card BIN number","example":"411111"},"last4Digits":{"type":"string","description":"The last 4 digits of the card","example":"1234"},"expiryMonth":{"type":"integer","format":"int32","description":"The card expiration month","example":1},"expiryYear":{"type":"integer","format":"int32","description":"The card expiration year","example":2026},"panAlias":{"type":"string","description":"The card PAN alias","example":"ppro_tkn_06cf6d1"},"iban":{"type":"string","description":"The payer's IBAN","example":"BE75271001359951"},"swiftCode":{"type":"string","description":"The payer's BIC/SWIFT code","example":"GEBABEBBXXX"}}},"BankAccountInstrumentDetailsRequest":{"allOf":[{"type":"object","properties":{"details":{"$ref":"#/components/schemas/BankAccountRequest"},"type":{"type":"string","description":"The BANK_ACCOUNT instrument type","enum":["BANK_ACCOUNT"]}}}]},"BankAccountRequest":{"description":"The BANK_ACCOUNT instrument details","properties":{"accountNumber":{"type":"string","description":"The account number","example":"007123456"},"holderName":{"type":"string","description":"The account holder name name","example":"John Doe"},"iban":{"type":"string","description":"The IBAN","example":"DE75512108001245126199"},"swiftCode":{"type":"string","description":"The SWIFT code","example":"DEUTDEFF123"},"bankName":{"type":"string","description":"The bank name","example":"My Bank"},"bankCode":{"type":"string","description":"The bank code","example":"12341234"},"debitMandateId":{"type":"string","description":"The reference id for a mandate that allows debit charges on the bank account"},"debitMandateIdMigrated":{"type":"boolean","description":"A merchant-provided indicator specifying whether the payment instrument was migrated from a different provider"},"country":{"type":"string","description":"The bank account country","example":"DE"}}},"CardNetworkTokenInstrumentDetailsRequest":{"allOf":[{"type":"object","properties":{"details":{"$ref":"#/components/schemas/CardNetworkTokenRequest"},"type":{"type":"string","description":"The CARD_NETWORK_TOKEN instrument type","enum":["CARD_NETWORK_TOKEN"]}}}]},"CardNetworkTokenRequest":{"description":"The CARD_NETWORK_TOKEN instrument details","properties":{"brand":{"type":"string","description":"The card brand","example":"VISA"},"holderName":{"type":"string","description":"The card holder name","example":"John Doe"},"expiryMonth":{"type":"integer","format":"int32","description":"The network token expiration month","example":1},"expiryYear":{"type":"integer","format":"int32","description":"The network token expiration year","example":2026},"tokenNumber":{"type":"string","description":"The network token number defined by the card network","example":"5598880000008001"},"eci":{"type":"string","description":"The electronic commerce indicator from the card issuer","example":"07"}}},"ConsumerRequest":{"description":"The consumer details","properties":{"name":{"type":"string","description":"The full name of the consumer making the payment","example":"John Smith"},"email":{"type":"string","description":"The email address of the consumer making the payment","example":"johnsmith@example.com"},"phone":{"type":"string","description":"The phone number of the consumer making the payment","example":"+491521111111"},"country":{"type":"string","description":"The country of residence of the consumer, represented as a two-letter ISO 3166-1 alpha-2 country code","example":"DE"},"locale":{"type":"string","description":"The locale of the consumer in the format of a language and country code","example":"de-DE"},"taxIdentification":{"type":"string","description":"The consumer's tax identification number, like CUIT in Argentina, CPF in Brazil, RUT in Chile, NIF in Spain or Portugal, Numéro fiscal in France, and Codice Fiscale in Italy, or the equivalent tax identifier applicable in the consumer's country.","example":"12345678909"},"merchantConsumerReference":{"type":"string","description":"The merchant provided consumer reference","example":"consumerRef-123"},"billingAddress":{"$ref":"#/components/schemas/AddressRequest"}}},"FrequencyRequest":{"description":"The frequency of payment charges","properties":{"type":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","YEARLY"]},"interval":{"type":"integer","format":"int32"}}},"InstrumentDetailsRequest":{"description":"The instrument details","discriminator":{"propertyName":"type","mapping":{"BANCONTACT_ACCOUNT":"#/components/schemas/BancontactAccountInstrumentDetailsRequest","BANK_ACCOUNT":"#/components/schemas/BankAccountInstrumentDetailsRequest","KLARNA_ACCOUNT":"#/components/schemas/KlarnaAccountInstrumentDetailsRequest","MOCK":"#/components/schemas/MockInstrumentDetailsRequest","UPI_AUTOPAY":"#/components/schemas/UpiAutoPayInstrumentDetailsRequest","TWINT_WALLET":"#/components/schemas/TwintWalletInstrumentDetailsRequest","AMAZON_PAY":"#/components/schemas/AmazonPayInstrumentDetailsRequest","CARD_PPRO_VAULTED":"#/components/schemas/VaultedCardInstrumentDetailsRequest","CARD_NETWORK_TOKEN":"#/components/schemas/CardNetworkTokenInstrumentDetailsRequest","PASSTHROUGH_WALLET":"#/components/schemas/PassthroughWalletInstrumentDetailsRequest"}},"oneOf":[{"allOf":[{"$ref":"#/components/schemas/BancontactAccountInstrumentDetailsRequest"}],"title":"Instrument Details"},{"allOf":[{"$ref":"#/components/schemas/BankAccountInstrumentDetailsRequest"}],"title":"Instrument Details"},{"allOf":[{"$ref":"#/components/schemas/KlarnaAccountInstrumentDetailsRequest"}],"title":"Instrument Details"},{"allOf":[{"$ref":"#/components/schemas/MockInstrumentDetailsRequest"}],"title":"Instrument Details"},{"allOf":[{"$ref":"#/components/schemas/UpiAutoPayInstrumentDetailsRequest"}],"title":"Instrument Details"},{"allOf":[{"$ref":"#/components/schemas/TwintWalletInstrumentDetailsRequest"}],"title":"Instrument Details"},{"allOf":[{"$ref":"#/components/schemas/AmazonPayInstrumentDetailsRequest"}],"title":"Instrument Details"},{"allOf":[{"$ref":"#/components/schemas/VaultedCardInstrumentDetailsRequest"}],"title":"Instrument Details"},{"allOf":[{"$ref":"#/components/schemas/CardNetworkTokenInstrumentDetailsRequest"}],"title":"Instrument Details"},{"allOf":[{"$ref":"#/components/schemas/PassthroughWalletInstrumentDetailsRequest"}],"title":"Instrument Details"}],"properties":{"id":{"type":"string","description":"The payment instrument ID","example":"instr_mR082D5QAhP5hMTNjhbHl"}},"required":["type"]},"KlarnaAccountInstrumentDetailsRequest":{"allOf":[{"type":"object","properties":{"details":{"$ref":"#/components/schemas/KlarnaAccountRequest"},"type":{"type":"string","description":"The KLARNA_ACCOUNT instrument type","enum":["KLARNA_ACCOUNT"]}}}]},"KlarnaAccountRequest":{"description":"The KLARNA_ACCOUNT instrument details","properties":{"authorizedPaymentMethod":{"type":"string","description":"Klarna authorized payment method","example":"DIRECT_BANK_TRANSFER"},"billingCategory":{"type":"string","description":"Klarna billing category","example":"PAY_LATER"}}},"MockInstrumentDetailsRequest":{"allOf":[{"type":"object","properties":{"details":{"type":"object","additionalProperties":{"type":"object","description":"The MOCK instrument details","example":{"key":"value"}},"description":"The MOCK instrument details","example":{"key":"value"}},"type":{"type":"string","description":"The MOCK instrument type","enum":["MOCK"]}}}]},"MoneyRequest":{"description":"The operation amount","properties":{"value":{"type":"integer","format":"int64","description":"The monetary value to be charged or processed, expressed in the smallest currency unit (e.g., cents for EUR)","example":1000},"currency":{"type":"string","description":"The three-letter ISO 4217 currency code representing the currency in which the amount is denominated","example":"EUR"}}},"PassthroughWalletInstrumentDetailsRequest":{"allOf":[{"type":"object","properties":{"details":{"$ref":"#/components/schemas/PassthroughWalletRequest"},"type":{"type":"string","description":"The PASSTHROUGH_WALLET instrument type","enum":["PASSTHROUGH_WALLET"]}}}]},"PassthroughWalletRequest":{"description":"The PASSTHROUGH_WALLET instrument details","properties":{"fingerprint":{"type":"string","description":"The unique identity of the instrument given by a provider (masked with md5 hashing)"},"paymentReference":{"type":"string","description":"Payment reference linked with the instrument"},"displayIdentifier":{"type":"string","description":"An identifier (for example phone number, email or username) for the consumer’s account with the provider information"},"country":{"type":"string","description":"Consumer's actual country returned by the provider.","example":"DE"},"fundingType":{"type":"string","description":"The type of funding to be used by the provider for the agreement or the charge","enum":["CREDIT","DEBIT"]}}},"TwintWalletInstrumentDetailsRequest":{"allOf":[{"type":"object","properties":{"type":{"type":"string","description":"The TWINT_WALLET instrument type","enum":["TWINT_WALLET"]}}}]},"UpiAutoPayInstrumentDetailsRequest":{"allOf":[{"type":"object","properties":{"details":{"$ref":"#/components/schemas/UpiAutoPayRequest"},"type":{"type":"string","description":"The UPI_AUTOPAY instrument type","enum":["UPI_AUTOPAY"]}}}]},"UpiAutoPayRequest":{"description":"The UPI_AUTOPAY instrument details","properties":{"uniqueMandateNumber":{"type":"string","description":"The UPI unique mandate number","example":"testumn@upi"}}},"VaultedCardInstrumentDetailsRequest":{"allOf":[{"type":"object","properties":{"details":{"$ref":"#/components/schemas/VaultedCardRequest"},"type":{"type":"string","description":"The CARD_PPRO_VAULTED instrument type","enum":["CARD_PPRO_VAULTED"]}}}]},"VaultedCardRequest":{"description":"The CARD_PPRO_VAULTED instrument details","properties":{"brand":{"type":"string","description":"The card brand","example":"VISA"},"bin":{"type":"string","description":"The card BIN number","example":"411111"},"last4Digits":{"type":"string","description":"The last 4 digits of the card","example":"1234"},"expiryMonth":{"type":"integer","format":"int32","description":"The card expiration month","example":1},"expiryYear":{"type":"integer","format":"int32","description":"The card expiration year","example":2026},"holderName":{"type":"string","description":"The card holder name","example":"John Doe"},"panAlias":{"type":"string","description":"The card PAN alias","example":"ppro_tkn_06cf6d1"},"cvvAlias":{"type":"string","description":"The card CVV alias","example":"ppro_tkn_a2cf6d1"}}},"AgreementFailedEventRequestDetails":{"properties":{"paymentAgreementId":{"type":"string","description":"The payment agreement ID","example":"agr_BlTZQyHL9DeUYPYtXmOdq"},"paymentAgreementStatus":{"type":"string","description":"The payment agreement status","enum":["INITIALIZING","AUTHENTICATION_PENDING","ACTIVE","REVOKED_BY_CONSUMER","REVOKED_BY_MERCHANT","REVOKED_BY_PROVIDER","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment agreement","example":"IDEAL"},"type":{"type":"string","description":"The payment agreement event type","example":"PAYMENT_AGREEMENT_FAILED"},"paymentSessionId":{"type":"string","description":"The payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"merchantPaymentAgreementReference":{"type":"string","description":"The merchant payment agreement reference","example":"5c019979-0751-469e-96e0-b67f1d95c577"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"failure":{"$ref":"#/components/schemas/ProcessingFailureRequest"}}},"ProcessingFailureRequest":{"description":"The processing failure details","properties":{"failureType":{"type":"string","description":"The failure type","enum":["INTERNAL_ERROR","INTERNAL_DECLINE","PROVIDER_ERROR","PROVIDER_DECLINE"]},"failureCode":{"type":"string","description":"The failure code"},"providerFailureCode":{"type":"string","description":"The payment provider failure code"},"failureMessage":{"type":"string","description":"The failure message"}}},"AgreementRevokedByConsumerEventRequestDetails":{"properties":{"paymentAgreementId":{"type":"string","description":"The payment agreement ID","example":"agr_BlTZQyHL9DeUYPYtXmOdq"},"paymentAgreementStatus":{"type":"string","description":"The payment agreement status","enum":["INITIALIZING","AUTHENTICATION_PENDING","ACTIVE","REVOKED_BY_CONSUMER","REVOKED_BY_MERCHANT","REVOKED_BY_PROVIDER","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment agreement","example":"IDEAL"},"type":{"type":"string","description":"The payment agreement event type","example":"PAYMENT_AGREEMENT_REVOKED_BY_CONSUMER"},"paymentSessionId":{"type":"string","description":"The payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"merchantPaymentAgreementReference":{"type":"string","description":"The merchant payment agreement reference","example":"5c019979-0751-469e-96e0-b67f1d95c577"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"}}},"AgreementRevokedByMerchantEventRequestDetails":{"properties":{"paymentAgreementId":{"type":"string","description":"The payment agreement ID","example":"agr_BlTZQyHL9DeUYPYtXmOdq"},"paymentAgreementStatus":{"type":"string","description":"The payment agreement status","enum":["INITIALIZING","AUTHENTICATION_PENDING","ACTIVE","REVOKED_BY_CONSUMER","REVOKED_BY_MERCHANT","REVOKED_BY_PROVIDER","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment agreement","example":"IDEAL"},"type":{"type":"string","description":"The payment agreement event type","example":"PAYMENT_AGREEMENT_REVOKED_BY_MERCHANT"},"paymentSessionId":{"type":"string","description":"The payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"merchantPaymentAgreementReference":{"type":"string","description":"The merchant payment agreement reference","example":"5c019979-0751-469e-96e0-b67f1d95c577"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"}}},"AgreementRevokedByProviderEventRequestDetails":{"properties":{"paymentAgreementId":{"type":"string","description":"The payment agreement ID","example":"agr_BlTZQyHL9DeUYPYtXmOdq"},"paymentAgreementStatus":{"type":"string","description":"The payment agreement status","enum":["INITIALIZING","AUTHENTICATION_PENDING","ACTIVE","REVOKED_BY_CONSUMER","REVOKED_BY_MERCHANT","REVOKED_BY_PROVIDER","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment agreement","example":"IDEAL"},"type":{"type":"string","description":"The payment agreement event type","example":"PAYMENT_AGREEMENT_REVOKED_BY_PROVIDER"},"paymentSessionId":{"type":"string","description":"The payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"merchantPaymentAgreementReference":{"type":"string","description":"The merchant payment agreement reference","example":"5c019979-0751-469e-96e0-b67f1d95c577"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"}}},"AgreementUpdatedEventRequestDetails":{"properties":{"paymentAgreementId":{"type":"string","description":"The payment agreement ID","example":"agr_BlTZQyHL9DeUYPYtXmOdq"},"paymentAgreementStatus":{"type":"string","description":"The payment agreement status","enum":["INITIALIZING","AUTHENTICATION_PENDING","ACTIVE","REVOKED_BY_CONSUMER","REVOKED_BY_MERCHANT","REVOKED_BY_PROVIDER","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment agreement","example":"IDEAL"},"type":{"type":"string","description":"The payment agreement event type","example":"PAYMENT_AGREEMENT_UPDATED"},"paymentSessionId":{"type":"string","description":"The payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"merchantPaymentAgreementReference":{"type":"string","description":"The merchant payment agreement reference","example":"5c019979-0751-469e-96e0-b67f1d95c577"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"}}},"ChargebackSucceededEventRequestDetails":{"properties":{"paymentChargeId":{"type":"string","description":"The payment charge ID","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"type":{"type":"string","description":"The chargeback event type","example":"CHARGEBACK_SUCCEEDED"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"amount":{"$ref":"#/components/schemas/MoneyRequest"}}},"ChargeAuthenticationPendingEventRequestDetails":{"properties":{"paymentChargeId":{"type":"string","description":"The payment charge ID","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"paymentChargeStatus":{"type":"string","description":"The payment charge status","enum":["AUTHORIZATION_PROCESSING","AUTHORIZATION_ASYNC","AUTHENTICATION_PENDING","CAPTURE_PENDING","CAPTURE_PROCESSING","CAPTURED","REFUND_PROCESSING","REFUNDED","VOID_PROCESSING","VOIDED","DISCARDED","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment charge","example":"IDEAL"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"merchantPaymentChargeReference":{"type":"string","description":"A merchant-defined identifier that uniquely represents a single payment attempt","example":"merch_payment_ref_123"},"orderReferenceNumber":{"type":"string","description":"A merchant-defined identifier (e.g., invoice or order number) that remains the same across all payment attempts for the same order","example":"order_ref_123"},"type":{"type":"string","description":"The payment charge event type","example":"PAYMENT_CHARGE_AUTHENTICATION_PENDING"},"paymentSessionId":{"type":"string","description":"The associated payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"authorizationId":{"type":"string","description":"The authorization ID","example":"authz_l1hJpcLJGMyiafx1QdCqr"},"amount":{"$ref":"#/components/schemas/MoneyRequest"},"authenticationMethods":{"type":"array","description":"The available authentication methods for the authorization","items":{"$ref":"#/components/schemas/AuthenticationMethodRequest"}}}},"ChargeAuthorizationFailedEventRequestDetails":{"properties":{"paymentChargeId":{"type":"string","description":"The payment charge ID","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"paymentChargeStatus":{"type":"string","description":"The payment charge status","enum":["AUTHORIZATION_PROCESSING","AUTHORIZATION_ASYNC","AUTHENTICATION_PENDING","CAPTURE_PENDING","CAPTURE_PROCESSING","CAPTURED","REFUND_PROCESSING","REFUNDED","VOID_PROCESSING","VOIDED","DISCARDED","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment charge","example":"IDEAL"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"merchantPaymentChargeReference":{"type":"string","description":"A merchant-defined identifier that uniquely represents a single payment attempt","example":"merch_payment_ref_123"},"orderReferenceNumber":{"type":"string","description":"A merchant-defined identifier (e.g., invoice or order number) that remains the same across all payment attempts for the same order","example":"order_ref_123"},"type":{"type":"string","description":"The payment charge event type","example":"PAYMENT_CHARGE_AUTHORIZATION_FAILED"},"paymentSessionId":{"type":"string","description":"The associated payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"authorizationId":{"type":"string","description":"The authorization ID","example":"authz_l1hJpcLJGMyiafx1QdCqr"},"amount":{"$ref":"#/components/schemas/MoneyRequest"},"failure":{"$ref":"#/components/schemas/ProcessingFailureRequest"}}},"ChargeAuthorizationSucceededEventRequestDetails":{"properties":{"paymentChargeId":{"type":"string","description":"The payment charge ID","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"paymentChargeStatus":{"type":"string","description":"The payment charge status","enum":["AUTHORIZATION_PROCESSING","AUTHORIZATION_ASYNC","AUTHENTICATION_PENDING","CAPTURE_PENDING","CAPTURE_PROCESSING","CAPTURED","REFUND_PROCESSING","REFUNDED","VOID_PROCESSING","VOIDED","DISCARDED","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment charge","example":"IDEAL"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"merchantPaymentChargeReference":{"type":"string","description":"A merchant-defined identifier that uniquely represents a single payment attempt","example":"merch_payment_ref_123"},"orderReferenceNumber":{"type":"string","description":"A merchant-defined identifier (e.g., invoice or order number) that remains the same across all payment attempts for the same order","example":"order_ref_123"},"type":{"type":"string","description":"The payment charge event type","example":"PAYMENT_CHARGE_AUTHORIZATION_SUCCEEDED"},"paymentSessionId":{"type":"string","description":"The associated payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"authorizationId":{"type":"string","description":"The authorization ID","example":"authz_l1hJpcLJGMyiafx1QdCqr"},"amount":{"$ref":"#/components/schemas/MoneyRequest"},"isMultiStep":{"type":"boolean","description":"Indicates if capture is a multi-step process. If true, the capture requires additional step to be completed after the authorization"}}},"ChargeCaptureFailedEventRequestDetails":{"properties":{"paymentChargeId":{"type":"string","description":"The payment charge ID","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"paymentChargeStatus":{"type":"string","description":"The payment charge status","enum":["AUTHORIZATION_PROCESSING","AUTHORIZATION_ASYNC","AUTHENTICATION_PENDING","CAPTURE_PENDING","CAPTURE_PROCESSING","CAPTURED","REFUND_PROCESSING","REFUNDED","VOID_PROCESSING","VOIDED","DISCARDED","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment charge","example":"IDEAL"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"merchantPaymentChargeReference":{"type":"string","description":"A merchant-defined identifier that uniquely represents a single payment attempt","example":"merch_payment_ref_123"},"orderReferenceNumber":{"type":"string","description":"A merchant-defined identifier (e.g., invoice or order number) that remains the same across all payment attempts for the same order","example":"order_ref_123"},"type":{"type":"string","description":"The payment charge event type","example":"PAYMENT_CHARGE_CAPTURE_FAILED"},"paymentSessionId":{"type":"string","description":"The associated payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"captureId":{"type":"string","description":"The capture ID","example":"capture_67Ml6cOgDTXOcZh4qpgrc"},"amount":{"$ref":"#/components/schemas/MoneyRequest"},"failure":{"$ref":"#/components/schemas/ProcessingFailureRequest"},"merchantCaptureReference":{"type":"string","description":"The merchant provided capture reference","example":"merch_capture_ref_123"}}},"ChargeCaptureSucceededEventRequestDetails":{"properties":{"paymentChargeId":{"type":"string","description":"The payment charge ID","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"paymentChargeStatus":{"type":"string","description":"The payment charge status","enum":["AUTHORIZATION_PROCESSING","AUTHORIZATION_ASYNC","AUTHENTICATION_PENDING","CAPTURE_PENDING","CAPTURE_PROCESSING","CAPTURED","REFUND_PROCESSING","REFUNDED","VOID_PROCESSING","VOIDED","DISCARDED","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment charge","example":"IDEAL"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"merchantPaymentChargeReference":{"type":"string","description":"A merchant-defined identifier that uniquely represents a single payment attempt","example":"merch_payment_ref_123"},"orderReferenceNumber":{"type":"string","description":"A merchant-defined identifier (e.g., invoice or order number) that remains the same across all payment attempts for the same order","example":"order_ref_123"},"type":{"type":"string","description":"The payment charge event type","example":"PAYMENT_CHARGE_CAPTURE_SUCCEEDED"},"paymentSessionId":{"type":"string","description":"The associated payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"captureId":{"type":"string","description":"The capture ID","example":"capture_67Ml6cOgDTXOcZh4qpgrc"},"amount":{"$ref":"#/components/schemas/MoneyRequest"},"merchantCaptureReference":{"type":"string","description":"The merchant provided capture reference","example":"merch_capture_ref_123"}}},"AirlineDetailsRequest":{"description":"The airline industry specific details.","properties":{"pnr":{"type":"string","description":"The Passenger Name Record (PNR) associated with the airline booking.","example":"ABC123"},"numberOfPassengers":{"type":"integer","format":"int32","description":"The number of passengers on the booking.","example":2},"airlineCode":{"type":"string","description":"The standardized two-letter or three-letter airline code assigned by IATA (International Air Transport Association) or ICAO (International Civil Aviation Organization).","example":"BA"},"passengerEmail":{"type":"string","format":"email","description":"The email address of the passenger.","example":"johnsmith@example.com"},"passengerPhone":{"type":"string","description":"The passenger phone number","example":"+491521111111"},"passengerName":{"type":"string","description":"The passenger name","example":"John Doe"},"carrierCode":{"type":"string","description":"The standardized two-letter or three-letter carrier code assigned by IATA (International Air Transport Association) or ICAO (International Civil Aviation Organization).","example":"AA"},"tripSegments":{"type":"array","description":"The trip segment details.","items":{"$ref":"#/components/schemas/AirlineTripSegmentRequest"}}}},"AirlineIndustryDataRequest":{"allOf":[{"type":"object","properties":{"details":{"$ref":"#/components/schemas/AirlineDetailsRequest"},"type":{"type":"string","description":"The `AIRLINE` industry data type","enum":["AIRLINE"]}}}]},"AirlineTripSegmentRequest":{"description":"The trip segment details.","properties":{"fareBasisCode":{"type":"string","description":"The fare basis code is an alphanumeric identifier used by airlines to specify the fare rules, booking class, and restrictions associated with a ticket.","example":"M3L7X"},"departureAirportCode":{"type":"string","description":"The three-letter IATA airport code representing the departure airport for the flight.","example":"LHR"},"destinationAirportCode":{"type":"string","description":"The three-letter IATA airport code representing the destination airport for the flight.","example":"JFK"},"flightNumber":{"type":"string","description":"The flight number.","example":"BA117"},"departureDate":{"type":"string","format":"date","description":"The departure date of the flight.","example":"2025-01-01"},"flightCarrierCode":{"type":"string","description":"The two-letter IATA airline code representing the carrier operating the flight.","example":"BA"},"segmentId":{"type":"string","description":"A unique identifier for a specific flight segment within a booking or itinerary.","example":"FLG4567"}}},"AppIntentAuthenticationSettingsRequest":{"allOf":[{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/AppIntentAuthenticationSettingsRequestDetails"},"type":{"type":"string","description":"The APP_INTENT authentication type","enum":["APP_INTENT"]}}}]},"AppIntentAuthenticationSettingsRequestDetails":{"description":"The APP_INTENT authentication settings","properties":{"mobileIntentUri":{"type":"string","description":"A mobile deep link or intent URI to which the consumer is redirected after completing an action, such as a payment or authentication flow","example":"webapp://checkout?paymentId=abc123"}}},"AppNotificationAuthenticationSettingsRequest":{"allOf":[{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/AppNotificationAuthenticationSettingsRequestDetails"},"type":{"type":"string","description":"The APP_NOTIFICATION authentication type","enum":["APP_NOTIFICATION"]}}}]},"AppNotificationAuthenticationSettingsRequestDetails":{"description":"The APP_NOTIFICATION authentication details","properties":{"instrumentProviderIdentity":{"type":"string","description":"App identifier, for instance email, phone number","example":"+34700000000"}}},"AuthenticationSettingsRequest":{"description":"The authorization authentication settings","discriminator":{"propertyName":"type","mapping":{"REDIRECT":"#/components/schemas/RedirectAuthenticationSettingsRequest","EXTERNAL_3DS":"#/components/schemas/ExternalThreeDsAuthenticationSettingsRequest","3DS":"#/components/schemas/ThreeDsAuthenticationSettingsRequest","SCAN_CODE":"#/components/schemas/ScanCodeAuthenticationSettingsRequest","MULTI_FACTOR":"#/components/schemas/MultiFactorAuthenticationSettingsRequest","APP_INTENT":"#/components/schemas/AppIntentAuthenticationSettingsRequest","APP_NOTIFICATION":"#/components/schemas/AppNotificationAuthenticationSettingsRequest"}},"oneOf":[{"allOf":[{"$ref":"#/components/schemas/RedirectAuthenticationSettingsRequest"}],"title":"Authentication Settings"},{"allOf":[{"$ref":"#/components/schemas/ExternalThreeDsAuthenticationSettingsRequest"}],"title":"Authentication Settings"},{"allOf":[{"$ref":"#/components/schemas/ThreeDsAuthenticationSettingsRequest"}],"title":"Authentication Settings"},{"allOf":[{"$ref":"#/components/schemas/ScanCodeAuthenticationSettingsRequest"}],"title":"Authentication Settings"},{"allOf":[{"$ref":"#/components/schemas/MultiFactorAuthenticationSettingsRequest"}],"title":"Authentication Settings"},{"allOf":[{"$ref":"#/components/schemas/AppIntentAuthenticationSettingsRequest"}],"title":"Authentication Settings"},{"allOf":[{"$ref":"#/components/schemas/AppNotificationAuthenticationSettingsRequest"}],"title":"Authentication Settings"}],"required":["type"]},"ChallengeRequest":{"description":"The 3DS authentication challenge details","properties":{"preference":{"type":"string","description":"The 3DS authentication challenge initialization preference","enum":["NO_PREFERENCE","NO_CHALLENGE_REQUESTED","CHALLENGE_REQUESTED","CHALLENGE_MANDATED","DATA_ONLY"]},"outcome":{"type":"string","description":"The 3DS authentication challenge outcome","enum":["CHALLENGE","FRICTIONLESS","DATA_ONLY"]},"exemptionReason":{"type":"string","description":"The 3DS authentication challenge exemption reason","enum":["LOW_VALUE","LOW_RISK","TRUSTED_BENEFICIARY","FIXED_RECURRING"]},"cancellationReason":{"type":"string","description":"The 3DS challenge cancellation indicator.Mandatory for CB transactions","enum":["CARDHOLDER_CANCELLED","REQUESTOR_CANCELLED","TRANSACTION_ABANDONED","TRANSACTION_TIMEOUT_ACS_OTHER","TRANSACTION_TIMEOUT_ACS_CREQ_NOT_RECEIVED","TRANSACTION_ERROR","UNKNOWN"]}}},"ChargeCreatedEventRequestDetails":{"properties":{"paymentChargeId":{"type":"string","description":"The payment charge ID","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"paymentChargeStatus":{"type":"string","description":"The payment charge status","enum":["AUTHORIZATION_PROCESSING","AUTHORIZATION_ASYNC","AUTHENTICATION_PENDING","CAPTURE_PENDING","CAPTURE_PROCESSING","CAPTURED","REFUND_PROCESSING","REFUNDED","VOID_PROCESSING","VOIDED","DISCARDED","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment charge","example":"IDEAL"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"merchantPaymentChargeReference":{"type":"string","description":"A merchant-defined identifier that uniquely represents a single payment attempt","example":"merch_payment_ref_123"},"orderReferenceNumber":{"type":"string","description":"A merchant-defined identifier (e.g., invoice or order number) that remains the same across all payment attempts for the same order","example":"order_ref_123"},"type":{"type":"string","description":"The payment charge event type","example":"PAYMENT_CHARGE_CREATED"},"paymentSessionId":{"type":"string","description":"The associated payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"paymentMedium":{"type":"string","description":"The medium through which the payment was initiated","enum":["ECOMMERCE","MOTO","POS"],"example":"ECOMMERCE"},"initiator":{"type":"string","description":"The initiator of the payment charge","enum":["CONSUMER","MERCHANT"],"example":"CONSUMER"},"paymentDescriptor":{"type":"string","description":"A short descriptor for the payment that may appear on consumer statements","example":"Webshop - ORDER 1234"},"amount":{"$ref":"#/components/schemas/MoneyRequest"},"order":{"$ref":"#/components/schemas/OrderRequest"},"consumer":{"$ref":"#/components/schemas/ConsumerRequest"},"authenticationSettings":{"type":"array","description":"The authorization authentication settings","items":{"$ref":"#/components/schemas/AuthenticationSettingsRequest"}},"instrument":{"$ref":"#/components/schemas/InstrumentDetailsRequest"}}},"EducationDetailsRequest":{"description":"The education industry specific details.","properties":{"admissionNoticeUrl":{"type":"string","description":"The admission notice url"},"courseStartDate":{"type":"string","format":"date","description":"Course start date","example":"2025-06-10"},"courseEndDate":{"type":"string","format":"date","description":"Course end date","example":"2025-10-10"},"financedCourse":{"type":"boolean","description":"Whether the course is financed?","example":true},"diplomaCourse":{"type":"boolean","description":"Whether the course is diploma?","example":true},"postHighSchoolCourse":{"type":"boolean","description":"Whether the course is post high school?","example":true}}},"EducationIndustryDataRequest":{"allOf":[{"type":"object","properties":{"details":{"$ref":"#/components/schemas/EducationDetailsRequest"},"type":{"type":"string","description":"The `EDUCATION` industry data type","enum":["EDUCATION"]}}}]},"ExternalThreeDsAuthenticationSettingsRequest":{"allOf":[{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/ExternalThreeDsAuthenticationSettingsRequestDetails"},"type":{"type":"string","description":"The `EXTERNAL_3DS` authentication type","enum":["EXTERNAL_3DS"]}}}]},"ExternalThreeDsAuthenticationSettingsRequestDetails":{"description":"The EXTERNAL_3DS authentication settings","properties":{"authenticationStatus":{"type":"string","description":"The 3DS authentication status code","enum":["SUCCESS","ATTEMPT_ACKNOWLEDGED","FAILED","AUTHENTICATION_UNAVAILABLE"]},"authenticationStatusReason":{"type":"string","description":"The 3DS authentication status reason","enum":["CARD_AUTHENTICATION_FAILED","UNKNOWN_DEVICE","UNSUPPORTED_DEVICE","EXCEEDS_AUTHENTICATION_FREQUENCY_LIMIT","EXPIRED_CARD","INVALID_CARD_NUMBER","INVALID_TRANSACTION","NO_CARD_RECORD","SECURITY_FAILURE","STOLEN_CARD","SUSPECTED_FRAUD","TRANSACTION_NOT_PERMITTED_TO_CARDHOLDER","CARDHOLDER_NOT_ENROLLED_IN_SERVICE","TRANSACTION_TIMED_OUT_AT_THE_ACS","LOW_CONFIDENCE","MEDIUM_CONFIDENCE","HIGH_CONFIDENCE","VERY_HIGH_CONFIDENCE","EXCEEDS_ACS_MAXIMUM_CHALLENGES","NON_PAYMENT_TRANSACTION_NOT_SUPPORTED","THREE_RI_TRANSACTION_NOT_SUPPORTED"]},"authenticationValue":{"type":"string","description":"The 3DS authentication CAVV"},"authenticationAlgorithm":{"type":"string","description":"The 3DS authentication CAVV algorithm used"},"authenticationMode":{"type":"string","description":"The 3DS authentication mode","enum":["SCA","FRICTIONLESS"]},"eci":{"type":"string","description":"The 3DS authentication ECI"},"version":{"type":"string","description":"The 3DS authentication version"},"externalId":{"type":"string","description":"The 3DS authentication transaction identifier"},"externalAcsId":{"type":"string","description":"The 3DS universally unique transaction identifier assigned by the ACS to identify a single transaction. Canonical format as defined in IETF RFC 4122","example":"4dc406b0-038d-43ef-a96c-c85352c5e2c0"},"score":{"type":"string","description":"The 3DS score"},"challenge":{"$ref":"#/components/schemas/ChallengeRequest"},"outOfScope":{"$ref":"#/components/schemas/OutOfScopeRequest"}}},"IndustryDataRequest":{"description":"Defines the enhanced industry data","discriminator":{"propertyName":"type","mapping":{"AIRLINE":"#/components/schemas/AirlineIndustryDataRequest","EDUCATION":"#/components/schemas/EducationIndustryDataRequest","TRAVEL":"#/components/schemas/TravelIndustryDataRequest"}},"oneOf":[{"allOf":[{"$ref":"#/components/schemas/AirlineIndustryDataRequest"}],"title":"Industry Data"},{"allOf":[{"$ref":"#/components/schemas/EducationIndustryDataRequest"}],"title":"Industry Data"},{"allOf":[{"$ref":"#/components/schemas/TravelIndustryDataRequest"}],"title":"Industry Data"}],"required":["type"]},"MultiFactorAuthenticationSettingsRequest":{"allOf":[{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/MultiFactorAuthenticationSettingsRequestDetails"},"type":{"type":"string","description":"The MULTI_FACTOR authentication type","enum":["MULTI_FACTOR"]}}}]},"MultiFactorAuthenticationSettingsRequestDetails":{"description":"The MULTI_FACTOR authentication settings","properties":{"verificationCode":{"type":"string","description":"Code generated to authenticate the user","example":"777123"}}},"OrderItemRequest":{"description":"The list of order items","properties":{"name":{"type":"string","description":"The product or service name in the order","example":"White T-Shirt"},"quantity":{"type":"integer","format":"int32","description":"The product or service quantity in the order","example":1},"amount":{"type":"integer","format":"int64","description":"The monetary value of the individual product or service, expressed in the smallest currency unit (e.g., cents for EUR)","example":1000}}},"OrderRequest":{"description":"The payment charge order details","properties":{"orderItems":{"type":"array","description":"The list of order items","items":{"$ref":"#/components/schemas/OrderItemRequest"}},"industryData":{"type":"array","description":"Defines the enhanced industry data","items":{"$ref":"#/components/schemas/IndustryDataRequest"}},"orderReferenceNumber":{"type":"string","description":"A merchant-defined identifier (e.g., invoice or order number) that remains the same across all payment attempts for the same order","example":"order_ref_123"}}},"OutOfScopeRequest":{"description":"The 3DS out of scope object, to be used if the payment is out of scope of SCA","properties":{"reason":{"type":"string","description":"The 3DS out of scope reason, to be used to indicate the reason if the payment is out of scope of SCA","enum":["MIT","MOTO","ONE_LEG_OUT","ANONYMOUS"]}}},"RedirectAuthenticationSettingsDetails":{"description":"The REDIRECT authentication settings","properties":{"returnUrl":{"type":"string","description":"The URL to which the consumer is redirected after completing an action, such as a payment or authentication flow","example":"https://www.webshop.com/order-results-page"}}},"RedirectAuthenticationSettingsRequest":{"allOf":[{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/RedirectAuthenticationSettingsDetails"},"type":{"type":"string","description":"The REDIRECT authentication type","enum":["REDIRECT"]}}}]},"ScanCodeAuthenticationSettingsRequest":{"allOf":[{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/ScanCodeAuthenticationSettingsRequestDetails"},"type":{"type":"string","description":"The SCAN_CODE authentication type","enum":["SCAN_CODE"]}}}]},"ScanCodeAuthenticationSettingsRequestDetails":{"description":"The SCAN_CODE authentication settings","properties":{"scanBy":{"type":"string","format":"date-time","description":"The date and time at which the associated code expires. Must be provided in ISO 8601 format","example":"2026-06-03T11:23:47.123Z"}}},"ThreeDsAuthenticationSettingsRequest":{"allOf":[{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/ThreeDsAuthenticationSettingsRequestDetails"},"type":{"type":"string","description":"The 3DS authentication type","enum":["3DS"]}}}]},"ThreeDsAuthenticationSettingsRequestDetails":{"description":"The 3DS authentication settings","properties":{"returnUrl":{"type":"string","description":"The URL to which the consumer is redirected after completing an action, such as a payment or authentication flow","example":"https://www.webshop.com/order-results-page"},"preference":{"type":"string","description":"The preferred 3D Secure authentication flow","enum":["BLANK","CHALLENGE","FRICTIONLESS"]}}},"TravelDetailsRequest":{"description":"The travel industry specific details.","properties":{"travelType":{"type":"string","description":"The travel type","enum":["UNKNOWN","ONE_WAY","TWO_WAY","MULTIPLE"],"example":"MULTIPLE"},"departureDate":{"type":"string","format":"date","description":"Departure date","example":"2025-06-10"},"returnDate":{"type":"string","format":"date","description":"Return date","example":"2025-06-15"},"departureLocation":{"type":"string","description":"Departure location, if flight then provide IATA Airport Code","example":"Berlin"},"arrivalLocation":{"type":"string","description":"Arrival location, if flight then provide IATA Airport Code","example":"Madrid"},"destinationCountry":{"type":"string","description":"Destination country","example":"ES"},"travelCompany":{"type":"string","description":"Travel company name","example":"My Travel Company GmbH"},"travelerCount":{"type":"integer","format":"int64","description":"Total number of travelers","example":4},"buyerAmongTravelers":{"type":"boolean","description":"Is the buyer consumer among travelers?","example":true},"travelClass":{"type":"string","description":"The class of travel","example":"PREMIUM"},"travelInsured":{"type":"boolean","description":"Whether the travel is insured?","example":true},"travelDiscountVoucher":{"type":"string","description":"Travel discount voucher","example":"TWENTY-OFF"},"luggageSupplement":{"type":"boolean","description":"Whether availing luggage supplement?","example":true},"travelCanBeModifiedOrCanceled":{"type":"boolean","description":"Can the travel be modified or canceled?","example":true},"stayCompany":{"type":"string","description":"Stay company name","example":"Hotel XYZ"},"stayDestination":{"type":"string","description":"Stay destination","example":"Madrid"},"stayNightsCount":{"type":"integer","format":"int64","description":"Stay nights count","example":4},"stayRoomRange":{"type":"string","description":"Stay room category","example":"4_STARS"}}},"TravelIndustryDataRequest":{"allOf":[{"type":"object","properties":{"details":{"$ref":"#/components/schemas/TravelDetailsRequest"},"type":{"type":"string","description":"The `TRAVEL` industry data type","enum":["TRAVEL"]}}}]},"ChargeDiscardFailedEventRequestDetails":{"properties":{"paymentChargeId":{"type":"string","description":"The payment charge ID","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"paymentChargeStatus":{"type":"string","description":"The payment charge status","enum":["AUTHORIZATION_PROCESSING","AUTHORIZATION_ASYNC","AUTHENTICATION_PENDING","CAPTURE_PENDING","CAPTURE_PROCESSING","CAPTURED","REFUND_PROCESSING","REFUNDED","VOID_PROCESSING","VOIDED","DISCARDED","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment charge","example":"IDEAL"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"merchantPaymentChargeReference":{"type":"string","description":"A merchant-defined identifier that uniquely represents a single payment attempt","example":"merch_payment_ref_123"},"orderReferenceNumber":{"type":"string","description":"A merchant-defined identifier (e.g., invoice or order number) that remains the same across all payment attempts for the same order","example":"order_ref_123"},"type":{"type":"string","description":"The payment charge event type","example":"PAYMENT_CHARGE_DISCARD_FAILED"},"paymentSessionId":{"type":"string","description":"The associated payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"discardType":{"type":"string","description":"The payment discard ID.","enum":["AUTHENTICATION_TIMEOUT","PROVIDER_CONFIRMATION_TIMEOUT","MERCHANT_INITIATED_DISCARD"],"example":"MERCHANT_INITIATED_DISCARD"},"authorizationId":{"type":"string","description":"The authorization ID","example":"authz_l1hJpcLJGMyiafx1QdCqr"},"amount":{"$ref":"#/components/schemas/MoneyRequest"},"merchantDiscardReference":{"type":"string","description":"The merchant provided discard reference","example":"merch_payment_ref_123"}}},"ChargeDiscardSucceedEventRequestDetails":{"properties":{"paymentChargeId":{"type":"string","description":"The payment charge ID","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"paymentChargeStatus":{"type":"string","description":"The payment charge status","enum":["AUTHORIZATION_PROCESSING","AUTHORIZATION_ASYNC","AUTHENTICATION_PENDING","CAPTURE_PENDING","CAPTURE_PROCESSING","CAPTURED","REFUND_PROCESSING","REFUNDED","VOID_PROCESSING","VOIDED","DISCARDED","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment charge","example":"IDEAL"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"merchantPaymentChargeReference":{"type":"string","description":"A merchant-defined identifier that uniquely represents a single payment attempt","example":"merch_payment_ref_123"},"orderReferenceNumber":{"type":"string","description":"A merchant-defined identifier (e.g., invoice or order number) that remains the same across all payment attempts for the same order","example":"order_ref_123"},"type":{"type":"string","description":"The payment charge event type","example":"PAYMENT_CHARGE_DISCARDED"},"paymentSessionId":{"type":"string","description":"The associated payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"discardType":{"type":"string","description":"The payment discard ID.","enum":["AUTHENTICATION_TIMEOUT","PROVIDER_CONFIRMATION_TIMEOUT","MERCHANT_INITIATED_DISCARD"],"example":"MERCHANT_INITIATED_DISCARD"},"authorizationId":{"type":"string","description":"The authorization ID","example":"authz_l1hJpcLJGMyiafx1QdCqr"},"amount":{"$ref":"#/components/schemas/MoneyRequest"},"merchantDiscardReference":{"type":"string","description":"The merchant provided discard reference","example":"merch_payment_ref_123"}}},"ChargeProviderConfirmationPendingEventRequestDetails":{"properties":{"paymentChargeId":{"type":"string","description":"The payment charge ID","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"paymentChargeStatus":{"type":"string","description":"The payment charge status","enum":["AUTHORIZATION_PROCESSING","AUTHORIZATION_ASYNC","AUTHENTICATION_PENDING","CAPTURE_PENDING","CAPTURE_PROCESSING","CAPTURED","REFUND_PROCESSING","REFUNDED","VOID_PROCESSING","VOIDED","DISCARDED","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment charge","example":"IDEAL"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"merchantPaymentChargeReference":{"type":"string","description":"A merchant-defined identifier that uniquely represents a single payment attempt","example":"merch_payment_ref_123"},"orderReferenceNumber":{"type":"string","description":"A merchant-defined identifier (e.g., invoice or order number) that remains the same across all payment attempts for the same order","example":"order_ref_123"},"type":{"type":"string","description":"The payment charge event type","example":"PAYMENT_CHARGE_PROVIDER_CONFIRMATION_PENDING"},"paymentSessionId":{"type":"string","description":"The associated payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"authorizationId":{"type":"string","description":"The authorization ID","example":"authz_l1hJpcLJGMyiafx1QdCqr"},"amount":{"$ref":"#/components/schemas/MoneyRequest"}}},"ChargeRefundFailedEventRequestDetails":{"properties":{"paymentChargeId":{"type":"string","description":"The payment charge ID","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"paymentChargeStatus":{"type":"string","description":"The payment charge status","enum":["AUTHORIZATION_PROCESSING","AUTHORIZATION_ASYNC","AUTHENTICATION_PENDING","CAPTURE_PENDING","CAPTURE_PROCESSING","CAPTURED","REFUND_PROCESSING","REFUNDED","VOID_PROCESSING","VOIDED","DISCARDED","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment charge","example":"IDEAL"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"merchantPaymentChargeReference":{"type":"string","description":"A merchant-defined identifier that uniquely represents a single payment attempt","example":"merch_payment_ref_123"},"orderReferenceNumber":{"type":"string","description":"A merchant-defined identifier (e.g., invoice or order number) that remains the same across all payment attempts for the same order","example":"order_ref_123"},"type":{"type":"string","description":"The payment charge event type","example":"PAYMENT_CHARGE_REFUND_FAILED"},"paymentSessionId":{"type":"string","description":"The associated payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"refundId":{"type":"string","description":"The refund ID","example":"refund_jnFgrjBcmhTz2jLNKtXZq"},"amount":{"$ref":"#/components/schemas/MoneyRequest"},"failure":{"$ref":"#/components/schemas/ProcessingFailureRequest"},"merchantRefundReference":{"type":"string","description":"The merchant provided refund reference","example":"merch_refund_ref_123"}}},"ChargeRefundPendingEventRequestDetails":{"properties":{"paymentChargeId":{"type":"string","description":"The payment charge ID","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"paymentChargeStatus":{"type":"string","description":"The payment charge status","enum":["AUTHORIZATION_PROCESSING","AUTHORIZATION_ASYNC","AUTHENTICATION_PENDING","CAPTURE_PENDING","CAPTURE_PROCESSING","CAPTURED","REFUND_PROCESSING","REFUNDED","VOID_PROCESSING","VOIDED","DISCARDED","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment charge","example":"IDEAL"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"merchantPaymentChargeReference":{"type":"string","description":"A merchant-defined identifier that uniquely represents a single payment attempt","example":"merch_payment_ref_123"},"orderReferenceNumber":{"type":"string","description":"A merchant-defined identifier (e.g., invoice or order number) that remains the same across all payment attempts for the same order","example":"order_ref_123"},"type":{"type":"string","description":"The payment charge event type","example":"PAYMENT_CHARGE_REFUND_PENDING"},"paymentSessionId":{"type":"string","description":"The associated payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"refundId":{"type":"string","description":"The refund ID","example":"refund_jnFgrjBcmhTz2jLNKtXZq"},"amount":{"$ref":"#/components/schemas/MoneyRequest"},"merchantRefundReference":{"type":"string","description":"The merchant provided refund reference","example":"merch_refund_ref_123"}}},"ChargeRefundSucceededEventRequestDetails":{"properties":{"paymentChargeId":{"type":"string","description":"The payment charge ID","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"paymentChargeStatus":{"type":"string","description":"The payment charge status","enum":["AUTHORIZATION_PROCESSING","AUTHORIZATION_ASYNC","AUTHENTICATION_PENDING","CAPTURE_PENDING","CAPTURE_PROCESSING","CAPTURED","REFUND_PROCESSING","REFUNDED","VOID_PROCESSING","VOIDED","DISCARDED","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment charge","example":"IDEAL"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"merchantPaymentChargeReference":{"type":"string","description":"A merchant-defined identifier that uniquely represents a single payment attempt","example":"merch_payment_ref_123"},"orderReferenceNumber":{"type":"string","description":"A merchant-defined identifier (e.g., invoice or order number) that remains the same across all payment attempts for the same order","example":"order_ref_123"},"type":{"type":"string","description":"The payment charge event type","example":"PAYMENT_CHARGE_REFUND_SUCCEEDED"},"paymentSessionId":{"type":"string","description":"The associated payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"refundId":{"type":"string","description":"The refund ID","example":"refund_jnFgrjBcmhTz2jLNKtXZq"},"amount":{"$ref":"#/components/schemas/MoneyRequest"},"merchantRefundReference":{"type":"string","description":"The merchant provided refund reference","example":"merch_refund_ref_123"}}},"ChargeVoidFailedEventRequestDetails":{"properties":{"paymentChargeId":{"type":"string","description":"The payment charge ID","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"paymentChargeStatus":{"type":"string","description":"The payment charge status","enum":["AUTHORIZATION_PROCESSING","AUTHORIZATION_ASYNC","AUTHENTICATION_PENDING","CAPTURE_PENDING","CAPTURE_PROCESSING","CAPTURED","REFUND_PROCESSING","REFUNDED","VOID_PROCESSING","VOIDED","DISCARDED","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment charge","example":"IDEAL"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"merchantPaymentChargeReference":{"type":"string","description":"A merchant-defined identifier that uniquely represents a single payment attempt","example":"merch_payment_ref_123"},"orderReferenceNumber":{"type":"string","description":"A merchant-defined identifier (e.g., invoice or order number) that remains the same across all payment attempts for the same order","example":"order_ref_123"},"type":{"type":"string","description":"The payment charge event type","example":"PAYMENT_CHARGE_VOID_FAILED"},"paymentSessionId":{"type":"string","description":"The associated payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"voidId":{"type":"string","description":"The void ID","example":"void_JXYpfzt0OERhqGKH9JVMf"},"amount":{"$ref":"#/components/schemas/MoneyRequest"},"failure":{"$ref":"#/components/schemas/ProcessingFailureRequest"},"merchantVoidReference":{"type":"string","description":"The merchant provided void reference","example":"merch_void_ref_123"}}},"ChargeVoidSucceededEventRequestDetails":{"properties":{"paymentChargeId":{"type":"string","description":"The payment charge ID","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"paymentChargeStatus":{"type":"string","description":"The payment charge status","enum":["AUTHORIZATION_PROCESSING","AUTHORIZATION_ASYNC","AUTHENTICATION_PENDING","CAPTURE_PENDING","CAPTURE_PROCESSING","CAPTURED","REFUND_PROCESSING","REFUNDED","VOID_PROCESSING","VOIDED","DISCARDED","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment charge","example":"IDEAL"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"merchantPaymentChargeReference":{"type":"string","description":"A merchant-defined identifier that uniquely represents a single payment attempt","example":"merch_payment_ref_123"},"orderReferenceNumber":{"type":"string","description":"A merchant-defined identifier (e.g., invoice or order number) that remains the same across all payment attempts for the same order","example":"order_ref_123"},"type":{"type":"string","description":"The payment charge event type","example":"PAYMENT_CHARGE_VOID_SUCCEEDED"},"paymentSessionId":{"type":"string","description":"The associated payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"voidId":{"type":"string","description":"The void ID","example":"void_JXYpfzt0OERhqGKH9JVMf"},"amount":{"$ref":"#/components/schemas/MoneyRequest"},"merchantVoidReference":{"type":"string","description":"The merchant provided void reference","example":"merch_void_ref_123"}}},"FundsStateChangedEventRequestDetails":{"properties":{"paymentChargeId":{"type":"string","description":"The payment charge ID","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"paymentChargeStatus":{"type":"string","description":"The payment charge status","enum":["AUTHORIZATION_PROCESSING","AUTHORIZATION_ASYNC","AUTHENTICATION_PENDING","CAPTURE_PENDING","CAPTURE_PROCESSING","CAPTURED","REFUND_PROCESSING","REFUNDED","VOID_PROCESSING","VOIDED","DISCARDED","FAILED"]},"paymentMethod":{"type":"string","description":"The payment method which was used to process the payment charge","example":"IDEAL"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"merchantPaymentChargeReference":{"type":"string","description":"A merchant-defined identifier that uniquely represents a single payment attempt","example":"merch_payment_ref_123"},"orderReferenceNumber":{"type":"string","description":"A merchant-defined identifier (e.g., invoice or order number) that remains the same across all payment attempts for the same order","example":"order_ref_123"},"type":{"type":"string","description":"The payment charge event type","example":"FUNDS_STATE_CHANGED"},"paymentSessionId":{"type":"string","description":"The associated payment session ID","example":"sess_33VIoHGUuqZ7hT96gdIoS"},"paymentOperationId":{"type":"string","description":"The operation ID","example":"capture_67Ml6cOgDTXOcZh4qpgrc"},"paymentOperationType":{"type":"string","description":"The operation type","enum":["CAPTURE","REFUND"],"example":"CAPTURE"},"fundsState":{"type":"string","description":"The funds state","enum":["CAPTURE_FUNDS_NOT_EXPECTED","CAPTURE_FUNDS_MISSING","CAPTURE_FUNDS_WAITING","CAPTURE_FUNDS_RECEIVED","REFUND_FUNDS_NOT_EXPECTED","REFUND_FUNDS_REJECTED","REFUND_FUNDS_WAITING","REFUND_FUNDS_SENT"],"example":"CAPTURE_FUNDS_RECEIVED"},"amount":{"$ref":"#/components/schemas/Money"},"merchantRefundReference":{"type":"string","description":"The merchant provided refund reference","example":"merch_refund_ref_123"}}},"Money":{"description":"The operation amount","properties":{"value":{"type":"integer","format":"int64","description":"The monetary value to be charged or processed, expressed in the smallest currency unit (e.g., cents for EUR).","example":1000},"currency":{"type":"string","description":"The three-letter ISO 4217 currency code representing the currency in which the amount is denominated","example":"EUR","maxLength":3,"minLength":3}},"required":["currency","value"]},"InstrumentCreatedEventRequestDetails":{"description":"Payment Instrument Created webhook payload","properties":{"paymentInstrumentId":{"type":"string","description":"The payment instrument ID","example":"instr_mR082D5QAhP5hMTNjhbHl"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"details":{"$ref":"#/components/schemas/InstrumentDetailsRequest"}}},"InstrumentDeletedEventRequestDetails":{"description":"Payment Instrument Deleted webhook payload","properties":{"paymentInstrumentId":{"type":"string","description":"The payment instrument ID","example":"instr_mR082D5QAhP5hMTNjhbHl"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"deleteTimestamp":{"type":"string","format":"date-time","description":"The instrument deletion timestamp","example":"2026-06-03T11:23:47.123Z"}}},"InstrumentUpdatedEventRequestDetails":{"description":"Payment Instrument Details Updated webhook payload","properties":{"paymentInstrumentId":{"type":"string","description":"The payment instrument ID","example":"instr_mR082D5QAhP5hMTNjhbHl"},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"updateTimestamp":{"type":"string","format":"date-time","description":"The instrument update timestamp","example":"2026-06-03T11:23:47.123Z"},"details":{"$ref":"#/components/schemas/InstrumentDetailsRequest"}}},"ReportsExpiredEventRequestDetails":{"properties":{"reportId":{"type":"string","description":"The report ID.","example":"report_YiphBt4YBzNrAa0c9K5u6"},"status":{"type":"string","description":"The report status","enum":["PENDING","PROCESSED","FAILED","EXPIRED"]},"operationType":{"type":"string","description":"The report operation type","enum":["AUTHORIZATION","CAPTURE","REFUND","VOID","DISCARD"]},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"startDate":{"type":"string","format":"date-time","description":"The report cutoff start date in ISO 8601 format","example":"2026-06-03T11:23:47.123Z"},"endDate":{"type":"string","format":"date-time","description":"The report cutoff end date in ISO 8601 format","example":"2026-06-03T11:23:47.123Z"}}},"ReportsFailedEventRequestDetails":{"properties":{"reportId":{"type":"string","description":"The report ID.","example":"report_YiphBt4YBzNrAa0c9K5u6"},"status":{"type":"string","description":"The report status","enum":["PENDING","PROCESSED","FAILED","EXPIRED"]},"operationType":{"type":"string","description":"The report operation type","enum":["AUTHORIZATION","CAPTURE","REFUND","VOID","DISCARD"]},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"startDate":{"type":"string","format":"date-time","description":"The report cutoff start date in ISO 8601 format","example":"2026-06-03T11:23:47.123Z"},"endDate":{"type":"string","format":"date-time","description":"The report cutoff end date in ISO 8601 format","example":"2026-06-03T11:23:47.123Z"}}},"ReportsProcessedEventRequestDetails":{"properties":{"reportId":{"type":"string","description":"The report ID.","example":"report_YiphBt4YBzNrAa0c9K5u6"},"status":{"type":"string","description":"The report status","enum":["PENDING","PROCESSED","FAILED","EXPIRED"]},"operationType":{"type":"string","description":"The report operation type","enum":["AUTHORIZATION","CAPTURE","REFUND","VOID","DISCARD"]},"merchantId":{"type":"string","description":"The merchant ID","example":"merch-123"},"startDate":{"type":"string","format":"date-time","description":"The report cutoff start date in ISO 8601 format","example":"2026-06-03T11:23:47.123Z"},"endDate":{"type":"string","format":"date-time","description":"The report cutoff end date in ISO 8601 format","example":"2026-06-03T11:23:47.123Z"},"downloadUrl":{"type":"string","description":"The report download URL"},"contentLength":{"type":"integer","format":"int64","description":"The report content length in bytes"}}}}},"webhooks":{"Agreement Active":{"post":{"tags":["Payment Agreements"],"description":"Sent on Payment Agreement activation","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_AGREEMENT_ACTIVE"},"subject":{"type":"string","description":"The event subject","example":"agr_BlTZQyHL9DeUYPYtXmOdq"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/AgreementActiveEventRequestDetails","description":"The event business payload"}}}}}}}},"Agreement Authentication Pending":{"post":{"tags":["Payment Agreements"],"description":"Sent when the Payment Agreement is pending authentication","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_AGREEMENT_AUTHENTICATION_PENDING"},"subject":{"type":"string","description":"The event subject","example":"agr_BlTZQyHL9DeUYPYtXmOdq"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/AgreementAuthenticationPendingEventRequestDetails","description":"The event business payload"}}}}}}}},"Agreement Created":{"post":{"tags":["Payment Agreements"],"description":"Sent when the Payment Agreement is created","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_AGREEMENT_CREATED"},"subject":{"type":"string","description":"The event subject","example":"agr_BlTZQyHL9DeUYPYtXmOdq"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/AgreementCreatedEventRequestDetails","description":"The event business payload"}}}}}}}},"Agreement Failed":{"post":{"tags":["Payment Agreements"],"description":"Sent when the Payment Agreement fails","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_AGREEMENT_FAILED"},"subject":{"type":"string","description":"The event subject","example":"agr_BlTZQyHL9DeUYPYtXmOdq"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/AgreementFailedEventRequestDetails","description":"The event business payload"}}}}}}}},"Agreement Revoked by Consumer":{"post":{"tags":["Payment Agreements"],"description":"Sent when the Payment Agreement is revoked by the consumer","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_AGREEMENT_REVOKED_BY_CONSUMER"},"subject":{"type":"string","description":"The event subject","example":"agr_BlTZQyHL9DeUYPYtXmOdq"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/AgreementRevokedByConsumerEventRequestDetails","description":"The event business payload"}}}}}}}},"Agreement Revoked by Merchant":{"post":{"tags":["Payment Agreements"],"description":"Sent when the Payment Agreement is revoked by the merchant","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_AGREEMENT_REVOKED_BY_MERCHANT"},"subject":{"type":"string","description":"The event subject","example":"agr_BlTZQyHL9DeUYPYtXmOdq"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/AgreementRevokedByMerchantEventRequestDetails","description":"The event business payload"}}}}}}}},"Agreement Revoked by Provider":{"post":{"tags":["Payment Agreements"],"description":"Sent when the Payment Agreement is revoked by the provider","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_AGREEMENT_REVOKED_BY_PROVIDER"},"subject":{"type":"string","description":"The event subject","example":"agr_BlTZQyHL9DeUYPYtXmOdq"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/AgreementRevokedByProviderEventRequestDetails","description":"The event business payload"}}}}}}}},"Agreement Updated":{"post":{"tags":["Payment Agreements"],"description":"Sent when the Payment Agreement is updated","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_AGREEMENT_UPDATED"},"subject":{"type":"string","description":"The event subject","example":"agr_BlTZQyHL9DeUYPYtXmOdq"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/AgreementUpdatedEventRequestDetails","description":"The event business payload"}}}}}}}},"Chargeback Succeeded":{"post":{"tags":["Chargebacks"],"description":"Sent on Chargeback success","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"CHARGEBACK_SUCCEEDED"},"subject":{"type":"string","description":"The event subject","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/ChargebackSucceededEventRequestDetails","description":"The event business payload"}}}}}}}},"Charge Authentication Pending":{"post":{"tags":["Payment Charges"],"description":"Sent when the Payment Charge is pending authentication","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_CHARGE_AUTHENTICATION_PENDING"},"subject":{"type":"string","description":"The event subject","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/ChargeAuthenticationPendingEventRequestDetails","description":"The event business payload"}}}}}}}},"Charge Authorization Failed":{"post":{"tags":["Payment Charges"],"description":"Sent when the Payment Charge authorization fails","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_CHARGE_AUTHORIZATION_FAILED"},"subject":{"type":"string","description":"The event subject","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/ChargeAuthorizationFailedEventRequestDetails","description":"The event business payload"}}}}}}}},"Charge Authorization Succeeded":{"post":{"tags":["Payment Charges"],"description":"Sent when the Payment Charge authorization succeeds","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_CHARGE_AUTHORIZATION_SUCCEEDED"},"subject":{"type":"string","description":"The event subject","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/ChargeAuthorizationSucceededEventRequestDetails","description":"The event business payload"}}}}}}}},"Charge Capture Failed":{"post":{"tags":["Payment Charges"],"description":"Sent when the Payment Charge capture fails","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_CHARGE_CAPTURE_FAILED"},"subject":{"type":"string","description":"The event subject","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/ChargeCaptureFailedEventRequestDetails","description":"The event business payload"}}}}}}}},"Charge Capture Succeeded":{"post":{"tags":["Payment Charges"],"description":"Sent when the Payment Charge capture succeeds","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_CHARGE_CAPTURE_SUCCEEDED"},"subject":{"type":"string","description":"The event subject","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/ChargeCaptureSucceededEventRequestDetails","description":"The event business payload"}}}}}}}},"Charge Created":{"post":{"tags":["Payment Charges"],"description":"Sent when the Payment Charge creation succeeds","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_CHARGE_CREATED"},"subject":{"type":"string","description":"The event subject","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/ChargeCreatedEventRequestDetails","description":"The event business payload"}}}}}}}},"Charge Discard Failed":{"post":{"tags":["Payment Charges"],"description":"Sent when the Payment Charge discard fails","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_CHARGE_DISCARD_FAILED"},"subject":{"type":"string","description":"The event subject","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/ChargeDiscardFailedEventRequestDetails","description":"The event business payload"}}}}}}}},"Charge Discard Succeeded":{"post":{"tags":["Payment Charges"],"description":"Sent when the Payment Charge discard succeeds","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_CHARGE_DISCARDED"},"subject":{"type":"string","description":"The event subject","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/ChargeDiscardSucceedEventRequestDetails","description":"The event business payload"}}}}}}}},"Charge Provider Confirmation Pending":{"post":{"tags":["Payment Charges"],"description":"Sent when the Payment Charge is pending provider confirmation","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_CHARGE_PROVIDER_CONFIRMATION_PENDING"},"subject":{"type":"string","description":"The event subject","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/ChargeProviderConfirmationPendingEventRequestDetails","description":"The event business payload"}}}}}}}},"Charge Refund Failed":{"post":{"tags":["Payment Charges"],"description":"Sent when the Payment Charge refund fails","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_CHARGE_REFUND_FAILED"},"subject":{"type":"string","description":"The event subject","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/ChargeRefundFailedEventRequestDetails","description":"The event business payload"}}}}}}}},"Charge Refund Pending":{"post":{"tags":["Payment Charges"],"description":"Sent when the Payment Charge refund is pending","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_CHARGE_REFUND_PENDING"},"subject":{"type":"string","description":"The event subject","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/ChargeRefundPendingEventRequestDetails","description":"The event business payload"}}}}}}}},"Charge Refund Succeeded":{"post":{"tags":["Payment Charges"],"description":"Sent when the Payment Charge refund succeeds","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_CHARGE_REFUND_SUCCEEDED"},"subject":{"type":"string","description":"The event subject","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/ChargeRefundSucceededEventRequestDetails","description":"The event business payload"}}}}}}}},"Charge Void Failed":{"post":{"tags":["Payment Charges"],"description":"Sent when the Payment Charge void fails","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_CHARGE_VOID_FAILED"},"subject":{"type":"string","description":"The event subject","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/ChargeVoidFailedEventRequestDetails","description":"The event business payload"}}}}}}}},"Charge Void Succeeded":{"post":{"tags":["Payment Charges"],"description":"Sent when the Payment Charge void succeeds","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_CHARGE_VOID_SUCCEEDED"},"subject":{"type":"string","description":"The event subject","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/ChargeVoidSucceededEventRequestDetails","description":"The event business payload"}}}}}}}},"Funds State Changed":{"post":{"tags":["Fund Statuses"],"description":"Sent when the Payment Charge funds state changes","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"FUNDS_STATE_CHANGED"},"subject":{"type":"string","description":"The event subject","example":"charge_mXC6KnPKOY6MuyBf7dwaY"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/FundsStateChangedEventRequestDetails","description":"The event business payload"}}}}}}}},"Instrument Created":{"post":{"tags":["Payment Instruments"],"description":"Sent on Payment Instrument creation","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_INSTRUMENT_CREATED"},"subject":{"type":"string","description":"The event subject","example":"instr_mR082D5QAhP5hMTNjhbHl"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/InstrumentCreatedEventRequestDetails","description":"The event business payload"}}}}}}}},"Instrument Deleted":{"post":{"tags":["Payment Instruments"],"description":"Sent on Payment Instrument deletion","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_INSTRUMENT_DELETED"},"subject":{"type":"string","description":"The event subject","example":"instr_mR082D5QAhP5hMTNjhbHl"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/InstrumentDeletedEventRequestDetails","description":"The event business payload"}}}}}}}},"Instrument Details Updated":{"post":{"tags":["Payment Instruments"],"description":"Sent on Payment Instrument details update","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"PAYMENT_INSTRUMENT_DETAILS_UPDATED"},"subject":{"type":"string","description":"The event subject","example":"instr_mR082D5QAhP5hMTNjhbHl"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/InstrumentUpdatedEventRequestDetails","description":"The event business payload"}}}}}}}},"Report Expired":{"post":{"tags":["Payment Reports"],"description":"Sent when a Report expires","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"REPORT_EXPIRED"},"subject":{"type":"string","description":"The event subject","example":"report_YiphBt4YBzNrAa0c9K5u6"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/ReportsExpiredEventRequestDetails","description":"The event business payload"}}}}}}}},"Report Processing Failed":{"post":{"tags":["Payment Reports"],"description":"Sent when a Report fails to process","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"REPORT_FAILED"},"subject":{"type":"string","description":"The event subject","example":"report_YiphBt4YBzNrAa0c9K5u6"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/ReportsFailedEventRequestDetails","description":"The event business payload"}}}}}}}},"Report Processed":{"post":{"tags":["Payment Reports"],"description":"Sent when a Report is processed","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The root payload envelope sent by the webhook.","properties":{"specversion":{"type":"string","description":"The CloudEvents specification version","example":"1.0.2"},"source":{"type":"string","description":"The event source","example":"https://www.ppro.com"},"datacontenttype":{"type":"string","description":"The event content type","example":"application/json"},"id":{"type":"string","description":"The event ID","example":"DBmK364tFeNGuHIJM9Fb4"},"type":{"type":"string","description":"The event type","example":"REPORT_PROCESSED"},"subject":{"type":"string","description":"The event subject","example":"report_YiphBt4YBzNrAa0c9K5u6"},"time":{"type":"string","description":"The event timestamp","example":"2026-06-03T11:23:47.123Z"},"data":{"$ref":"#/components/schemas/ReportsProcessedEventRequestDetails","description":"The event business payload"}}}}}}}}}}