API Reference

About

Wpay

Contact

Documentation Hub

Get a list of events related to processing a transaction.

List events for transaction

This event logs the reason why we were unable to get an anti-fraud decision.

The unique ID of the anti-fraud service used.

The reason we could not get the anti-fraud decision.

The HTTP response status code from the anti-fraud provider, if we received any.

The date and time when this transaction was created in our system.

The name of this resource. Is always `anti-fraud-decision-error`.

The type of this resource. Is always `transaction-event`.

Anti-fraud - Error

This event logs the request and response details of HTTP calls made to an anti-fraud provider.

The parsed decision response from the anti-fraud provider response.

The HTTP body received from the anti-fraud provider.

The HTTP response status code from the anti-fraud provider.

The name of this resource. Is always `anti-fraud-decision`.

Anti-fraud - Decision

This event logs the reason why we skipped getting an anti-fraud decision.

The name of this resource. Is always `anti-fraud-decision-skipped`.

Anti-fraud - Skipped

This event logs the failure reason when attempting to update the decision on the anti-fraud provider.

The updated decision sent to the anti-fraud provider.

The reason we could not update the anti-fraud decision.

The date and time when this transaction event was created in our system.

The name of this resource. Is always `anti-fraud-decision-update-error`.

Anti-fraud - Decision update failed

This event logs the request and response details of HTTP calls made to an anti-fraud provider to update a decision.

The name of this resource. Is always `anti-fraud-decision-update`.

Anti-fraud - Decision update sent

This event logs the reason why we were unable to update an anti-fraud transaction.

The name of this resource. Is always `anti-fraud-transaction-status-update-error`.

Anti-fraud - Transaction update failed

This event logs the request and response details of HTTP calls made to an anti-fraud provider to update a transaction.

The name of this resource. Is always `anti-fraud-transaction-status-update`.

Anti-fraud - Transaction update sent

This event logs the webhook received when an anti-fraud decision is updated.

The external ID of the decision that's being updated.

Any comment that may have come with the webhook event.

The content type of the payload sent as a webhook.

The parsed decision response from the anti-fraud provider webhook.

The name of this resource. Is always `anti-fraud-webhook`.

Anti-fraud - Webhook

The result and raw data for a card BIN lookup.

The card additional schemes from the lookup response.

The card country code result from the lookup response.

The instrument type used to lookup BIN details.

The response body received from the `url`.

The response status code received from the `url`.

The card scheme result from the lookup response.

Whether the BIN lookup was successful or not.

Whether the issuing bank supports network tokenization for this card.

The type of card, i.e. credit or debit, from the lookup response.

The name of this resource. Is always `bin-lookup-request`.

BIN Lookup Request

The result after decrypting an Apple Pay token.

Hash of the application data property of the original request.

ISO 4217 numeric currency code for the transaction.

Hex-encoded device manufacturer identifier which initiated the transaction.

Online payment cryptogram, as defined by 3D Secure.

For a merchant token request, the provisioned merchant token identifier from the payment network.

Version information about the payment token.

The name of this resource. Is always `digital-wallet-apple-pay-token-decrypted`.

Digital wallet Apple Pay token decrypted

The result after decrypting an Click to Pay token.

Online payment cryptogram, as defined by 3-D Secure.

Merchant Checkout Transaction Identifier which links the client-side JavaScript calls and server-side API calls for a specific transaction.

The name of this resource. Is always `digital-wallet-click-to-pay-token-decrypted`.

Digital wallet Click to Pay token decrypted

The result after decrypting an Google Pay token.

Date and time at which the message expires as UTC milliseconds since epoch.

A unique ID that identifies the message in case it needs to be revoked or located at a later time.

The name of this resource. Is always `digital-wallet-google-pay-token-decrypted`.

Digital wallet Google Pay token decrypted

Additional detail about the part of a request body that caused an issue.

The location where the error caused an issue.

A human readable message for this error detail.

The exact item for which the validation did not succeed. This is a JSON
pointer for request bodies, while for query, path, and header parameters
it is the name of the parameter.

A unique identifier for the type of error that occurred.

Error details

This event logs the request and response details of HTTP calls made to redeem gift cards, in case the call failed.

The unique ID of the Gift Card service used.

The reason we could not redeem the gift cards.

The HTTP body sent to the Gift Card provider, if performed.

The HTTP body received from the Gift Card provider, if any.

The HTTP response status code from the Gift Card provider, if any.

The endpoint for the request, if performed.

The date and time when this event was created in our system.

The name of this resource. Is always `gift-card-redemption-failed`.

Gift Cards Redemption - Failure

This event logs the request and response details of HTTP calls made to redeem gift cards, in case the call succeeded.

The HTTP body sent to the Gift Card provider.

The HTTP body received from the Gift Card provider.

The HTTP response status code from the Gift Card provider.

The name of this resource. Is always `gift-card-redemption-succeeded`.

Gift Cards Redemption - Succeeded

This event logs the request and response details of HTTP calls made to refund gift cards, in case the call failed.

The reason we could not refund the gift cards.

The name of this resource. Is always `gift-card-refund-failed`.

Gift Cards Refund - Failed

This event logs the request and response details of HTTP calls made to refund gift cards, in case the call succeeded.

The name of this resource. Is always `gift-card-refund-succeeded`.

Gift Cards Refund - Succeeded

This event logs the request and response details of HTTP calls made to provision a cryptogram for a network token, in case the call failed.

The reason we could not provision the cryptogram.

The HTTP body sent to the Network Token provider, if performed.

The HTTP body received from the Network Token provider, if any.

The HTTP response status code from the Network Token provider, if any.

The name of this resource. Is always `network-token-cryptogram-provision-failed`.

Network Token Cryptogram Provision - Failure

This event logs the request and response details of HTTP calls made to provision a cryptogram for a network token, in case the call succeeded.

The HTTP body sent to the Network Token provider.

The HTTP body received from the Network Token provider.

The HTTP response status code from the Network Token provider.

The name of this resource. Is always `network-token-cryptogram-provision-succeeded`.

Network Token Cryptogram Provision - Succeeded

This event logs the request and response details of HTTP calls made to provision a network token, in case the call failed.

The reason we could not provision the network token.

The name of this resource. Is always `network-token-provision-failed`.

Network Token Provision - Failure

This event logs the request and response details of HTTP calls made to provision a network token, in case the call succeeded.

The name of this resource. Is always `network-token-provision-succeeded`.

Network Token Provision - Succeeded

This event logs the exact details parsed details for an external
transaction request.

The ID of the refund, in case this links to a refund.

The name of this resource. Is always `payment-connector-external-transaction-request`.

External Transaction Request

This event logs the exact details for the settlement
of a transaction as sourced from a connector report.

The net amount settled for this transaction.

The total commission paid on this transaction, expressed in `currency`.

The currency of this transaction's settlement in
ISO 4217 three-letter code format.

The exchange rate used to convert amounts from the
processing currency to the settlement currency.

The date and time when information about this transaction's
settlement was ingested into our system.

The interchange fee for this transaction, expressed in `currency`.

The markup applied to this transaction by the acquirer, expressed in `currency`.

The display name of the payment service used.

The unique ID of the payment service used.

The list of payment service report file IDs that make up the
payment service report containing this transaction's settlement.

The ID of the payment service report containing
this transaction's settlement.

The external ID of the transaction as set by the payment service.

The date and time when this transaction was settled.

The scheme fee for this transaction, expressed in `currency`.

The unique ID of this transaction's settlement.

The name of this resource. Is always
`payment-connector-report-transaction-settled`.

Settlement - Sourced from Connector Report

This event logs the exact details parsed details for a failed authorization
as reported by our connector.

The response code received from the payment service for the Address
Verification Check (AVS). This code is mapped to a standardized Gr4vy
AVS response code.

- `no_match` - neither address or postal code match
- `match` - both address and postal code match
- `partial_match_address` - address matches but postal code does not
- `partial_match_postcode` - postal code matches but address does not
- `unavailable ` - AVS is unavailable for card/country

The value of this field can be `null` if the payment service did not
provide a response.

A raw response code returned for the failure.

The response code received from the payment service for the Card
Verification Value (CVV). This code is mapped to a standardized Gr4vy
CVV response code.

- `no_match` - the CVV does not match the expected value
- `match` - the CVV matches the expected value
- `unavailable ` - CVV check unavailable for card our country
- `not_provided ` - CVV not provided

The value of this field can be `null` if the payment service did not
provide a response.

The type of instrument used for this transaction.

This is the response code received from the payment service. This
can be set to any value and is not standardized across different
payment services.

This is the response description received from the payment service. This
can be set to any value and is not standardized across different
payment services.

Defines why the transaction might be retried. A retry is not guaranteed because
the maximum number of retries might already have been attempted.

* `failure` - the transaction will be retried because of a failure calling
  the payment service.
* `retriable_decline` - the transaction will be retried because a decline code
  was received that can be retried.
* `payment_method_replacement` - the transaction will be retried because a
  decline code was received that triggered a payment method replacement.

The new status code for the transaction. This is always
set to `authorization_failed`.

The name of this resource. Is always `payment-connector-response-transaction-authorization-failed`.

Authorization - Failed

This event logs the exact details parsed details for a succeeded authorization
as reported by our connector.

This will always be `null` because the transaction succeeded.

The new status code for the transaction. This is always
set to `authorization_succeeded`.

The name of this resource. Is always `payment-connector-response-transaction-authorization-succeeded`.

Authorization

This event logs the exact details parsed details for a declined capture
as reported by our connector.

The name of this resource. Is always `payment-connector-response-transaction-capture-declined`.

Capture - Declined

This event logs the exact details parsed details for a failed capture
as reported by our connector.

The name of this resource. Is always `payment-connector-response-transaction-capture-failed`.

Capture - Failed

This event logs the exact details parsed details for a succeeded capture
as reported by our connector.

The new status code for the transaction. This is always
set to `capture_succeeded`.

The name of this resource. Is always `payment-connector-response-transaction-capture-succeeded`.

Capture - Succeeded

This event logs the exact details parsed details for a declined transaction
as reported by our connector.

A raw response code returned for the decline.

The new status code for the transaction. This is always
set to `authorization_declined`.

The name of this resource. Is always `payment-connector-response-transaction-declined`.

Authorization - Declined

This event logs the exact details parsed details for a declined void
as reported by our connector.

The name of this resource. Is always `payment-connector-response-transaction-void-declined`.

Void - Declined

This event logs the exact details parsed details for a failed void
as reported by our connector.

The name of this resource. Is always `payment-connector-response-transaction-void-failed`.

Void - Failed

This event logs the exact details parsed details for a succeeded void
as reported by our connector.

The date and time when this transaction was voided.

The name of this resource. Is always `payment-connector-response-transaction-void-succeeded`.

Void - Succeeded

The result and raw data for a 3DS authorization call.

The 3DS CAVV value parsed from the `response`.

The `transStatus` parsed from the `response`.

The `dsTransID` parsed from the `response`.

The 3DS ECI value parsed from the `response`.

The URL that was called for this request.

The name of this resource. Is always `three-d-secure-authentication-request`.

3DS - Authentication

The result and raw data for a 3DS pre-authorization call.

The version of 3DS extracted from the `response.

The name of this resource. Is always `three-d-secure-preparation-request`.

Payments

Instruments

Vault

Connections

Dashboard

Errors

List events for transaction

Authorizations

Path Parameters

Response