Quick Pay

Quick Pay is a quicker method of payments.


Endpoint

Method Description URI
POST Create a Quick Pay /api/v2/quick-pays
GET Get a list of Quick Pays /api/v2/quick-pays
PATCH Update a Quick Pay /api/v2/quick-pays/{ID}
DELETE Delete a Quick Pay /api/v2/quick-pays/{ID}


Required Headers

Key Value
Accept application/json
Content-Type application/json
Authorization Bearer {ACCESS-TOKEN}


Create a Quick Pay

Parameters

Method URI
POST /api/v2/quick-pays

Body:

Key Type Required
title string Yes
description string No
collection_id integer Yes
email string Yes
mobile string Yes
currency string Yes
amount string Yes
payment_info payment info Object Optional

{info} Notes : key "credit_debit_card" is required if "payment_method_code" of type Credit / Debit Card

Example :

{
    "title": "example-title",
    "description": "example-description",
    "collection_id": 1,
    "email": "test@test.com",
    "mobile": "1234567890",
    "currency": "MYR",
    "amount": "5.50",
    "payment_info": {
        "payment_method_code": "mastercard",
        "credit_debit_card": {
            "card_no": "5123450000000008",
            "card_name": "raudhah",
            "card_expiry_month": "11",
            "card_expiry_year": "2022",
            "cvv": "123",
            "billing_address": {
                "street_1": "raudhah city",
                "city": "Cyber",
                "postcode": "41200",
                "state_province": "Selangor",
                "country_code": "MYS"
            }
        }
    }
}

Response

{success} Success code : 200

{
    "success": true,
    "data": {
        "title": "example-title",
        "description": "example-description",
        "collection_id": 1,
        "email": "test@test.com",
        "mobile": "1234567890",
        "currency": "MYR",
        "amount": "5.50",
        "quickpay_no": "zhTEQGrtyn",
        "updated_at": "2020-06-25 07:22:29",
        "created_at": "2020-06-25 07:22:29",
        "id": {ID},
        "payment_page_url": "{SERVER-URL}/payment/gateway/secure-pay-quick-pay?code=zhTEQGrtyn"
    },
    "errors": null,
    "meta": {
        "timestamp": "2020-06-25 07:22:29 UTC",
        "timezone": "UTC"
    }
}

{info} For Error Reference, Related guide: Errors


Get a list of Quick Pays

Parameters

Method URI
GET /api/v2/quick-pays

Response

{success} Success code : 200

{
    "success": true,
    "data": {
        "current_page": 1,
        "data": [
            {
                "title": "example-title",
                "description": "example-description",
                "collection_id": 1,
                "email": "test@test.com",
                "mobile": "1234567890",
                "currency": "MYR",
                "amount": "5.50",
                "quickpay_no": "zhTEQGrtyn",
                "updated_at": "2020-06-25 07:22:29",
                "created_at": "2020-06-25 07:22:29",
                "id": {ID},
                "payment_page_url": "QuickBillUrl/payment/gateway/secure-pay-quick-pay?code=zhTEQGrtyn"
            }
        ],
        "first_page_url": "{SERVER-URL}/api/v2/quick-pays?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "{SERVER-URL}/api/v2/quick-pays?page=1",
        "next_page_url": null,
        "path": "{SERVER-URL}/api/v2/quick-pays",
        "per_page": 15,
        "prev_page_url": null,
        "to": 1,
        "total": 1
    },
    "errors": null,
    "meta": {
        "timestamp": "2020-06-25 07:23:54 UTC",
        "timezone": "UTC"
    }
}

{info} For Error Reference, Related guide: Errors


Update a Quick Pay

Parameters

Method URI
PATCH /api/v2/quick-pays/{ID}

Body:

Key Type Required
title string No
description string No
collection_id integer No
email string No
mobile string No
currency string No
amount string No

Example :

{
    "title": "example-title-updated",
    "description": "example-description-updated",
    "collection_id": 1,
    "email": "test@test.com",
    "mobile": "1234567890",
    "currency": "MYR",
    "amount": "5.50"
}

Response

{success} Success code : 200

{
    "success": true,
    "data": {
        "title": "example-title-updated",
        "description": "example-description-update",
        "collection_id": 1,
        "email": "test@test.com",
        "mobile": "1234567890",
        "currency": "MYR",
        "amount": "5.50",
        "quickpay_no": "zhTEQGrtyn",
        "updated_at": "2020-06-25 07:22:29",
        "created_at": "2020-06-25 07:22:29",
        "id": {ID},
        "payment_page_url": "QuickBillUrl/payment/gateway/secure-pay-quick-pay?code=zhTEQGrtyn"
    },
    "errors": null,
    "meta": {
        "timestamp": "2020-06-25 07:22:29 UTC",
        "timezone": "UTC"
    }
}

{info} For Error Reference, Related guide: Errors


Delete a Quick Pay

Parameters

Method URI
DELETE /api/v2/quick-pays/{ID}

Response

{success} Success code : 200

{
    "success": true,
    "data": true,
    "errors": null,
    "meta": {
        "timestamp": "2020-06-25 07:36:17 UTC",
        "timezone": "UTC"
    }
}

{info} For Error Reference, Related guide: Errors