> For the complete documentation index, see [llms.txt](https://squadinc.gitbook.io/squad-api-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://squadinc.gitbook.io/squad-api-documentation/payment-link.md).

# Payment Link

{% hint style="danger" %}
**This documentation site has been deprecated as of September 8, 2025, and will no longer receive updates. Please refer to the new documentation site at** [**https://docs.squadco.com**](https://docs.squadco.com)**.**
{% endhint %}

This API is used to create a simple payment link. All calls to this end point is to be made using your secret key gotten from your dashboard.<br>

{% hint style="warning" %}
**Authorization** Any request made without the authorization key (secret key) will fail with a **`401`**` ``(Unauthorized)` response code.
{% endhint %}

{% hint style="info" %}
**The authorization key is sent via the request header as Bearer Token Authorization**
{% endhint %}

**Example:**\
Authorizatio&#x6E;**:** Bearer sandbox\_sk\_94f2b798466408ef4d19e848ee1a4d1a3e93f104046f

### Sample Request

```

{
    "name": "Demo Otp Link",
    "hash": "mypaymentlink",
    "link_status": 1,
    "expire_by": "2023-04-26T11:22:08.587Z",
    "amounts": [
        {
            "amount": 4000,
            "currency_id": "NGN"
        }
    ],
    "description": "My description",
    "redirect_link": "https://fjfhgfd.com",
    "return_msg": "Successful"
}
```

#### Creating a Payment Link

## This API creates a Simple Payment Link

<mark style="color:green;">`POST`</mark> `https://sandbox-api-d.squadco.com/payment_link/otp`

#### Request Body

| Name                                           | Type    | Description                                                                                                                   |
| ---------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------- |
| name<mark style="color:red;">\*</mark>         | String  | Title/Name of the Payment Link                                                                                                |
| hash<mark style="color:red;">\*</mark>         | String  | Unique string that identifies each payment Link (cannot exceed 255 characters)                                                |
| link\_status<mark style="color:red;">\*</mark> | Integer | <p>Value can be 0 or 1. <br>1 - Active, 0 - Inactive</p>                                                                      |
| expire\_by<mark style="color:red;">\*</mark>   | String  | sample: 2021-04-26T11:22:08.587Z                                                                                              |
| amount<mark style="color:red;">\*</mark>       | Integer | Amount must be in the lowest currency. (kobo for Naira transactions and cent for Dollar transaction) i.e 40000 = 400NGN       |
| currency\_id<mark style="color:red;">\*</mark> | String  | USD or NGN (USD - US Dollars & NGN - Nigerian Naira)                                                                          |
| description<mark style="color:red;">\*</mark>  | String  | This describes what the payment link does                                                                                     |
| redirect\_link                                 | String  | URL to be redirected to after payment. When this is not provided, the default redirect URL set on your dashboard will be used |
| return\_msg                                    | String  | Message to be displayed to the customer after payment via the link                                                            |

{% tabs %}
{% tab title="200: OK Successful" %}

```javascript
{
    "status": 200,
    "success": true,
    "message": "Success",
    "data": {
        "name": "Demo Otp Link",
        "link_type": "otp",
        "hash": "mypaymentlink",
        "description": "My description",
        "currencies": null,
        "redirect_link": "https://squadco.com",
        "return_msg": "Successful",
        "support_email": null,
        "support_phone": null,
        "terms_condition": null,
        "return_policy": null,
        "pickup_location": null,
        "expire_by": "2021-04-26T11:22:08.587Z",
        "merchant_id": "SBN1EBZEQ8",
        "link_status": 0,
        "extra": null,
        "createdAt": "2022-08-08T09:24:41.269Z",
        "updatedAt": "2022-08-08T09:24:41.269Z",
        "archivedAt": null,
        "image_id": null,
        "image": null,
        "amounts": [
            {
                "amount": 4000,
                "currency_id": "NGN"
            }
        ]
    }
}
```

{% endtab %}

{% tab title="400: Bad Request Bad Request" %}

```javascript
{
    "status": 400,
    "success": false,
    "message": "Custom link already taken",
    "data": {}
}
```

{% endtab %}

{% tab title="401: Unauthorized Unauthorized" %}

```javascript
{
    "success": false,
    "message": "",
    "data": {}
}
```

{% endtab %}
{% endtabs %}

### Generating the Link

The payment link is a concatenation of the base URL: [https://sandbox-pay.squadco.com/](https://sandbox-pay.squadco.com/kmtyevdkcd591) and the hash selected when creating the payment link\
\
For instance, if the hash is *mypaymentlink* then the payment link will be <https://sandbox-pay.squadco.com/_mypaymentlink>\_

### GO LIVE - Production

To create payment link on production:

1. &#x20;kindly change the base URL of the endpoint from sandbox-api-d.squadco.com to api-d.squadco.com
2. get production keys from your production environment on dashboard.squadco.com
3. On production, the base URL for concatenation of the payment link needs to be changed from sandbox-pay.checkout.squadco.com/hash to pay.checkout.squadco.co/hash