Skip to content

Data Schema

This section outlines the main data structures used in our API responses.

Represents a payment link (basic Link To Pay/ SplitLinks):

  {
      "id": "integer",
      "user_id": "string",
      "amount": "double",
      "recipient_note": "string",
      "status": "string",
      "paymentEndpoint": "string",
      "pay_link": "string",
      "qr_img": "string",
      "created_at": "date" ,
      "is_split": "boolean",
      "transaction_type": "string",
      "recipients": "json-object"
  }

Payment Object

Represents a received Payment by a Link:

  {
      "id": "integer",
      "user_id": "integer",
      "amount": "double",
      "recipient_note": "string",
      "status": "string",
      "paymentEndpoint": "string",
      "pay_link": "string",
      "qr_img": "string",
      "created_at": "date",
      "type": "string
  }

Transaction Object

Represents a payout transaction:

  { 
      "payout_id": "integer",
      "user_id": "string",
      "transaction_id": "string",
      "payout_amount": "double",
      "service_fee": "double",
      "net_amount": "double",
      "payout_status": "string",
      "request_date": "date",
      "created_at": "date",
      "type": "string"
  }

Error Response

Standard error response object:

    { 
    "error": "string", "errorMessage": "string" 
    }

Additional Information

  • These schemas represent the core data structures used throughout our API.
  • For detailed field descriptions and additional schemas, please refer to our Swagger documentation.
  • These sections provide comprehensive information about our demo environment, authentication methods, and data schemas.
  • They should help developers understand how to interact with our API securely and effectively.