Deliverect · JSON Structure

Pay Api Payplatform Payments Profile Register Structure

Deliverect Register Profile

Type: object Properties: 4 Required: 4
RestaurantDeliveryOnline OrderingPoint of SaleOrder ManagementIntegration

PayplatformPaymentsProfileRegister is a JSON Structure definition published by Deliverect, describing 4 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

gatewayProfileId accountId apiKey webhookUrl

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/deliverect/refs/heads/main/json-structure/pay-api-payplatform-payments-profile-register-structure.json",
  "name": "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"
  ]
}