# authorized

Endpoint: POST authorized
Version: 1

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

  - `body` (object) — one of:
    - Card:
      - `eventId` (string)
        The unique identifier for the event.
      - `eventTimestamp` (string)
        Date of event.
      - `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.
      - `eventDetails.orderReference` (string)
        A reference 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
      - `eventDetails.transactionReference` (string)
        The transaction reference you supplied in the payment.
      - `eventDetails.paymentId` (string)
        Unique identifier generated by us for a single payment. Generated at authorization, and maintained through successive payment actions.
      - `eventDetails.commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with our API.
      - `eventDetails.type` (string)
        Event status. For example, cancelled or sentForAuthorization.
        Example: "authorized"
      - `eventDetails.date` (string)
        The date you first submitted the payment.
      - `eventDetails.merchant` (object)
        Merchant data.
      - `eventDetails.merchant.entity` (string)
        A merchant entity reference.
        Example: "default"
      - `eventDetails.amount` (object)
      - `eventDetails.amount.value` (integer)
        The authorization, partial refund, or the whole or partial settlement amount. This is a whole number with an exponent of 2, e.g. 250 would be 2.50.
        Example: 100
      - `eventDetails.amount.currencyCode` (string)
        The currency code.
        Example: "EUR"
      - `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._links` (object)
        Unused currently.
      - `eventDetails._links.payment` (object)
      - `eventDetails._links.payment.href` (string)
    - APM - generic:
      - `eventId` (string)
        The unique identifier for the event.
      - `eventTimestamp` (string)
        Date of event.
      - `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.
      - `eventDetails.orderReference` (string)
        A reference 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
      - `eventDetails.transactionReference` (string)
        The transaction reference you supplied in the payment.
      - `eventDetails.paymentId` (string)
        Unique identifier generated by us for a single payment. Generated at authorization, and maintained through successive payment actions.
      - `eventDetails.commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with our API.
      - `eventDetails.type` (string)
        Event status. For example, cancelled or sentForAuthorization.
        Example: "authorized"
      - `eventDetails.date` (string)
        The date you first submitted the payment.
      - `eventDetails.merchant` (object)
        Merchant data.
      - `eventDetails.merchant.entity` (string)
        A merchant entity reference.
        Example: "default"
      - `eventDetails.amount` (object)
      - `eventDetails.amount.value` (integer)
        The authorization, partial refund, or the whole or partial settlement amount. This is a whole number with an exponent of 2, e.g. 250 would be 2.50.
        Example: 100
      - `eventDetails.amount.currencyCode` (string)
        The currency code.
        Example: "EUR"
      - `eventDetails._links` (object)
        Unused currently.
      - `eventDetails._links.payment` (object)
      - `eventDetails._links.payment.href` (string)
    - APM - Klarna (recurring):
      - `eventId` (string)
        The unique identifier for the event.
      - `eventTimestamp` (string)
        Date of event.
      - `eventDetails` (object)
      - `eventDetails.classification` (string)
        The event category, this can either be payout, payment or chargeback.
        Example: "payment"
      - `eventDetails.orderReference` (string)
        A reference 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
      - `eventDetails.transactionReference` (string)
        The transaction reference you supplied in the payment.
      - `eventDetails.paymentId` (string)
        Unique identifier generated by us for a single payment. Generated at authorization, and maintained through successive payment actions.
      - `eventDetails.commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with our API.
      - `eventDetails.type` (string)
        Event status. For example, cancelled or sentForAuthorization.
        Example: "authorized"
      - `eventDetails.date` (string)
        The date you first submitted the payment.
      - `eventDetails.merchant` (object)
        Merchant data.
      - `eventDetails.merchant.entity` (string)
        A merchant entity reference.
        Example: "default"
      - `eventDetails.amount` (object)
      - `eventDetails.amount.value` (integer)
        The authorization, partial refund, or the whole or partial settlement amount. This is a whole number with an exponent of 2, e.g. 250 would be 2.50.
        Example: 100
      - `eventDetails.amount.currencyCode` (string)
        The currency code.
        Example: "EUR"
      - `eventDetails.paymentInstrument` (object)
      - `eventDetails.paymentInstrument.method` (string)
        Example: "klarna"
      - `eventDetails.paymentInstrument.iban` (string)
        Example: "NL03RABO0123456789"
      - `eventDetails.paymentInstrument.accountHolderName` (string)
        Example: "A Shopper"
      - `eventDetails.paymentInstrument.countryCode` (string)
        Example: "GB"
      - `eventDetails._links` (object)
        Unused currently.
      - `eventDetails._links.payment` (object)
      - `eventDetails._links.payment.href` (string)
    - APM - MyBank:
      - `eventId` (string)
        The unique identifier for the event.
      - `eventTimestamp` (string)
        Date of event.
      - `eventDetails` (object)
      - `eventDetails.classification` (string)
        The event category, this can either be payout, payment or chargeback.
        Example: "payment"
      - `eventDetails.orderReference` (string)
        A reference 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
      - `eventDetails.transactionReference` (string)
        The transaction reference you supplied in the payment.
      - `eventDetails.paymentId` (string)
        Unique identifier generated by us for a single payment. Generated at authorization, and maintained through successive payment actions.
      - `eventDetails.commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with our API.
      - `eventDetails.type` (string)
        Event status. For example, cancelled or sentForAuthorization.
        Example: "authorized"
      - `eventDetails.date` (string)
        The date you first submitted the payment.
      - `eventDetails.merchant` (object)
        Merchant data.
      - `eventDetails.merchant.entity` (string)
        A merchant entity reference.
        Example: "default"
      - `eventDetails.amount` (object)
      - `eventDetails.amount.value` (integer)
        The authorization, partial refund, or the whole or partial settlement amount. This is a whole number with an exponent of 2, e.g. 250 would be 2.50.
        Example: 100
      - `eventDetails.amount.currencyCode` (string)
        The currency code.
        Example: "EUR"
      - `eventDetails.paymentInstrument` (object)
      - `eventDetails.paymentInstrument.method` (string)
        Example: "MyBank"
      - `eventDetails.paymentInstrument.iban` (string)
        Example: "NL03RABO0123456789"
      - `eventDetails.paymentInstrument.accountHolderName` (string)
        Example: "A Shopper"
      - `eventDetails.paymentInstrument.swiftBic` (string)
        Example: "RABONL2U"
      - `eventDetails.paymentInstrument.countryCode` (string)
        Example: "GB"
      - `eventDetails._links` (object)
        Unused currently.
      - `eventDetails._links.payment` (object)
      - `eventDetails._links.payment.href` (string)
    - APM - iDEAL:
      - `eventId` (string)
        The unique identifier for the event.
      - `eventTimestamp` (string)
        Date of event.
      - `eventDetails` (object)
      - `eventDetails.classification` (string)
        The event category, this can either be payout, payment or chargeback.
        Example: "payment"
      - `eventDetails.orderReference` (string)
        A reference 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
      - `eventDetails.transactionReference` (string)
        The transaction reference you supplied in the payment.
      - `eventDetails.paymentId` (string)
        Unique identifier generated by us for a single payment. Generated at authorization, and maintained through successive payment actions.
      - `eventDetails.commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with our API.
      - `eventDetails.type` (string)
        Event status. For example, cancelled or sentForAuthorization.
        Example: "authorized"
      - `eventDetails.date` (string)
        The date you first submitted the payment.
      - `eventDetails.merchant` (object)
        Merchant data.
      - `eventDetails.merchant.entity` (string)
        A merchant entity reference.
        Example: "default"
      - `eventDetails.amount` (object)
      - `eventDetails.amount.value` (integer)
        The authorization, partial refund, or the whole or partial settlement amount. This is a whole number with an exponent of 2, e.g. 250 would be 2.50.
        Example: 100
      - `eventDetails.amount.currencyCode` (string)
        The currency code.
        Example: "EUR"
      - `eventDetails.paymentInstrument` (object)
      - `eventDetails.paymentInstrument.method` (string)
        Example: "ideal"
      - `eventDetails.paymentInstrument.iban` (string)
        Example: "NL03RABO0123456789"
      - `eventDetails.paymentInstrument.accountNumber` (string)
        Example: "123456789"
      - `eventDetails.paymentInstrument.accountHolderName` (string)
        Example: "A Shopper"
      - `eventDetails.paymentInstrument.swiftBic` (string)
        Example: "RABONL2U"
      - `eventDetails._links` (object)
        Unused currently.
      - `eventDetails._links.payment` (object)
      - `eventDetails._links.payment.href` (string)
    - APM - Open Banking:
      - `eventId` (string)
        The unique identifier for the event.
      - `eventTimestamp` (string)
        Date of event.
      - `eventDetails` (object)
      - `eventDetails.classification` (string)
        The event category, this can either be payout, payment or chargeback.
        Example: "payment"
      - `eventDetails.orderReference` (string)
        A reference 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
      - `eventDetails.transactionReference` (string)
        The transaction reference you supplied in the payment.
      - `eventDetails.paymentId` (string)
        Unique identifier generated by us for a single payment. Generated at authorization, and maintained through successive payment actions.
      - `eventDetails.commandId` (string)
        Unique identifier generated by us for a single instance of an interaction (command) with our API.
      - `eventDetails.type` (string)
        Event status. For example, cancelled or sentForAuthorization.
        Example: "authorized"
      - `eventDetails.date` (string)
        The date you first submitted the payment.
      - `eventDetails.merchant` (object)
        Merchant data.
      - `eventDetails.merchant.entity` (string)
        A merchant entity reference.
        Example: "default"
      - `eventDetails.amount` (object)
      - `eventDetails.amount.value` (integer)
        The authorization, partial refund, or the whole or partial settlement amount. This is a whole number with an exponent of 2, e.g. 250 would be 2.50.
        Example: 100
      - `eventDetails.amount.currencyCode` (string)
        The currency code.
        Example: "EUR"
      - `eventDetails.paymentInstrument` (object)
      - `eventDetails.paymentInstrument.method` (string)
        Example: "open_banking"
      - `eventDetails.paymentInstrument.iban` (string)
        Example: "NL03RABO0123456789"
      - `eventDetails.paymentInstrument.accountHolderName` (string)
        Example: "A Shopper"
      - `eventDetails.paymentInstrument.swiftBic` (string)
        Example: "RABONL2U"
      - `eventDetails.paymentInstrument.countryCode` (string)
        Example: "GB"
      - `eventDetails.paymentInstrument.accountNumber` (string)
        Example: "04914552"
      - `eventDetails.paymentInstrument.bankCode` (string)
        Example: "040004"
      - `eventDetails._links` (object)
        Unused currently.
      - `eventDetails._links.payment` (object)
      - `eventDetails._links.payment.href` (string)


## Response 200 fields