# refused

Endpoint: POST refused
Version: 1

## Request body:

  - `application/vnd.worldpay.events-v1.hal+json` (unknown)
    Your payment request has been declined by a third party.

## Request fields (application/vnd.worldpay.events-v1.hal+json):

  - `eventId` (string)
    The unique identifier for the event.
    Example: bb55ca5a-e05c-47e1-8e94-e88bac1a0a17

  - `eventTimestamp` (string)
    Date of event.
    Example: 2018-06-13T14:18:13.407

  - `eventDetails` (object)

  - `eventDetails.classification` (string)
    The event category, this can either be payout, payment or chargeback.
    Example: payment

  - `eventDetails.downstreamReference` (string)
    A reference you can use for reconciliation purposes.
    Example: 3378792436

  - `eventDetails.orderReference` (string)
    A reference, generated by you, that you can apply to one or more payments according to your business needs. You may reuse the same reference across multiple payments, for example where:
- the total amount for a single order is split across multiple payments
- you use a single reference for each payment in a recurring agreement or split shipment scenario
    Example: my-order-ref

  - `eventDetails.transactionReference` (string)
    The transaction reference you supplied in the payment.
    Example: Memory265-13/08/1876

  - `eventDetails.paymentId` (string)
    Unique identifier generated by us for a single payment. Generated at authorization, and maintained through successive payment actions.
    Example: payI-dUcet9fk4_X4qZU0hpU0

  - `eventDetails.commandId` (string)
    Unique identifier generated by us for a single instance of an interaction (command) with our API.
    Example: cmd-Rjc4HJwnBdj3Ri9v10vT0

  - `eventDetails.merchant` (object)
    Merchant data.

  - `eventDetails.merchant.entity` (string)
    A merchant entity reference.
    Example: default

  - `eventDetails.type` (string)
    Event status. For example, `cancelled` or `sentForAuthorization`.
    Example: refused

  - `eventDetails.riskFactors` (array)

  - `eventDetails.riskFactors.type` (string)
    Enum: "cvc", "avs", "nameInquiry"

  - `eventDetails.riskFactors.risk` (string)
    Enum: "notChecked", "notMatched", "notSupplied", "partialMatched", "notSupported"

  - `eventDetails.riskFactors.detail` (string)
    Enum: "postcode", "address", "firstName", "middleName", "lastName"

  - `eventDetails.issuer` (object)
    Issuer data.

  - `eventDetails.issuer.authorizationCode` (string)
    An issuer authorization code.
    Example: T75725

  - `eventDetails.scheme` (object)
    Scheme related data.

  - `eventDetails.scheme.reference` (string)
    Scheme provided reference.
    Example: MCCOLXT1C0104  

  - `eventDetails.updatedPaymentInstrument` (object)
    Payment instrument update, if any.

  - `eventDetails.updatedPaymentInstrument.appliedNetworkToken` (boolean)
    Network token used.
    Example: true

  - `eventDetails.paymentInstrument` (object)
    Payment instrument information.

  - `eventDetails.paymentInstrument.cardBin` (string)
    The bank identification number that appears on the payment card.
    Example: 555555

  - `eventDetails.paymentInstrument.lastFour` (string)
    The last 4 digits from the card number.
    Example: 5555

  - `eventDetails.paymentInstrument.category` (string)
    The card category.
    Example: consumer

  - `eventDetails.paymentInstrument.countryCode` (string)
    The alpha-2 ISO-3166 country code of the card.
    Example: GB

  - `eventDetails.paymentInstrument.expiryDate` (object)
    The expiry date of the card.

  - `eventDetails.paymentInstrument.expiryDate.month` (string)
    The expiry month of the card.
    Example: 9

  - `eventDetails.paymentInstrument.expiryDate.year` (string)
    The expiry year of the card.
    Example: 2029

  - `eventDetails.paymentInstrument.cardBrand` (string)
    The card scheme, e.g. visa or mastercard.
    Example: visa

  - `eventDetails.paymentInstrument.fundingType` (string)
    Card funding type.
    Example: credit

  - `eventDetails.paymentInstrument.issuerName` (string)
    Card issuer name.
    Example: An Irish Bank

  - `eventDetails.paymentInstrument.paymentAccountReference` (string)
    The unique reference associated with the card PAN.
    Example: 321ABC

  - `eventDetails.date` (string)
    The date you first submitted the payment.
    Example: 2017-11-03

  - `eventDetails.octReference` (string)
    Visa Transaction ID for single-message OCTs, to be used for reconciliation and reporting. Can be returned in the `sentForRefund` or `refused` payment events.
    Example: 12345

  - `eventDetails._links` (object)
    Unused currently.

  - `eventDetails._links.payment` (object)

  - `eventDetails._links.payment.href` (string)

## Response 200:

  - `200` (unknown)
    Return a 200 status to indicate that the data was received successfully