PaymentWithAllLinks

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://github.com/api-evangelist/gov-uk-pay/blob/main/json-schema/PaymentWithAllLinks.json",
  "title": "PaymentWithAllLinks",
  "type": "object",
  "properties": {
    "_links": {
      "$ref": "#/components/schemas/PaymentLinks"
    },
    "agreement_payment_type": {
      "type": "string",
      "description": "When the customer initiates a standing order agreement transaction we have to include a customerInitiatedReason attribute. This can have a value of `instalment`, `recurring`, or `unscheduled`.",
      "enum": [
        "instalment",
        "recurring",
        "unscheduled"
      ]
    },
    "amount": {
      "type": "integer",
      "format": "int64",
      "description": "The description assigned to the payment when it was created.",
      "example": 1200
    },
    "authorisation_mode": {
      "type": "string",
      "description": "How the payment will be authorised. Payments created in `web` mode require the paying user to visit the `next_url` to complete the payment.",
      "enum": [
        "web",
        "moto_api",
        "external"
      ]
    },
    "authorisation_summary": {
      "$ref": "#/components/schemas/AuthorisationSummary"
    },
    "card_brand": {
      "type": "string",
      "deprecated": true,
      "description": "This attribute is deprecated. Please use `card_details.card_brand` instead.",
      "example": "Visa",
      "readOnly": true
    },
    "card_details": {
      "$ref": "#/components/schemas/CardDetails"
    },
    "corporate_card_surcharge": {
      "type": "integer",
      "format": "int64",
      "description": "The [corporate card surcharge](https://docs.payments.service.gov.uk/corporate_card_surcharges/#add-corporate-card-fees) amount in pence.",
      "example": 250,
      "readOnly": true
    },
    "created_date": {
      "type": "string",
      "example": "2016-01-21T17:15:00.000Z",
      "readOnly": true
    },
    "delayed_capture": {
      "type": "boolean",
      "description": "`delayed_capture` is `true` if you\u2019re [controlling how long it takes GOV.UK Pay to take (\u2018capture\u2019) a payment](https://docs.payments.service.gov.uk/delayed_capture).",
      "example": false,
      "readOnly": true
    },
    "description": {
      "type": "string",
      "description": "The description assigned to the payment when it was created.",
      "example": "Your Service Description"
    },
    "email": {
      "type": "string",
      "example": "The paying user\u2019s email address."
    },
    "exemption": {
      "$ref": "#/components/schemas/Exemption"
    },
    "fee": {
      "type": "integer",
      "format": "int64",
      "description": "The [payment service provider\u2019s (PSP) transaction fee](https://docs.payments.service.gov.uk/reporting/#psp-fees), in pence. `fee` only appears when we have taken (\u2018captured\u2019) the payment from the user or if their payment fails after they submitted their card details. `fee` will not appear if your PSP is Worldpay or you are using an API key from a test service.",
      "example": 5,
      "readOnly": true
    },
    "language": {
      "type": "string",
      "description": "The ISO-6391 Alpha-2 code of the [language of the user's payment page](https://docs.payments.service.gov.uk/optional_features/welsh_language).",
      "enum": [
        "en",
        "cy"
      ],
      "example": "en"
    },
    "metadata": {
      "$ref": "#/components/schemas/ExternalMetadata"
    },
    "moto": {
      "type": "boolean",
      "description": "Indicates if this payment is a [Mail Order / Telephone Order (MOTO) payment](https://docs.payments.service.gov.uk/moto_payments).",
      "example": false
    },
    "net_amount": {
      "type": "integer",
      "format": "int64",
      "description": "The amount, in pence, that will be paid into your bank account after your payment service provider takes the `fee`.",
      "example": 1195,
      "readOnly": true
    },
    "payment_id": {
      "type": "string",
      "description": "The unique ID GOV.UK Pay automatically associated with this payment when you created it.",
      "example": "hu20sqlact5260q2nanm0q8u93",
      "readOnly": true
    },
    "payment_provider": {
      "type": "string",
      "description": "The payment service provider that processed this payment.",
      "example": "worldpay",
      "readOnly": true
    },
    "provider_id": {
      "type": "string",
      "description": "The unique ID your payment service provider generated for this payment. This is not the same as the `payment_id`.",
      "example": "reference-from-payment-gateway",
      "readOnly": true
    },
    "reference": {
      "type": "string",
      "description": "The reference associated with the payment when it was created. `reference` is not unique - multiple payments can have the same `reference` value.",
      "example": "your-reference"
    },
    "refund_summary": {
      "$ref": "#/components/schemas/RefundSummary"
    },
    "return_url": {
      "type": "string",
      "description": "The URL you direct the paying user to after their payment journey on GOV.UK Pay ends.",
      "example": "http://your.service.domain/your-reference",
      "readOnly": true
    },
    "settlement_summary": {
      "$ref": "#/components/schemas/PaymentSettlementSummary"
    },
    "state": {
      "$ref": "#/components/schemas/PaymentState"
    },
    "total_amount": {
      "type": "integer",
      "format": "int64",
      "description": "Amount your user paid in pence, including corporate card fees. `total_amount` only appears if you [added a corporate card surcharge to the payment](https://docs.payments.service.gov.uk/corporate_card_surcharges/#add-corporate-card-fees).",
      "example": 1450,
      "readOnly": true
    }
  }
}