Payments methods

Events

Action Event name
create a new payment method paymentmethod.created
update an existing payment method paymentmethod.updated

Payload example created

{
  "attemptId": "2a212dee-f231-41b2-bc6b-413cbd084907",
  "created": 1623956442,
  "data": {
    "accountId": "52a377ec430c7d4e220001fc",
    "allowPaidItemChanges": true,
    "allowToCombine": true,
    "channels": {
      "agency-backoffice": {
        "accepted": [],
        "available": true
      },
      "agency-websales": {
        "available": false
      },
      "backoffice": {
        "accepted": [],
        "available": true
      },
      "websales": {
        "available": false
      }
    },
    "createdAt": "2021-06-16T15:58:43.219Z",
    "creditCards": {},
    "custom": true,
    "deleted": false,
    "displayName": "test",
    "editablePaymentAdjustor": false,
    "enabled": false,
    "externalSource": false,
    "externalType": "",
    "fileUploadHistory": [],
    "flow": "standard",
    "hasRefund": true,
    "help": "",
    "helpByField": {
      "allowToCombine": "allowToCombineHelp"
    },
    "id": "0606a264-337c-4032-b580-fe90f8665f20",
    "includeInDepositTotals": false,
    "isEditable": true,
    "isOnline": false,
    "method": "test",
    "onlineRefund": false,
    "ord": 2,
    "params": {},
    "paymentAdjustor": 100,
    "providerId": "9a786a88-a60c-44c7-b479-2a71655a850f",
    "requireAddressBackoffice": false,
    "requireAddressWebsales": false,
    "requireConfirmation": true,
    "updatedAt": "2021-06-17T19:00:31.307Z"
  },
  "event": "paymentmethod.created",
  "id": "659882fc-4982-4e62-a74c-b2705621b690",
  "livemode": true
}

Payload example updated

{
  "attemptId": "2a212dee-f231-41b2-bc6b-413cbd084907",
  "created": 1623956442,
  "data": {
    "accountId": "52a377ec430c7d4e220001fc",
    "allowPaidItemChanges": true,
    "allowToCombine": true,
    "channels": {
      "agency-backoffice": {
        "accepted": [],
        "available": true
      },
      "agency-websales": {
        "available": false
      },
      "backoffice": {
        "accepted": [],
        "available": true
      },
      "websales": {
        "available": false
      }
    },
    "createdAt": "2021-06-16T15:58:43.219Z",
    "creditCards": {},
    "custom": true,
    "deleted": false,
    "displayName": "test",
    "editablePaymentAdjustor": false,
    "enabled": false,
    "externalSource": false,
    "externalType": "",
    "fileUploadHistory": [],
    "flow": "standard",
    "hasRefund": true,
    "help": "",
    "helpByField": {
      "allowToCombine": "allowToCombineHelp"
    },
    "id": "0606a264-337c-4032-b580-fe90f8665f20",
    "includeInDepositTotals": false,
    "isEditable": true,
    "isOnline": false,
    "method": "test",
    "onlineRefund": false,
    "ord": 2,
    "params": {},
    "paymentAdjustor": 100,
    "providerId": "9a786a88-a60c-44c7-b479-2a71655a850f",
    "requireAddressBackoffice": false,
    "requireAddressWebsales": false,
    "requireConfirmation": true,
    "updatedAt": "2021-06-17T19:00:31.307Z"
  },
  "event": "paymentmethod.updated",
  "id": "659882fc-4982-4e62-a74c-b2705621b690",
  "livemode": true
}