Split Payment

Learn how to implement and manage split payments within your application. This section provides detailed information on integrating and utilizing the split payment API, enabling you to distribute payments among multiple recipients seamlessly.

Authentication

You need an API key. You can obtain your API key by signing up for an account on our platform. Use this API key in the Authorization header of your HTTP requests.

Authorization: Bearer YOUR_API_KEY

Initiate Split Payment

POST /split-payment

Use this endpoint to initiate a split payment to multiple recipients.

Attributes

amount

integer

Total amount to be split among recipients. A positive integer representing how much to charge.

currency

string

Three-letter ISO currency code, in lowercase. Must be a supported currency.

recipients

array

List of recipients with their respective share amounts.

Request

{
  "amount": 100.00,
  "currency": "USD",
  "recipients": [
    {
      "recipient_id": "user123",
      "amount": 60.00
    },
    {
      "recipient_id": "user456",
      "amount": 40.00
    }
  ]
}

Response

{
  "id": "splitpayment123",
  "amount": 100.00,
  "currency": "USD",
  "recipients": [
    {
      "recipient_id": "user123",
      "amount": 60.00,
      "status": "pending"
    },
    {
      "recipient_id": "user456",
      "amount": 40.00,
      "status": "pending"
    }
  ],
  "status": "pending",
  "date": "2024-02-10"
}

Support If you have any questions or need assistance, please contact our support team at support

Was this page helpful?

Helpful (0)

Not helpful (0)