Logo

All Recipient

Get https://whitelabel.markets/demos/apex/api/v1/recipient

Headers

Authorization* string

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

Body parameters

page string

Sets the page number; use "all" to retrieve all items. The default is 1

limit integer

Specifies the default number of items per page, with a default setting of 20

Response

{
    "data": [
        {
            "id": "8d7a7950-d6d5-401d-a8a6-2d0c52dd12bc",
            "first_name": "John",
            "middle_name": "Son",
            "last_name": "Derrick",
            "email": "Derrick@remote.com",
            "phone": "+2349012345678",
            "currency_code": "USD",
            "currency_id": "d374d1fa-6a88-47b7-a5cc-94acb76610fc",
            "transfer_purpose": "Education",
            "delivery_method": "bank",
            "image": null,
            "country": "US",
            "state": "DE",
            "city": "City",
            "address": "Address",
            "postal_code": "90000",
            "bank": {
                "bank_name": "Bank of America",
                "account_number": "12413523562366",
                "account_name": "John Derick",
                "account_type": "Checkings"
            }
        },
        {
            "id": "3c897ae7-7cce-4800-a5b7-14e19aa35c45",
            "first_name": "Jude",
            "middle_name": null,
            "last_name": "Obiora",
            "email": null,
            "phone": null,
            "currency_code": "NGN",
            "currency_id": "a58cd1d1-ad88-4318-ab6c-200e365bc393",
            "transfer_purpose": "Education",
            "delivery_method": "cash_pickup",
            "image": null,
            "country": "NG",
            "state": null,
            "city": null,
            "address": null,
            "postal_code": null,
            "agent": {
                "id": "f62a1d1a-eb9c-42cc-aac2-0a1c6dd8c7ba",
                "business_name": "Access Bank",
                "first_name": "Access",
                "last_name": "Bank",
                "email": "contactcenter@accessbankplc.com",
                "phone": "+234 1-2712005-7, 07003000000",
                "address": "14/15, Prince Alaba Oniru Road,\nOniru, Victoria Island,\nLagos State, Nigeria.",
                "image": "https://whitelabel.markets/demos/apex/storage/app/agents/wjCrf5Xe9QR3Mw5UUyoUxFIXaX208cAayoYutbEm.png"
            }
        },
        {
            "id": "372e2192-63dc-433d-8139-e175bf46ad4b",
            "first_name": "Juan",
            "middle_name": null,
            "last_name": "Pérez",
            "email": null,
            "phone": null,
            "currency_code": "ARS",
            "currency_id": "94054d91-c22f-4856-8495-6bc406539d20",
            "transfer_purpose": "Education",
            "delivery_method": "bank",
            "image": "https://whitelabel.markets/demos/apex/storage/app/recipient/n9rXHHOsjASNNXs9rqIG9rBKAuAtGX5PoSODJwiH.png",
            "country": "AR",
            "state": null,
            "city": null,
            "address": null,
            "postal_code": null,
            "bank": {
                "bank_name": "BBVA Argentina",
                "account_number": "11355321515",
                "account_name": "Juan Pérez",
                "account_type": "Savings"
            }
        },
        {
            "id": "555d893c-2641-46ad-81e8-2174067f4409",
            "first_name": "Adebayo",
            "middle_name": null,
            "last_name": "Adesina",
            "email": null,
            "phone": null,
            "currency_code": "NGN",
            "currency_id": "a58cd1d1-ad88-4318-ab6c-200e365bc393",
            "transfer_purpose": "Family Support",
            "delivery_method": "bank",
            "image": "https://whitelabel.markets/demos/apex/storage/app/recipient/H3C9pgCXlzTU2it21NQLLreAkaBnkOfwoGlVcECy.jpg",
            "country": "NG",
            "state": null,
            "city": null,
            "address": null,
            "postal_code": null,
            "bank": {
                "bank_name": "Access Bank",
                "account_number": "12412341341",
                "account_name": "Adebayo Adesina",
                "account_type": "Savings"
            }
        },
        {
            "id": "faded4da-f559-4191-9527-f7843c4038cf",
            "first_name": "Chioma",
            "middle_name": null,
            "last_name": "Gladys",
            "email": null,
            "phone": null,
            "currency_code": "NGN",
            "currency_id": "a58cd1d1-ad88-4318-ab6c-200e365bc393",
            "transfer_purpose": "Education",
            "delivery_method": "bank",
            "image": "https://whitelabel.markets/demos/apex/storage/app/recipient/nV6cKCKw6YWKgqAH6UYhuDadhc87VMBLLk2cTdr9.jpg",
            "country": "NG",
            "state": null,
            "city": null,
            "address": null,
            "postal_code": null,
            "bank": {
                "bank_name": "Zenith Bank",
                "account_number": "1234567894",
                "account_name": "Chioma Gladys",
                "account_type": "Savings"
            }
        },
        {
            "id": "f266dbce-1e6a-4228-b321-34b9e87023ee",
            "first_name": "Olivia",
            "middle_name": null,
            "last_name": "Turner",
            "email": null,
            "phone": null,
            "currency_code": "KES",
            "currency_id": "78ff1efa-1cdf-4d22-8882-f41fa96dd2b1",
            "transfer_purpose": "Family Support",
            "delivery_method": "mobile_money",
            "image": "https://whitelabel.markets/demos/apex/storage/app/recipient/LLq7h3CrHMREsHVjPrU3GZMKu8gdg12TYa0qvh7l.jpg",
            "country": "KE",
            "state": null,
            "city": null,
            "address": null,
            "postal_code": null,
            "mobile_money": {
                "network": "Airtel Money",
                "phone": "+2349012345678"
            }
        },
        {
            "id": "5045a926-23b2-4db5-b804-8011f2b2995c",
            "first_name": "Olivia",
            "middle_name": null,
            "last_name": "Williams",
            "email": null,
            "phone": null,
            "currency_code": "KES",
            "currency_id": "78ff1efa-1cdf-4d22-8882-f41fa96dd2b1",
            "transfer_purpose": "Family Support",
            "delivery_method": "bank",
            "image": "https://whitelabel.markets/demos/apex/storage/app/recipient/xK86IuPfuKfQc13wfsMabXhH4Xlbql7dvynbgIfW.jpg",
            "country": "KE",
            "state": null,
            "city": null,
            "address": null,
            "postal_code": null,
            "bank": {
                "bank_name": "Standard Chartered Bank Kenya",
                "account_number": "35253234523",
                "account_name": "Olivia Williams",
                "account_type": "Current"
            }
        },
        {
            "id": "d5a7a830-bb8a-4b36-86bd-20515c774e7b",
            "first_name": "Liam",
            "middle_name": null,
            "last_name": "Smith",
            "email": null,
            "phone": null,
            "currency_code": "USD",
            "currency_id": "d374d1fa-6a88-47b7-a5cc-94acb76610fc",
            "transfer_purpose": "Savings",
            "delivery_method": "bank",
            "image": "https://whitelabel.markets/demos/apex/storage/app/recipient/EfXSF0jxzHhtLPRfRKwaQZHs7KPoSLogAyLSWiOz.jpg",
            "country": "US",
            "state": null,
            "city": null,
            "address": null,
            "postal_code": null,
            "bank": {
                "bank_name": "Bank of America",
                "account_number": "24141341343",
                "account_name": "Liam Smith",
                "account_type": "Checkings"
            }
        },
        {
            "id": "3e5e206a-c541-4461-8563-f5f87c49076e",
            "first_name": "Emily",
            "middle_name": "Rose",
            "last_name": "Bennett",
            "email": null,
            "phone": null,
            "currency_code": "USD",
            "currency_id": "d374d1fa-6a88-47b7-a5cc-94acb76610fc",
            "transfer_purpose": "Education",
            "delivery_method": "bank",
            "image": "https://whitelabel.markets/demos/apex/storage/app/recipient/rEqGFPbGH6OtTNkJV5JDaQGL6kR4wnWu6dldLqvR.jpg",
            "country": "US",
            "state": null,
            "city": null,
            "address": null,
            "postal_code": null,
            "bank": {
                "bank_name": "Bank of America",
                "account_number": "123457688868",
                "account_name": "Emily Bennett",
                "account_type": "Savings"
            }
        },
        {
            "id": "4f496c01-bc8f-42eb-a51c-fbe8a886ce58",
            "first_name": "John",
            "middle_name": null,
            "last_name": "Anderson",
            "email": null,
            "phone": "+2349012345678",
            "currency_code": "USD",
            "currency_id": "d374d1fa-6a88-47b7-a5cc-94acb76610fc",
            "transfer_purpose": "Education",
            "delivery_method": "cash_pickup",
            "image": "https://whitelabel.markets/demos/apex/storage/app/recipient/Sj3iEV3M5wmPPVpAfTq0pnMMwxyVnGCDg4oacfTG.jpg",
            "country": "US",
            "state": null,
            "city": null,
            "address": null,
            "postal_code": null,
            "agent": {
                "id": "f40f7808-21af-4bb3-b45d-7ea617c4ca37",
                "business_name": "Zill Global",
                "first_name": "John",
                "last_name": "Doe",
                "email": "zill@remote.com",
                "phone": "+2349012345678",
                "address": "123 Ekenwan Road,\nUgbowo Quarters,\nP.O. Box 54321,\nBenin City, Edo State,",
                "image": "https://whitelabel.markets/demos/apex/storage/app/agents/a8M6SEsou8MBxoDDurqAjeXOO5VuScfQ8XxjWdAO.png"
            }
        }
    ],
    "links": {
        "first": "https://whitelabel.markets/demos/apex/api/recipient?page=1",
        "last": "https://whitelabel.markets/demos/apex/api/recipient?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://whitelabel.markets/demos/apex/api/recipient?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://whitelabel.markets/demos/apex/api/recipient",
        "per_page": 20,
        "to": 10,
        "total": 10
    }
}