# Cancel a payment link

Invalidate payment link and prevent further transactions

Endpoint: PATCH /payin/{id}/cancel
Version: 1.0.0
Security: JWT

## Path parameters:

  - `id` (string, required)
    The ID of the payment link to cancel
    Example: "e092be15-e614-4401-8cea-7ca3df7da987"

## Response 200 fields (application/json):

  - `id` (string)
    The unique identifier for the payment link.
    Example: "payin_678a4c88hpAjf"

  - `customer_id` (string)
    The unique identifier of customer linked to payment_link.
    Example: "cust_E602dMzgjpDC"

  - `document_id` (string)
    The unique identifier of document linked to payment_link. This document entity should contain the required documents to process incoming payments. Refer this [Document](#tag/Document) entity for more details.
    Example: "doc_nYUqLpuYQ0M8"

  - `status` (string)
    The status of the payment_link.
    Enum: "active", "paid", "failed", "action_required", "cancelled", "partially_paid", "under_review", "expired"

  - `payment_methods` (array)
    Array of payment methods that should be available for the customer on the checkout page. This field allows you to control which payment options your customers can use to complete the payment. You can specify one or multiple payment methods in the array.
    Enum: "bank_transfer", "pay_via_bank", "card"

  - `currency` (string)
    The currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format. Supported currencies: USD,EUR and GBP.
    Example: "USD"

  - `amount` (number)
    The amount you want to receive, a positive integer representing the smallest currency unit. For example, if the amount is $299.00, then pass 29900 in this field. In the case of three decimal currencies, such as KWD, BHD and OMR, to represent an amount of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, for amount ￥295, pass the value as 295.
    Example: 1000

  - `purpose_code` (string)
    Purpose code for why you want to receive this payment
    Example: "P1401"

  - `invoice_number` (string)
    Number/Id of the invoice submitted with payment_link.
    Example: "RG12FF590"

  - `invoice_description` (string)
    Description about the invoice submitted with payment_link
    Example: "Payment requested for services provided"

  - `reference_number` (string)
    optional identifier to be sent for reconciliations
    Example: "R0001"

  - `expires_at` (string)
    Date when the payment_link will expire. Expiry can not be less than or equal  to current date and can be upto 6 months in future.
    Example: "2025-02-15T00:00:00.000Z"

  - `last_reminder_sent_at` (string)
    Last time when the customer was reminded to complete the payment by  visiting the link
    Example: "2024-09-13T06:32:34.340Z"

  - `invoice_amount` (number)
    The amount in cents for which invoice was generated. It can be more  than the amount requested in this payment_link
    Example: 1000

  - `payment_link` (string)
    Sharable link which should be shared with customer you want to receive  money from.  This link gets generated only after the payin has been reviewed and moved to in_progress
    Example: "https://staging-api.glomopay-eng.com/v1/payin/pl/8f31597d-e085-497a-b80f-ae97ea9422a0"

  - `reminder_frequency` (number)
    The frequency at which you want to remind customers, valid values are 1(remind everyday), 2(remind every alternate day), 7(remind every week), 14(remind every alternate week).
    Example: 7

  - `price_id` (string)
    The price_id of the price to be used for the payment link.  Note: If you are a platform user then price_id is a required field.
    Example: "price_E602dMzgjpDC"

  - `product` (object)
    Details of the product that the payment is related to.

  - `product.name` (string, required)
    Name of the product

  - `product.description` (string)
    Description of the product

  - `created_at` (string)
    Timestamp representing when the payment_link was created
    Example: "2021-06-01T12:00:00Z"

  - `updated_at` (string)
    Timestamp representing when the payment_link was last updated
    Example: "2021-06-01T12:00:00Z"

  - `notes` (object)
    Any additional notes for the order
    Example: {"key1":"value1","key2":"value2"}

  - `bank_account_details` (object)
    Optional bank account details to associate with the customer for this payment link. When provided, the bank account will be linked to the customer and associated with this payment link. Either bic_primary or bic_secondary must be provided when including this field.
    Example: {"account_number":"1234567890","bic_primary":"HDFCINBBDEL","bic_secondary":null,"bank_customer_id":"7189204715"}

  - `bank_account_details.account_number` (string, required)
    The bank account number
    Example: "1234567890"

  - `bank_account_details.bic_primary` (string,null)
    SWIFT code for the bank account. Will be null if not provided in the request.
    Example: "HDFCINBBDEL"

  - `bank_account_details.bic_secondary` (string,null)
    Local routing code for the bank account like IFSC. Will be null if not provided in the request.
    Example: "HDFC0001097"

  - `bank_account_details.bank_customer_id` (string,null)
    Optional bank customer identifier provided by the bank
    Example: "7189204715"

  - `rfi_documents` (array)
    List of required documents for RFI (Request for Information). This field is only present when the payment link status is 'action_required', indicating that sanction screening has been triggered and additional documents are required to proceed with the payment link.
    Example: [{"rfi_doc_id":"rfidoc_123","name":"Passport"},{"rfi_doc_id":"rfidoc_456","name":"Proof of Address"}]

  - `rfi_documents.rfi_doc_id` (string, required)
    Unique identifier for the required RFI document
    Example: "rfidoc_123"

  - `rfi_documents.name` (string, required)
    Name/type of the required document
    Example: "Passport"

## Response 404 fields (application/json):

  - `error` (string)
    Enum: "Not found"

  - `message` (string)
    Entity not found
    Enum: "Entity not found"