API Reference · Connect

Split Rules

Proposed multi-party payment splits across connected accounts. Not built: no payment is split today.

The split_rule object

Represents a split_rule entity in the rafiqPay system.

Field	Type & Flags	Description
id	string	Split rule ID (spl_...).
name	string	Display name.

Example split_rule JSON

split_rule example payload

{
  "id": "spl_01",
  "name": "Marketplace 90/10 Split"
}

Endpoints & Operations

POST/v1/split-rulesProposed

Create a split rule

Creates a split rule.

Request Example

POST /v1/split-rules

cURL · v1

curl -X POST "https://api.rafiqpay.net/v1/split-rules" \
  -H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a" \
  -H "Idempotency-Key: idem_create-split-rule_01" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Marketplace 90/10",
  "recipients": [
    {
      "accountId": "acct_seller_01",
      "shareBps": 9000
    }
  ]
}'

Response (200 OK)

Response payload

{
  "id": "spl_01",
  "name": "Marketplace 90/10"
}

GET/v1/split-rules/:idProposed

Retrieve a split rule

Retrieves a split rule.

Request Example

GET /v1/split-rules/:id

cURL · v1

curl -X GET "https://api.rafiqpay.net/v1/split-rules/:id" \
  -H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a"

Response (200 OK)

Response payload

{
  "id": "spl_01"
}

PATCH/v1/split-rules/:idProposed

Update a split rule

Updates a split rule.

Request Example

PATCH /v1/split-rules/:id

cURL · v1

curl -X PATCH "https://api.rafiqpay.net/v1/split-rules/:id" \
  -H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Updated Split"
}'

Response (200 OK)

Response payload

{
  "id": "spl_01"
}

GET/v1/split-rulesProposed

List split rules

Lists split rules.

Request Example

GET /v1/split-rules

cURL · v1

curl -X GET "https://api.rafiqpay.net/v1/split-rules" \
  -H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a"

Response (200 OK)

Response payload

{
  "object": "list",
  "data": [],
  "hasMore": false,
  "nextCursor": null
}