GOgovernment-digital-service
Discrepancies

Compare charge status with gateway

Changed on
post/v1/api/discrepancies/report

Request

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

Request body

string[] required

Example request

[
  "charge-external-id"
]

Response

OK

chargeIdstring
gatewayExternalStatus'EXTERNAL_CREATED' | 'EXTERNAL_STARTED' | 'EXTERNAL_SUBMITTED' | 'EXTERNAL_CAPTURABLE' | 'EXTERNAL_SUCCESS' | 'EXTERNAL_FAILED_REJECTED' | 'EXTERNAL_FAILED_EXPIRED' | 'EXTERNAL_FAILED_CANCELLED' | 'EXTERNAL_CANCELLED' | 'EXTERNAL_ERROR_GATEWAY'
gatewayStatus'UNDEFINED' | 'CREATED' | 'PAYMENT NOTIFICATION CREATED' | 'ENTERING CARD DETAILS' | 'AUTHORISATION ABORTED' | 'AUTHORISATION READY' | 'AUTHORISATION 3DS REQUIRED' | 'AUTHORISATION 3DS READY' | 'AUTHORISATION SUBMITTED' | 'AUTHORISATION SUCCESS' | 'AUTHORISATION REJECTED' | 'AUTHORISATION CANCELLED' | 'AUTHORISATION ERROR' | 'AUTHORISATION TIMEOUT' | 'AUTHORISATION UNEXPECTED ERROR' | 'AWAITING CAPTURE REQUEST' | 'CAPTURE APPROVED' | 'CAPTURE APPROVED RETRY' | 'CAPTURE READY' | 'CAPTURED' | 'CAPTURE SUBMITTED' | 'CAPTURE ERROR' | 'CAPTURE QUEUED' | 'AUTHORISATION USER NOT PRESENT QUEUED' | 'EXPIRE CANCEL READY' | 'EXPIRE CANCEL FAILED' | 'EXPIRE CANCEL SUBMITTED' | 'EXPIRED' | 'SYSTEM CANCEL READY' | 'SYSTEM CANCEL ERROR' | 'SYSTEM CANCEL SUBMITTED' | 'SYSTEM CANCELLED' | 'USER CANCEL READY' | 'USER CANCEL SUBMITTED' | 'USER CANCELLED' | 'USER CANCEL ERROR' | 'AUTHORISATION ERROR CANCELLED' | 'AUTHORISATION ERROR REJECTED' | 'AUTHORISATION ERROR CHARGE MISSING'
payExternalStatusstring
payStatus'UNDEFINED' | 'CREATED' | 'PAYMENT NOTIFICATION CREATED' | 'ENTERING CARD DETAILS' | 'AUTHORISATION ABORTED' | 'AUTHORISATION READY' | 'AUTHORISATION 3DS REQUIRED' | 'AUTHORISATION 3DS READY' | 'AUTHORISATION SUBMITTED' | 'AUTHORISATION SUCCESS' | 'AUTHORISATION REJECTED' | 'AUTHORISATION CANCELLED' | 'AUTHORISATION ERROR' | 'AUTHORISATION TIMEOUT' | 'AUTHORISATION UNEXPECTED ERROR' | 'AWAITING CAPTURE REQUEST' | 'CAPTURE APPROVED' | 'CAPTURE APPROVED RETRY' | 'CAPTURE READY' | 'CAPTURED' | 'CAPTURE SUBMITTED' | 'CAPTURE ERROR' | 'CAPTURE QUEUED' | 'AUTHORISATION USER NOT PRESENT QUEUED' | 'EXPIRE CANCEL READY' | 'EXPIRE CANCEL FAILED' | 'EXPIRE CANCEL SUBMITTED' | 'EXPIRED' | 'SYSTEM CANCEL READY' | 'SYSTEM CANCEL ERROR' | 'SYSTEM CANCEL SUBMITTED' | 'SYSTEM CANCELLED' | 'USER CANCEL READY' | 'USER CANCEL SUBMITTED' | 'USER CANCELLED' | 'USER CANCEL ERROR' | 'AUTHORISATION ERROR CANCELLED' | 'AUTHORISATION ERROR REJECTED' | 'AUTHORISATION ERROR CHARGE MISSING'
processedboolean
rawGatewayResponsestring

Example response

[
  {
    "chargeId": "2c6vtn9pth38ppbmnt20d57t49",
    "gatewayExternalStatus": "EXTERNAL_SUBMITTED",
    "gatewayStatus": "AUTHORISED",
    "payExternalStatus": "EXTERNAL_SUBMITTED",
    "payStatus": "AUTHORISATION SUCCESS",
    "rawGatewayResponse": "Worldpay response ()"
  }
]

Changes