Create payment link

POST

/v1/custom-link

Create custom payment links with different configurations to collect payments remotely. Configure the url, set an expiration date and perform other operations through this service.

Example of a configurable link structure:

Request

Header Params

Body Params application/json

Examples

Responses

🟢202

application/json

Accepted

Body

🟠401

🟠403

🟠422

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v1/custom-link' \
--header 'BP-User-Token;' \
--header 'X-Api-Key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url_path": "customLink",
    "expired_at": "2028-05-22T15:20:34",
    "amount": 55,
    "type": 2,
    "description": "Test link",
    "rates": [
        {
            "months": "12",
            "type": "MSI"
        }
    ],
    "is_fixed_term": false
}'

Response Example

202 - Example 1

{
    "description": "Test link",
    "link_type": 2,
    "user_id": 61234,
    "amount": 55,
    "available_rates": [
        {
            "type": "MSI",
            "months": 12
        }
    ],
    "expired_at": "2028-05-22T15:20:34",
    "custom_link_path": "https://test.pay.billpocket.com/mylink/customLink",
    "purchase_id": null,
    "currency": "MXN",
    "domain": "https://test.pay.billpocket.com",
    "created_at": "2024-06-13T21:57:43",
    "is_fixed_term": false,
    "status": 1,
    "updated_at": "2024-06-13T21:57:43",
    "extra_info": null,
    "id": "61529dc5fee00754d48088ec51da557ae578f",
    "main_link": "mylink",
    "secondary_link": "customLink"
}

Modified at 2026-01-29 23:56:45

Get payment link configuration

Update payment link