---
title: "Retrieve Link"
method: POST
path: "/fetch"
tags: ["Payment Links"]
---

# Retrieve Link

`POST /fetch`

This API can be used to fetch the status of an existing payment link

## Headers

- `BD-Traceid` string, required
- `BD-Timestamp` string, required
- `Content-Type` string, required
- `Accept` string, required

## Request body

- object
  - `data` object
    - `mercid` string, required — Unique identifier as defined by BillDesk for each merchant
    - `linkid` string — Unique ID generated by BillDesk for a payment link
    - `merc_link_ref_no` string — Unique reference number provided by merchant

## Response `200`

OK

- object
  - `data` object
    - `objectid` 'link' — String representing the object's type. Objects of the same type share the same value.
    - `mercid` string — Unique identifier as defined by BillDesk for each merchant
    - `merc_link_ref_no` string — Unique reference number provided by merchant
    - `linkid` string — Unique ID generated by BillDesk for a payment link
    - `createdon` string, date-time — object creation timestamp
    - `currency` string — ISO currency of the transaction amount, for INR this value will be 356
    - `link_expiry_date` string — Expiry timestamp of the link. If not passed, the default expiry date is one month from the link creation date.
    - `link_desc` string — Merchant specific description of the link which gets displayed to the customer
    - `link_title` string — Merchant specific title of the link which gets displayed to the customer
    - `link` string — Payment link generated where customer must be redirected for payment
    - `link_status` 'ISSUED' | 'ATTEMPTED' | 'PAID' | 'PARTIALLY PAID' | 'EXPIRED' | 'DELETED' — Status of payment link
    - `forwarding_url` string — Merchant specific url where customer will be redirected post transaction is completed. Please note : transaction details will not be posted on this url.
    - `payment_method_allowed` 'all' — If not passed or if passed as null, in response it will be all
    - `payment` PaymentObjectFetchResponse
      - `amount` string — Payment link amount
      - `amount_pending` string — Remaining amount required to be paid against the link after the successful payments. Note : When partial payment is allowed
      - `max_payments_allowed` integer — Maximum number of partial payments that can be processed on the same link. This can be a maximum value of 10 (successful transactions). Value of 1 indicates a single payment can be collected against the link.
      - `minimum_partial_amount` string — Value equal to amount indicates a single payment can be collected against the link.
      - `partial_payment_allowed` boolean — To determine if partial payment is allowed on the link against the total amount used for link creation.
    - `total_attempts` string — Total successful payment attempts processed out of the maximum number of payments allowed for the link
    - `transaction_list` object[]
      - `transactionid` string — Unique transactionid created by BillDesk
      - `amount` string — Transaction amount in two decimals, eg. 299.28
      - `auth_status` '0300' | '0002' | '0399' — Represents the authorization status of the transaction with the following possible values: • 0300 - transaction is successful • 0002 - transaction is pending for authorization • 0399 - transaction failed
      - `transaction_date` string, date-time — BillDesk transaction date and time in YYYY-MM-DDThh:mm:ssTZD format
      - `payment_method_type` 'card' | 'netbanking' | 'upi' | 'eft' | 'cardless' | 'bankaccount' — Represents the method of payment, and can take the following values - card, netbanking, wallet, upi, eft, bankaccount, cashcard, cardless (non-card emi option) The associated object will also be provided in the request.
    - `customer` CustomerResponse — Customer object response. Note : PII data will be masked
      - `first_name` string — Customer’s First Name
      - `last_name` string — Customer’s Last Name
      - `mobile` string — Customer’s Mobile number
      - `email` string — Customer’s Email address

## Other responses

- `403` — Forbidden
- `500` — Internal Server Error
- `default` — Any bad or invalid request will lead to following error object

---

[API](https://skmtc.net/billdesk/apis/payments.md) · [All operations](https://skmtc.net/billdesk/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/billdesk/payments/revisions/43f021fc467f/schema)