Skip to main content

Create a new payout

POST 
/create-payout

Create a new payout for a beneficiary

Request​

Body

required

Payout details

    amount decimalrequired

    Possible values: >= 1

    Amount to be paid (decimal with 2 decimal places)

    narration stringrequired

    Possible values: >= 3 characters

    Purpose of the payout

    category stringrequired

    Possible values: [claims, operations, salary, equipment, appliance, other]

    Payment category

    description stringnullable

    Possible values: >= 3 characters

    Additional description for the payout

    beneficiary integerrequired

    ID of the beneficiary (must exist in payer_beneficiaries)

    schedule_time date-timenullable

    Future date/time to schedule the payout (must be after current time)

Responses​

Payout created successfully

Schema
    data object
    id integer
    amount decimal
    fee decimal
    status integer

    Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]

    Payment status: 0 - Pending 1 - Successful 2 - Awaiting Approval 3 - Failed 4 - Rejected 5 - Processing 6 - Approved 7 - Draft 8 - Awaiting Payment 9 - Failed Retry Pending 10 - Failed Retrying

    status_text string
    category string

    Possible values: [claims, operations, salary, equipment, appliance, other]

    narration string
    description stringnullable
    description_short string
    scheduled_for date-timenullable
    initiated_at date-timenullable
    completed_at date-timenullable
    can_be_retried boolean
    total_amount decimal
Loading...