---
title: "Create a PayMongo Wallet link"
method: POST
path: "/v1/paymongo_wallet/links"
tags: ["PayMongo Wallet"]
---

# Create a PayMongo Wallet link

`POST /v1/paymongo_wallet/links`

## Request

- Base URL: `https://ewallets-api.paymongo.com`
- URL: `https://ewallets-api.paymongo.com/v1/paymongo_wallet/links`
- Auth: HTTP basic

Records, once per vaulted payment method, the payer wallet a renewal debits from. core-api creates it after the customer-present debit that activated the subscription succeeded. Idempotent on payment_method_id: a repeated create for the same payee, mode and payer returns the existing active link. A different payer is rejected until that link is revoked.

## Request body

- CreateLinkRequestDTO: Request payload core-api sends once the customer-present debit that activated a subscription succeeded. Idempotent on payment_method_id for the same payer.
  - `agreement_id` string
  - `livemode` boolean, required
  - `organization_id` string, required
  - `payer_account_number` string, required
  - `payer_organization_id` string
  - `payment_method_id` string, required

## Response `200`

Link created, or the existing active link for the payment method

- object: Standard response containing data and its metadata if any
  - `data` LinkResponseDTO: The payer wallet a vaulted payment method debits from when the customer is not present. One active link exists per payment method.
    - `agreement_id` string
    - `authorized_at` string
    - `created_at` string
    - `id` string
    - `livemode` boolean
    - `organization_id` string
    - `payer_account_number` string
    - `payer_organization_id` string
    - `payment_method_id` string
    - `revoked_at` string
    - `status` 'active' | 'revoked'
    - `updated_at` string
  - `has_more` boolean

## Other responses

- `400`: Invalid request body or validation errors
- `401`: Missing or invalid credentials
- `409`: An active link for the payment method names a different payee, mode or payer
- `500`: Internal server error

---

[API](https://skmtc.dev/paymongo/apis/ewallets.md) - [All operations](https://skmtc.dev/paymongo/apis/ewallets/llms.txt) - [OpenAPI document](https://skmtc.dev/paymongo/apis/ewallets/revisions/a445ca65c132?raw)