GOgovernment-digital-service
Authorise card payments

Send card details to authorise a MOTO payment

Changed on

You can use this endpoint to authorise payments you have created with authorisation_mode set to moto_api.

post/v1/auth

Request

  • Base URL
    https://publicapi.payments.service.gov.uk
  • URL
    https://publicapi.payments.service.gov.uk/v1/auth
  • Auth
    none declared

Request body

card_numberstring required

The full card number from the paying user's card.

cardholder_namestring required

The name on the paying user's card.

cvcstring required

The card verification code (CVC) or card verification value (CVV) on the paying user's card.

expiry_datestring required

The expiry date of the paying user's card. This value must be in MM/YY format.

one_time_tokenstring required

This single use token authorises your request and matches it to a payment. GOV.UK Pay generated the one_time_token when the payment was created.

Example request

{
  "card_number": "4242424242424242",
  "cardholder_name": "J. Citizen",
  "cvc": "123",
  "expiry_date": "09/22",
  "one_time_token": "12345-edsfr-6789-gtyu"
}

Response

Your authorisation request was successful.

Changes

  • 4dc2d80f453aRevision changes
    • breaking

      the request property's minLength was increased from 0 to 1

  • c8f226fc66d4Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status