Create a Payment Link

This enables businesses to generate or create payment link for one-time or recurring payments. It provides support for various payment options, allowing users to link their fiat and cryptocurrency wallets for seamless transactions.

📘
Note
The default currency for receiving payments is USD. However, customers have the flexibility to choose between making payments using fiat currency or connecting directly to their crypto wallet.
Furthermore, businesses can customize the payment link according to their preferences. They have the option to configure the payment link to collect additional user information such as address and phone number and can choose to enable charges if desired.

HTTP Method: POST
API Endpoint: {{base_url}}/payment-links

Sample cURL Request

curl --location 'https://dev-api.ovalfi-app.com/api/v1/payment-links' \
--header 'tenant: oval' \
--header 'Content-Type: application/json' \
--data '{
    "title": "ICT Job Wale",
    "description": "This is the very beginning of jobs",
    "amount": 400,
    "message": "This is still the very beginning of jobs oo",
    "collectPhoneNumber": true,
    "collectAddress": true,
    "feebearer": "business",
    "type": "recurring",
    "extraFields": ["yourView", "myView"]
}'

Sample JSON Request

{
    "title": "ICT Job Wale",
    "description": "This is the very beginning of jobs",
    "amount": 400,
    "message": "This is still the very beginning of jobs oo",
    "collectPhoneNumber": true,
    "collectAddress": true,
    "feebearer": "business",
    "type": "recurring",
    "extraFields": ["yourView", "myView"]
}

Response

{
    "code": 200,
    "data": {
        "requestID": "03b8accb-4b5d-4c1a-92c7-86ac412df2bb",
        "id": "b7d28e21-36c9-4063-9222-4d5e71268965",
        "businessID": "2bac2bad-c513-4dc5-be26-097ede951e7c",
        "userID": "0e47f72f-20f9-4c44-bd18-46592a315c65",
        "title": "ICT Job Wale",
        "description": "This is the very beginning of jobs",
        "amount": {
            "currency": "USD",
            "symbol": "$",
            "amount": 5000
        },
        "message": "This is still the very beginning of jobs oo",
        "collectPhoneNumber": true,
        "collectAddress": true,
        "feeBearer": "business",
        "type": "recurring",
        "linkURL": "/qcqwmF833dCt",
        "details": [
            "yourView",
            "myView"
        ],
        "status": "active",
        "createdAt": "2022-11-29T17:16:20.439390971+01:00"
    },
    "message": "Payment Link Created Successfully",
    "error": null
}

📘Note

📘
Note