Deliverect · Schema

PayplatformPaymentsProfileRegister

Deliverect Register Profile

RestaurantDeliveryOnline OrderingPoint of SaleOrder ManagementIntegration

Properties

Name Type Description
gatewayProfileId string Unique identifier of the payment gateway within a Deliverect customer account
accountId string
apiKey string API key is the unique identifier of the customer within the payment gateway
webhookUrl string Webhook URL which partners will send payment related update events
View JSON Schema on GitHub

JSON Schema

pay-api-payplatform-payments-profile-register-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/deliverect/refs/heads/main/json-schema/pay-api-payplatform-payments-profile-register-schema.json",
  "title": "PayplatformPaymentsProfileRegister",
  "description": "Deliverect Register Profile",
  "type": "object",
  "properties": {
    "gatewayProfileId": {
      "type": "string",
      "example": "609a1b2c3d4e5f6a7b8c9d0e",
      "description": "Unique identifier of the payment gateway within a Deliverect customer account"
    },
    "accountId": {
      "type": "string",
      "example": "5b71c6489f00290d4"
    },
    "apiKey": {
      "type": "string",
      "example": "string",
      "description": "API key is the unique identifier of the customer within the payment gateway"
    },
    "webhookUrl": {
      "type": "string",
      "example": "https://example.com/path/abc123",
      "description": "Webhook URL which partners will send payment related update events"
    }
  },
  "required": [
    "gatewayProfileId",
    "accountId",
    "apiKey",
    "webhookUrl"
  ]
}