Payout

Post https://whitelabel.markets/demos/apex/api/v1/payout

Headers

Authorization* string

Pass your {api_key} as a bearer token in the request header to authorize this call

Body parameters

wallet_id* uuid

Wallet ID, this is the wallet that will be debited

external_id* string

Your platform transaction ID

sender_id* uuid

Sender ID, sender or payer information

recipient_id* uuid

Recipient ID, recipient or payee information

international_remittance_id* uuid

This is used to verify if recipient can receive funds from debit wallet. Ensure recipient currency is under international_remittance object. Learn more https://whitelabel.markets/demos/apex/docs/reference/currencies

delivery_window_id* uuid

This determines how fast recipient receives payout, not required if there are no options available under delivery_windows object. Learn more https://whitelabel.markets/demos/apex/docs/reference/currencies

amount numeric

Amount is lowest currency denomination

Response


{
    "message": "Transaction successful",
    "status": "success",
    "data": {
        "id": "94ecd94e-4354-4b3d-809b-62254b6b3b4e",
        "amount": "9100.00",
        "human_readable_amount": 91,
        "charge": "142.90",
        "human_readable_charge": 1.4290003196953849,
        "status": "pending",
        "decline_reason": null,
        "mode": "live",
        "type": "debit",
        "description": "payout",
        "external_id": "0c355ea1-b6f3-4ad2-bae8-05bb0b494b0c",
        "created_at": "2024-07-27T16:46:35.000000Z",
        "recipient": {
            "first_name": "Chioma",
            "middle_name": null,
            "last_name": "Gladys",
            "email": null,
            "phone": null,
            "amount": "14477461.62",
            "human_readable_recipient_amount": 144774.61621623,
            "currency_code": "NGN",
            "rate": 1590.92984853,
            "transfer_purpose": "Education",
            "delivery_method": "bank",
            "country": "NG",
            "state": null,
            "city": "",
            "address": null,
            "postal_code": null,
            "bank": {
                "bank_name": "Zenith Bank",
                "account_number": "1234567894",
                "account_name": "Chioma Gladys",
                "account_type": "Savings"
            }
        },
        "sender": {
            "id": "120988ea-b91b-4543-9bc0-d851e17db04b",
            "first_name": "John",
            "middle_name": "Son",
            "last_name": "Derrick",
            "business_name": null,
            "entity": "individual",
            "email": "Derrick@remote.com",
            "phone": "+2349057550481",
            "country": "US",
            "state": "DE",
            "city": "City",
            "address": "Address",
            "postal_code": "90000",
            "ip_address": "98.97.79.160",
            "id_type": "SSN",
            "id_number": "213652146416",
            "id_url": "https://google.com",
            "birth_date": "29-06-1999"
        }
    }
}