Kushki Developer Portal
  1. CARD PRESENT PAYMENTS (BILLPOCKET)
Kushki Developer Portal
  • Back to home
  • México 🇲🇽
  • Bienvenidos
  • ONLINE PAYMENTS
    • CARD
      • CARD
      • 1. Request a card token
      • 2. Make a charge or deferred charge
      • 3. Void a transaction
      • 4. Refund a transaction
      • 5. Request deferred options
      • 6. Authorize payments
      • 7. Reauthorize payments
      • 8. Capture an authorized payment
      • 9. Bin Info
      • 10. Bin Info V2
      • 11. Validate OTP
      • 12. Verify Account
      • 12. Verify Account
      • 6. Authorize payments
      • 10. Bin Info V2
      • 8. Capture an authorized payment
      • 3. Void a transaction
      • 4. Refund a transaction
      • 7. Reauthorize payments
      • 1. Request a card token
      • 9. Bin Info
      • 5. Request deferred options
      • 2. Make a charge or deferred charge
      • 11. Validate OTP
    • CASH IN
      • 1. Request a cash in token
      • 2. Init Transaction
      • 3. Transaction Status
      • 1. Request a cash in token
      • 2. Init Transaction
      • 3. Transaction Status
    • TRANSFER IN
      • 1. Request a Transfer In token
      • 2. Init Transaction
      • 4. Get Status Copy
      • 1. Request a Transfer In token
      • 4. Get Status Copy
      • 2. Init Transaction
    • TRANSFER OUT
      • 1. Get Bank List
      • 2. Request a Transfer Out token
      • 3. Init Transaction
      • 4. Get Status
      • 5. Wallet Balance
      • 5. Wallet Balance
      • 1. Get Bank List
      • 4. Get Status
      • 2. Request a Transfer Out token
      • 3. Init Transaction
    • ONE-CLICK & SCHEDULED PAYMENTS
      • 1. Request a recurring charge token
      • 2. Create a recurring charge
      • 3. Update recurring charge card data
      • 4. Make an One-click payment
      • 5. Cancel a recurring charge
      • 6. Update a recurring charge
      • 7. Add a temporary charge or discount
      • 8. Authorize payments Copy
      • 9. Capture an authorized payment Copy
      • 10. Get recurring charge Info
      • 1. Request a recurring charge token
      • 8. Authorize payments Copy
      • 3. Update recurring charge card data
      • 6. Update a recurring charge
      • 10. Get recurring charge Info
      • 2. Create a recurring charge
      • 5. Cancel a recurring charge
      • 9. Capture an authorized payment Copy
      • 4. Make an One-click payment
      • 7. Add a temporary charge or discount
    • PAYMENT BUTTON
      • 1. Create a payment button
      • 1. Create a payment button
    • SMARTLINKS V2
      • 1. Create a Smartlink
      • 2. Get a Smartlink
      • 3. Delete a Smartlink
      • 4. Update a Smartlink
      • 1. Create a Smartlink
      • 4. Update a Smartlink
      • 2. Get a Smartlink
      • 3. Delete a Smartlink
    • PAYMENT CREDENTIALS
      • 1. Create a credential
      • 2. Search credentials
      • 3. Advanced search
      • 4. Activate or deactivate
      • 5. Delete credential
      • 6. Update credential
      • 7. Regenerate a credential
      • 3. Advanced search
      • 6. Update credential
      • 5. Delete credential
      • 2. Search credentials
      • 4. Activate or deactivate
      • 7. Regenerate a credential
      • 1. Create a credential
    • COMMISSIONS
      • 1. Get Commission Configuration
      • 1. Get Commission Configuration
    • GATEWAY STATUS
      • 1. Get gateway status
      • 1. Get gateway status
    • ANALYTICS
      • 1. Get transactions list
      • 1. Get transactions list
  • CARD PRESENT PAYMENTS (API RAW)
    • Single payment
    • Get BIN Info
    • BIN info V2
    • Request deferred options
    • Transaction Search
  • CARD PRESENT PAYMENTS (BILLPOCKET)
    • Get token
      POST
    • States
      GET
    • Validate token
      GET
    • Municipalities
      GET
    • Collect payments
      POST
    • Tax companies
      GET
    • Capture an authorized payment
      POST
    • Commercial activities
      GET
    • Refund
      POST
    • Create checkout
      POST
    • Get status
      GET
    • Get checkout details
      GET
    • Collect card payments
      POST
    • Print Ticket
      POST
    • Collect card payments v2
      POST
    • Cancel Push Notification
      POST
    • Get transaction status
      GET
    • Add or update CLABE account
      POST
    • Configure payment link
      POST
    • Get payment link configuration
      GET
    • Create payment link
      POST
    • Update payment link
      PUT
    • List payment links
      GET
    • Delete payment link
      DELETE
    • Add CLABE account
      POST
    • Get token
      POST
    • Get transaction list
      GET
    • Get transaction list v2
      GET
    • Get transaction list v3
      GET
    • Get transaction list v4
      GET
    • Create user
      POST
  1. CARD PRESENT PAYMENTS (BILLPOCKET)

List payment links

GET
/v1/custom-link
Get the list of all your created payment links.

Request

Header Params

Responses

🟢200
application/json
OK
Body

🟢204
🟠401
🟠403
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/custom-link' \
--header 'BP-User-Token;' \
--header 'X-Api-Key;'
Response Response Example
200 - List custom payment links
[
    {
        "user_id": 61529,
        "id": "61521794a50cfbc301p109f599d3387hab6ad",
        "available_rates": [],
        "link_type": 2,
        "custom_link_path": "https://test.pay.billpocket.com/mylink/ll33q0rh",
        "secondary_link": "ll33q0rh",
        "is_fixed_term": false,
        "extra_info": null,
        "purchase_id": null,
        "status": 1,
        "amount": 30,
        "created_at": "2023-08-09T02:18:48",
        "updated_at": "2023-08-09T02:18:48",
        "description": " (LL33Q0RH)",
        "main_link": "mylink",
        "currency": "MXN",
        "expired_at": null,
        "domain": "https://test.pay.billpocket.com"
    },
    {
        "user_id": 61529,
        "id": "615295d029329f48597218884178553105e13",
        "available_rates": [],
        "link_type": 2,
        "custom_link_path": "https://test.pay.billpocket.com/mylink/ll33pe5x",
        "secondary_link": "ll33pe5x",
        "is_fixed_term": false,
        "extra_info": null,
        "purchase_id": null,
        "status": 1,
        "amount": 50,
        "created_at": "2023-08-09T02:18:19",
        "updated_at": "2023-08-09T02:18:19",
        "description": " (LL33PE5X)",
        "main_link": "mylink",
        "currency": "MXN",
        "expired_at": null,
        "domain": "https://test.pay.billpocket.com"
    },
    {
        "user_id": 61529,
        "id": "60299070952218da192058f8b949429f91991",
        "available_rates": [],
        "link_type": 2,
        "custom_link_path": "https://test.pay.billpocket.com/mylink/ll33n4mz",
        "secondary_link": "ll33n4mz",
        "is_fixed_term": false,
        "extra_info": null,
        "purchase_id": null,
        "status": 1,
        "amount": 100,
        "created_at": "2023-08-09T02:16:35",
        "updated_at": "2023-08-09T02:16:35",
        "description": " (LL33N4MZ)",
        "main_link": "mylink",
        "currency": "MXN",
        "expired_at": null,
        "domain": "https://test.pay.billpocket.com"
    },
    {
        "user_id": 61529,
        "id": "6152937394e0f3212478592c0c8lao13cde6e",
        "available_rates": [],
        "link_type": 2,
        "custom_link_path": "https://test.pay.billpocket.com/mylink/ll33kth5",
        "secondary_link": "ll33kth5",
        "is_fixed_term": false,
        "extra_info": null,
        "purchase_id": null,
        "status": 1,
        "amount": 100,
        "created_at": "2023-08-09T02:14:49",
        "updated_at": "2023-08-09T02:14:49",
        "description": " (LL33KTH5)",
        "main_link": "mylink",
        "currency": "MXN",
        "expired_at": null,
        "domain": "https://test.pay.billpocket.com"
    },
    {
        "user_id": 61529,
        "id": "61512bbc109e0e5d64f7dbde3723d02d43e19",
        "available_rates": [],
        "link_type": 2,
        "custom_link_path": "https://test.pay.billpocket.com/mylink/ll32lx7n",
        "secondary_link": "ll32lx7n",
        "is_fixed_term": false,
        "extra_info": null,
        "purchase_id": null,
        "status": 0,
        "amount": 100,
        "created_at": "2023-08-09T01:47:40",
        "updated_at": "2023-08-09T01:47:40",
        "description": " (LL32LX7N)",
        "main_link": "mylink",
        "currency": "MXN",
        "expired_at": null,
        "domain": "https://test.pay.billpocket.com"
    }
]
Modified at 2026-01-29 23:56:45
Previous
Update payment link
Next
Delete payment link
Built with