Create a Payout

Create a Payout

POST https://api.payouter.com/payouts

Headers

Name	Value
Content-Type	application/json
Signature	Signed request body
Merchant	Merchant ID

Body

Name	Type	Required	Description
amount	string	true	Amount to be paid. If the amount includes cents, use a ‘.’ as the decimal separator. Example: 10.28
currency	string	true	Currency code
order_id	string	true	Order identifier in your system. The parameter must be a string containing letters, digits, underscores, and dashes. It must not contain spaces or special characters order_id must be unique within the merchant’s accounts
receiver	string	true	Recipient details where the money should be sent
bank_name	string	false required_with: payment_type = IMPS	IFSC code used for some payment types, such as IMPS
recipient_name	string	false required_with: payment_type = IMPS	Recipient’s full name
payment_type	string	true	Payment method through which the payment will be made
url_callback	string	false	URL where the Webhook will be sent
additional_data	string	false	Additional information for your use (not shown to the client)

Response

200

          {
      type: string, // Payment type PayIn/PayOut
      uuid: string, // Unique identifier in our system
      order_id: string, // Your order ID sent during creation
      lifetime: number | null, // Unix timestamp for expiration date/time
      amount: string, // Fiat amount of the created order
      payment_link: string | null, // Link to the payment terminal
      fact_amount: string | null, // Fiat amount of actual execution of the order
      balance_change: string | null, // Amount credited to the platform account
      commission: string | null, // Amount taken as commission
      is_test: boolean, // Whether the order is a test order
      status: string, // Current order status
      payment_type: string, // Payment method code
      refer: string | null, // Recipient details
      recipient_name: string | null, // Recipient full name
      bank: string | null, // Recipient bank code
      currency: string, // Currency code
      additional_data: string | null, // Extra info sent at order creation 
      convert: {
        to_currency: string, // Currency or cryptocurrency code for credited amount
        rate: string | null // Conversion rate
      },
      extra: null, // Additional invoice information 
      created_at: string, // ISO-8601 order creation date/time
    }

400