payment-WALLET.json

{
  "key": "payment-WALLET",
  "name": {
    "en": "CTP Standard Payment Resource for Wallets like PayPal"
  },
  "description": {
    "en": "extends the CTP Payment Resource with minimalistic standard fields for a Wallet Payment with redirect checkout."
  },
  "resourceTypeIds": [
    "payment"
  ],
  "fieldDefinitions": [
    {
      "name": "languageCode",
      "type": {
        "name": "String"
      },
      "label": {
        "en": "Hint to the PSP integration service, which language to take from CTP LString / LEnum data. ISO language code."
      },
      "required": true,
      "inputHint": "SingleLine"
    },
    {
      "name": "reference",
      "type": {
        "name": "String"
      },
      "label": {
        "en": "Short reference code to appear as first item in the client's bank account. Must be unique across all payments with the given PSP. Should be globally unique."
      },
      "required": true,
      "inputHint": "SingleLine"
    },
    {
      "name": "referenceText",
      "type": {
        "name": "String"
      },
      "label": {
        "en": "Text to appear in the account or credit card statement as well as the wallet account in addition to the reference ID which defaults to the Order Number"
      },
      "required": false,
      "inputHint": "MultiLine"
    },
    {
      "name": "redirectUrl",
      "type": {
        "name": "String"
      },
      "label": {
        "en": "Redirect URL passed from the PSP integration to the frontend.  If this field is set, it represents an instruction to the client implememtation to immediately redirect the User to the given place. Can / should be removed when the user hits the succes / error / cancel URLs."
      },
      "required": false,
      "inputHint": "SingleLine"
    },
    {
      "name": "successUrl",
      "type": {
        "name": "String"
      },
      "label": {
        "en": "Absolute URL set by the checkout client implementation that tells the PSP where to direct the Client after the steps in a redirect flow have been completed successfully."
      },
      "required": false,
      "inputHint": "SingleLine"
    },
    {
      "name": "errorUrl",
      "type": {
        "name": "String"
      },
      "label": {
        "en": "Absolute URL set by the checkout client implementation that tells the PSP where to direct the Client when a technical error has happened or the transaction has been denied in a redirect flow."
      },
      "required": false,
      "inputHint": "SingleLine"
    },
    {
      "name": "cancelUrl",
      "type": {
        "name": "String"
      },
      "label": {
        "en": "Absolute URL set by the checkout client implementation that tells the PSP where to direct the Client when the client has used a function in the redirect flow that cancels the process."
      },
      "required": false,
      "inputHint": "SingleLine"
    }
  ]
}