Skip to main content

Refund a payment

POST 
/api/v1/optimus/payment/:id/refund/

Refund a specific payment.

Request​

Path Parameters

    id uuidrequired

Responses​

Schema
    id uuidrequired
    account_alias stringrequired

    Possible values: <= 8 characters

    first_name stringnullablerequired

    Possible values: <= 100 characters

    last_name stringnullablerequired

    Possible values: <= 100 characters

    email stringnullablerequired

    Possible values: <= 100 characters

    type TypeEnumrequired

    Possible values: [request-payment, transfer]

    amount decimalrequired

    Possible values: Value must match regular expression ^-?\d{0,13}(?:\.\d{0,2})?$

    reference stringrequired
    processing_number stringnullablerequired
    mode ModeEnumrequired

    Possible values: [mtn-benin, moov-benin]

    status objectrequired
    financial_status objectrequired
    completed date-timenullablerequired
    processing date-timenullablerequired
    failed date-timenullablerequired
    created date-timerequired
    updated date-timerequired
    webhook_url urinullablerequired

    Possible values: <= 200 characters

    refunded date-timenullablerequired
    test booleanrequired
    paid_organization booleanrequired
Loading...