Notification webhooks v1 - Result of refund request

Notification parameters

Required Optional

live string

Informs about the origin of the notification. The value is true when originating from the live environment, false for the test environment.

notificationItems array [object]

A container object for the details included in the notification.

Show children

additionalData object

A generic container for extra fields.

Show children

PaymentAccountReference string

Reference of the payment account.

acquirerAccountCode string

The acquirer account code.

acquirerCode string

The acquirer code.

acquirerReference string

The acquirer reference.

acsRenderingType.acsInterface string

ACS interface. Related to 3DS.

acsRenderingType.acsUiTemplate string

ACS UI template.

alias string

Alias for this card.

aliasType string

Alias type.

arn string

Acquirer Reference Number of the dispute.

authCode string

Authcode of the scheme.

authenticationType string

3DS authentication type

authorisationMid string

Authorisation MID of the acquirer.

authorisedAmountCurrency string

The currency authorised for a dynamic zero auth request.

authorisedAmountValue string

The amount authorised for a dynamic zero auth request.

avsResult string

Address Verification Service result.

avsResultRaw string

Address Verification Service result raw.

bankAccountNumber string

The bank account number.

bankLocation string

The bank location.

bankLocationId string

The bank location ID.

bankName string

The bank name.

bankVerificationResult string

The bank verificaiton result.

bankVerificationResultRaw string

The bank verification result raw.

bic string

Business Identifier Code.

billingAddress.city string

BillingAddress: county.

billingAddress.houseNumberOrName string

BillingAddress: house number or name.

billingAddress.postalCode string

BillingAddress: postal code.

billingAddress.stateOrProvince string

BillingAddress: state or province

billingAddress.street string

BillingAddress: street

browserCode string

Browser code.

captureDelayHours string

The amount of delay after authorisation.

captureMerchantReference string

The merchant reference of the capture.

capturePspReference string

The PSP reference of the capture.

cardBin string

Card Bank Identification number.

cardIssuingBank string

Card issuing bank.

cardIssuingCountry string

Card issuing country.

cardIssuingCurrency string

Card issuing currency.

cardPaymentMethod string

Card payment method.

cardSchemeEnhancedDataLevel string

Card scheme enhanced data level.

cardSummary string

Card summary

cavv string

Secure Cardholder Authentication Verification Value.

cavvAlgorithm string

CAVV algorithm.

challengeCancel string

Information about the 3DS challenge being canceled.

checkoutSessionId string

ID of the Checkout Session.

cvcResult string

Card Verification Code result.

cvcResultRaw string

Card Verification Code result raw.

deliveryAddress.city string

Delivery address: city.

deliveryAddress.country string

Delivery address: country.

deliveryAddress.houseNumberOrName string

Delivery address: house number or name.

deliveryAddress.postalCode string

Delivery address: postal code.

deliveryAddress.stateOrProvince string

Delivery address: state or province.

deliveryAddress.street string

Delivery address: street.

deviceType string

Type of device the request was made from.

directdebit_GB.dateOfSignature string

Direct debit GB: date of signature.

directdebit_GB.mandateId string

Direct debit GB: mandate ID.

directdebit_GB.sequenceType string

Direct debit GB: sequence type.

directdebit_GB.serviceUserName string

Direct debit GB: service user name.

directdebit_GB.serviceUserNumber string

Direct debit GB: service user number.

eci string

3DS: Electronic Commerce Indicator.

expiryDate string

Expiry date of the card.

extraCostsCurrency string

Additional cost used in BIN or card verification.

extraCostsValue string

Related additional cost value.

fraudCheck-<check ID>-<name> string

Information on the fraud check in a dynamic format.

fraudManualReview string

Indicates if the risk check was done manually.

fraudOffset string

The fraud offset.

fraudResultType string

Result type of the fraud check.

fundingSource string

Funding source.

grossCurrency string

Chargeback gross currency.

grossValue string

Chargeback gross value.

iban string

International Bank Account Number.

installments.value string

The number of installments that the payment amount should be charged with.

Example: 5

Only relevant for card payments in countries that support installments.

interactionCounter string

3DS interaction counter.

issuerComments.cardholderName string

Card holder name.

issuerCountry string

Country of the card issuer.

latestCard.bin string

Recurring: Latest card BIN.

latestCard.expiryDate string

Recurring: Latest card expiry date.

latestCard.summary string

Recurring: Latest card summary.

liabilityShift string

Risk liability shift.

metadata object

A set of key-value pairs provided in the request, prefixed with 'metadata.'. For example, 'metadata.myField: myValue'

networkToken.available string

Recurring related.

networkToken.bin string

Recurring related.

networkToken.tokenSummary string

Recurring related.

nfc.expire string

NFC related.

nfc.issue string

NFC related.

nfc.pin.provided string

NFC related.

nfc.uid string

NFC related.

opi.transToken string

Trans token related to Oracle Opera.

ownerCity string

Owner city.

ownerName string

Owner name.

payULatamTrazabilityCode string

Related to PayU in LATAM.

paymentLinkId string

ID of the Checkout payment link.

realtimeAccountUpdaterStatus string

Real time Account Update status.

recurring.contractTypes string

Recurring contract types.

recurring.firstPspReference string

Recurring first PSP reference.

recurring.recurringDetailReference string

recurring detail reference.

referred string

If the payment is referred, this field is set to true.

This field is unavailable if the payment is referred and is usually not returned with ecommerce transactions.

Example: true

refusalReasonRaw string

Raw refusal reason received from the acquirer, where available.

Example: AUTHORISED

retry.rescueScheduled string

Indicates if an auto rescue for a pyment is scheduled.

riskProfile string

Related to Risk.

riskProfileReference string

Related to Risk.

shopperCountry string

Country of the shopper.

shopperIP string

IP of the shopper.

shopperInteraction string

The shopper interaction type of the payment request.

Example: Ecommerce

shopperLocale string

The locale of the shopper.

shopperSocialSecurityNumber string

The social security number of the shopper.

shopperStatement string

The text to be shown on the shopper's bank statement.

shopperTelephone string

The telephone number of the shopper.

store string

Identifier of the store processing the transaction.

tenderReference string

Tender reference. For point-of-sale integrations only.

terminalId string

Terminal ID. For point-of-sale integrations only.

threeDAuthenticated string

A Boolean value indicating whether 3DS authentication was completed on this payment.

Example: true

threeDAuthenticatedResponse string

The raw 3DS authentication result from the card issuer.

Example: N

threeDOffered string

A Boolean value indicating whether 3DS was offered for this payment.

Example: true

threeDOfferedResponse string

The raw enrollment result from the 3DS directory services of the card schemes.

Example: Y

threeDSVersion string

The 3D Secure 2 version.

tokenTxVariant string

Payment method variant of the token/wallet payment method.

totalFraudScore string

Total fraud score from risk.

untokenisedCardSummary string

Card summary without tokenization.

xid string

The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the mpiData.xid, field.

Example: ODgxNDc2MDg2MDExODk5MAAAAAA=

amount object Required

The payment amount. For HTTP POST notifications, currency and value are returned as URL parameters.

Show children

eventCode string Required

The type of event the notification item is for.

eventDate string Required

The time when the event was generated. Format: ISO 8601; yyyy-MM-DDThh:mm:ssTZD

merchantAccountCode string Required

The merchant account identifier used in the transaction the notification item is for.

merchantReference string Required

Your reference to uniquely identify the payment.

paymentMethod string Required

The payment method used in the transaction.

pspReference string

Adyen's 16-character unique reference associated with the transaction or request. This value is globally unique. Use it when communicating with us about this request.

reason string

If success = false, then this includes a short message with an explanation for the refusal.

success string

Informs about the outcome of the event (eventCode) the notification is for. If true: the event was executed successfully. If false: the event was not executed successfully.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK

The request has succeeded.
Show more Show less
notificationResponse string

Set this parameter to [accepted] to acknowledge that you received a notification from Adyen.

Result of refund request

Notification parameters

Response parameters

HTTP Responses

200 - OK