Payout

Create subscription plans and billing for your application. Below, you'll find comprehensive information on how to integrate and utilize the API.A plan includes pricing and billing cycle information that defines the amount and frequency of charge for a subscription. You can also define a fixed plan, such as a $5 basic plan or a volume- or graduated-based plan with pricing tiers based on the quantity purchased.

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 Payout

POST /payout

Use this endpoint to initiate a payout to a user or vendor.

Attributes

recipient_id

string

Unique identifier identification

amount

integer

Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge

currency

retrievable with publishable key

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

description

string

describe the reason for payment

status

string

show what the result on transaction

request

 
{
  "amount": 100.00,
  "currency": "USD",
  "payment_method": "credit_card",
  "card_number": "4111111111111111",
  "expiration_month": 12,
  "expiration_year": 2025,
  "cvv": "123"
}

response

 
{
  "id": "payout123",
  "recipient_id": "user123",
  "amount": 100.00,
  "currency": "USD",
  "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)