GOgovernment-digital-service
Charge operations

Authorise Apple Pay payment

Changed on
post/v1/frontend/charges/{chargeId}/wallets/apple

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

chargeIdstring required

Charge external ID

Request body

payment_datastring

paymentData of Apple Pay payment token as String. This is de-serialised and decrypted for WorldPay payments. For Stripe payments, the value is passed as is when creating a token

Example request

{
  "payment_data": "{\"version\":\"EC_v1\",\"data\":\"MLHhOn2BXhNw9wLLDR48DyeUcuSmRJ6KnAIGTMGqsgiMpc+AoJ…LUQ6UovkfSnW0sFH6NGZ0jhoap6LYnThYb9WT6yKfEm/rDhM=\",\"signature\":\"MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFAD…ZuQFfsLJ+Nb3+7bpjfBsZAhA1sIT1XmHoGFdoCUT3AAAAAAAA\",\"header\":{\"ephemeralPublicKey\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE5/Qc6z4TY5HQ5n…KC3kJ4DtIWedPQ70N35PBZzJUrFjtvDZFUvs80uo2ynu+lw==\",\"publicKeyHash\":\"Xzn7W3vsrlKlb0QvUAviASubdtW4BotWrDo5mGG+UWY=\",\"transactionId\":\"372c3858122b6bc39c6095eca2f994a8aa012f3b025d0d72ecfd449c2a5877f9\"}}",
  "payment_info": {
    "brand": "visa",
    "card_type": "DEBIT",
    "cardholder_name": "Joe B",
    "display_name": "MasterCard 1234",
    "email": "mr@payment.test",
    "last_digits_card_number": "4242",
    "network": "MasterCard",
    "transaction_identifier": "372C3858122B6BC39C6095ECA2F994A8AA012F3B025D0D72ECFD449C2A5877F9"
  }
}

Response

OK

Changes

  • 042ba06d9017Revision changes
    • info

      removed the AMOUNT_BELOW_MINIMUM enum value from the response property for the response status

    • info

      removed the AMOUNT_BELOW_MINIMUM enum value from the response property for the response status

    • info

      removed the AMOUNT_BELOW_MINIMUM enum value from the response property for the response status

  • 4e93196bd6aaRevision changes
    • warning

      added the new AMOUNT_BELOW_MINIMUM_FOR_ADYEN enum value to the response property for the response status

    • warning

      added the new AMOUNT_BELOW_MINIMUM_FOR_ADYEN enum value to the response property for the response status

    • warning

      added the new AMOUNT_BELOW_MINIMUM_FOR_ADYEN enum value to the response property for the response status

    • warning

      added the new AMOUNT_BELOW_MINIMUM_FOR_STRIPE enum value to the response property for the response status

    • warning

      added the new AMOUNT_BELOW_MINIMUM_FOR_STRIPE enum value to the response property for the response status

    • warning

      added the new AMOUNT_BELOW_MINIMUM_FOR_STRIPE enum value to the response property for the response status