> ## Documentation Index
> Fetch the complete documentation index at: https://dev.nickel.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Send a payment link to recipients

> Sends the payment link to the provided recipients via email and/or SMS. Can be called multiple times to resend; the backend automatically treats subsequent sends to the same recipient as reminders.



## OpenAPI

````yaml /nickel-api-docs.yaml post /paymentLink/{paymentLinkId}/send
openapi: 3.0.3
info:
  title: Nickel API
  description: >-
    This is the specification for the Nickel Rest API. The API lets you
    programmatically interact with the Nickel server. It uses resource oriented
    URLs, accepts and returns JSON encoded payloads and uses standard HTTP
    response codes. It is not a direct API to move money, but instead allows you
    to interact with Nickel as you would on a web interface.
  termsOfService: https://www.nickel.com/terms-of-service
  contact:
    email: support@nickel.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
servers:
  - url: https://rest.staging.nickel.com
    description: Sandbox / Staging
  - url: https://rest.nickel.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Payment
    description: Payments from your customers to you
  - name: Disbursement
    description: Payouts made from Nickel to you
  - name: Payment Link
    description: A request for payment against an invoice
  - name: Customer
    description: A customer record to request payments against
  - name: Charge Authorization
    description: >-
      An authorization for your customer to allow you to charge their payment
      method directly
  - name: Webhook
    description: Create a webhook for nickel to send updates to
  - name: File
    description: A file you can use to attach to invoices or debit authorizations
  - name: Vendor
    description: Manage vendors for accounts payable
  - name: Bill
    description: Bills from vendors and bill payments
  - name: Bill Payment Method
    description: >-
      A merchant's payment methods used to pay bills (bank accounts and cards on
      file)
  - name: Vendor Payout Method
    description: Vendor bank account and delivery method management
externalDocs:
  description: Find out more about Nickel
  url: https://nickel.com
paths:
  /paymentLink/{paymentLinkId}/send:
    post:
      tags:
        - Payment Link
      summary: Send a payment link to recipients
      description: >-
        Sends the payment link to the provided recipients via email and/or SMS.
        Can be called multiple times to resend; the backend automatically treats
        subsequent sends to the same recipient as reminders.
      operationId: sendPaymentLinkToRecipients
      parameters:
        - name: paymentLinkId
          in: path
          description: ID of the payment link to send
          required: true
          schema:
            type: string
      requestBody:
        description: Recipients to notify
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendPaymentLinkToRecipientsRequest'
        required: true
      responses:
        '200':
          description: Payment link sent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '400':
          description: Invalid input (validation failure or invalid recipient email)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    SendPaymentLinkToRecipientsRequest:
      required:
        - recipients
      type: object
      properties:
        recipients:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/SendPaymentLinkRecipient'
        sendSms:
          type: boolean
          description: >-
            Override the organization's default SMS setting. If omitted, uses
            the org setting (defaults to true).
    MessageResponse:
      type: object
      properties:
        message:
          type: string
    Error:
      required:
        - error
      type: object
      properties:
        error:
          type: string
          description: >-
            A human-readable error message describing what went wrong. Note that
            some 500 responses may return a plain text string instead of this
            JSON object.
    SendPaymentLinkRecipient:
      type: object
      properties:
        email:
          type: string
        name:
          type: string
        phoneNumber:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````