Campaigns

Get Categories

GET /campaigns/categories

Headers

Name	Type	Description
Client-Key*	String	Your client key

200: OK

{
    "data": [
        {
            "id": "aa99e545-0bf4-454a-8aac-502e1eaa3b26",
            "name": "Bantuan",
            "slug": "demo-bantuan",
            "description": "Ini adalah deskripsi untuk bantuan"
        }
    ]
}

Get Campaigns

GET /campaigns

Query Parameters

Name	Type	Description
q	String	Parameter for search
categories	String	Parameter for filtering campaings based on categories slug. Can be single or multiple, for multiple separate by using comma (,). Example: demo-bantuan
date	Date	Parameter for filtering campaigns based on date. Format: YYYY-MM-DD
per_page	Integer	Parameter for filtering campaigns based on how many items per page
page	Integer	Parameter for filtering campaigns based on which page
orderBy	String	Parameter for filtering based on column, options: end_date, collected_amount, created at
order	String	options: ASC or DESC

Headers

Name	Type	Description
Client-Key*	String	Your client key

200: OK

{
    "data": [
        {
            "id": "2f2d2410-6e46-4c2d-8f81-347e9a854627",
            "title": "Bantuan Untuk",
            "slug": "demo-bantuan-untuk",
            "description": "<p>Ini adalah deskripsi dari campaign yang ada&nbsp;&nbsp;</p>",
            "start_date": "2023-12-05 00:00:00",
            "end_date": "2023-12-25 00:00:00",
            "published_at": "2023-12-12 00:00:00",
            "targeted_amount": "1000000.00",
            "collected_amount": null,
            "donations_count": null,
            "cover": "https://minio-s3.dev.embrio.id/munio/uploads/public/658/b7f/1f2/658b7f1f283fd874596096.png",
            "remaining_days": "299 hari",
            "categories": {
                "data": [
                    {
                        "id": "aa99e545-0bf4-454a-8aac-502e1eaa3b26",
                        "name": "Bantuan",
                        "slug": "demo-bantuan",
                        "description": "Ini adalah deskripsi untuk bantuan"
                    }
                ]
            }
        }
    ],
    "meta": {
        "pagination": {
            "total": 1,
            "count": 1,
            "per_page": 10,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}

404: Not Found

500: Internal Server Error

Get Campaigns Finished

GET /campaigns/finished

Query Parameters

Name	Type	Description
q	String	Parameter for search
categories	String	Parameter for filtering campaings based on categories slug. Can be single or multiple, for multiple separate by using comma (,). Example: demo-bantuan
date	Date	Parameter for filtering campaigns based on date. Format: YYYY-MM-DD
per_page	Integer	Parameter for filtering campaigns based on how many items per page
page	Integer	Parameter for filtering campaigns based on which page
orderBy	String	Parameter for filtering based on column, options: end_date, collected_amount, created at
order	String	options: ASC or DESC

Headers

Name	Type	Description
Client-Key*	String	Your client key

200: OK

{
    "data": [
        {
            "id": "2f2d2410-6e46-4c2d-8f81-347e9a854627",
            "title": "Bantuan Untuk",
            "slug": "demo-bantuan-untuk",
            "description": "<p>Ini adalah deskripsi dari campaign yang ada&nbsp;&nbsp;</p>",
            "start_date": "2023-12-05 00:00:00",
            "end_date": "2023-12-25 00:00:00",
            "published_at": "2023-12-12 00:00:00",
            "targeted_amount": "1000000.00",
            "collected_amount": null,
            "donations_count": null,
            "cover": "https://minio-s3.dev.embrio.id/munio/uploads/public/658/b7f/1f2/658b7f1f283fd874596096.png",
            "remaining_days": "299 hari",
            "categories": {
                "data": [
                    {
                        "id": "aa99e545-0bf4-454a-8aac-502e1eaa3b26",
                        "name": "Bantuan",
                        "slug": "demo-bantuan",
                        "description": "Ini adalah deskripsi untuk bantuan"
                    }
                ]
            }
        }
    ],
    "meta": {
        "pagination": {
            "total": 1,
            "count": 1,
            "per_page": 10,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}

404: Not Found

500: Internal Server Error

Get Campaign Detail

GET /campaigns/{id}

Path Parameters

Name	Type	Description
id*		ID of campaign

Headers

Name	Type	Description
Client-Key*	String	Your client key

200: OK

{
    "data": {
        "id": "2f2d2410-6e46-4c2d-8f81-347e9a854627",
        "title": "Bantuan Untuk",
        "slug": "demo-bantuan-untuk",
        "description": "<p>Ini adalah deskripsi dari campaign yang ada&nbsp;&nbsp;</p>",
        "start_date": "2023-12-05 00:00:00",
        "end_date": "2023-12-25 00:00:00",
        "published_at": "2023-12-12 00:00:00",
        "targeted_amount": "1000000.00",
        "collected_amount": null,
        "donations_count": null,
        "cover": "https://minio-s3.dev.embrio.id/munio/uploads/public/658/b7f/1f2/658b7f1f283fd874596096.png",
        "remaining_days": "299 hari",
        "categories": {
            "data": [
                {
                    "id": "aa99e545-0bf4-454a-8aac-502e1eaa3b26",
                    "name": "Bantuan",
                    "slug": "demo-bantuan",
                    "description": "Ini adalah deskripsi untuk bantuan"
                }
            ]
        }
    }
}

404: Not Found

Create Donation

POST /campaigns/donation

Headers

Name	Type	Description
Client-Key*	String	Your client key
Authorization	String	Bearer Token (optional)

Request Body

Name	Type	Description
campaign_id*	String	The id of the campaign
payment_method_id	Integer
amount*	Number	The amount of the donations
name	String
phone	String
email	String
is_anonymous	Boolean

200: OK

{
    "data": {
        "id": "9d729fd1-1085-4d06-bd73-33a371260973",
        "campaign": "Peduli apa",
        "subtotal": 10000,
        "transaction_fee": "7500.00",
        "is_transaction_fee_covered": false,
        "total": 17500,
        "link_payment": "https://checkout-staging.xendit.co/v2/6593b9846575493bbd43e461",
        "expired_at": "2024-01-04T07:21:40.000000Z",
        "updated_at": "2024-01-02T07:21:40.000000Z",
        "created_at": "2024-01-02T07:21:40.000000Z",
        "status": "pending",
        "payment_method": {
            "data": {
                "id": 3,
                "name": "SHOPEEPAY",
                "logo": "https://minio-s3.dev.embrio.id/munio/uploads/public/656/852/e06/656852e063869537428970.png"
            }
        }
    }
}