# Links API Docs

> API documentation for My Platform

## Getting Started

- [Overview](/overview.md): LINKs Merchant Services offers a unique global payment solution designed to provide peace of mind with seamless payment acceptance. LINKs stands out by combining worry-free functionality, advanced security, and a wide array of payment options.
- [Choose Integration](/choose-integration.md): When integrating LINKs, choosing the method that best fits your business needs is vital. This page summarizes the available integration methods and provides a comparison table to help you make an informed decision.

## API Guides

- [Overview](/api-guides.md): LINKs API offers you a way to fully integrate our solution with our API. You'll have access to all endpoints you require to be able to manage payments, and you customer's payment methods, directly from your own app. Follow each page below for guides on all available features in LINKs API:

### Payments


#### How to Create a Payment

- [Authorize Payment](/authorize-payment.md): LINKs API Authorize Payment endpoint can be used in a few different ways. It allows you to set the payment method, along with the needed data for the selected method. You can also define a auto-capture flag, allowing you to automatically capture the payment, skipping the need to make a call to the capture endpoint. This page presents you the different possibilities and parameters you can add to the authorization request.
- [How to Refund a Payment](/how-to-refund-a-payment.md): This guide explains how to Refund a Payment, which allows you to refund a previously captured payment.
- [How to Void a Payment](/how-to-void-a-payment.md): This guide explains how to Void a Payment, which allows you to void a previously authorized payment before it has been captured. Voiding a payment cancels the transaction and prevents it from being processed.

### Payment Methods

- [How to Create a Payment Method](/how-to-create-a-payment-method.md): On this page, you will find a walk-through guide on creating a payment method and the necessary information to accomplish this task.
- [How to Retreive a Payment Method](/how-to-retrieve-a-payment-method.md): Learn how to retrieve a payment method.
- [How to Delete a Payment Method](/how-to-delete-a-payment-method.md): On this page, you will find a walk-through guide on deleting a payment method and the necessary information to accomplish this task.
- [How to Update a Payment Method](/how-to-update-a-payment-method.md): On this page, you will find a walk-through guide on updating a payment method and the necessary information to accomplish this task.

## LINKs UI

- [Overview](/links-ui.md): LINKs offers you a ready-made payment UI you can quickly embed into your website. This integration method allows you to:

### Authorize Module

- [Authorize Styles Props](/authorize-module/styles-props.md): You can customize the Authorize Module to integrate better with your website's design style. For this, you can use the optional parameters style and labels when calling the window.authorizePaymentConfig function.

### Payment Methods Module

- [Payment Methods Styles Props](/payment-methods-module/styles-props.md): You can customize the Authorize Module to integrate better with your website's design style. For this, you can use the optional parameters style and labels when calling the window.listOfpaymentMethodsConfig function.

## Introduction

- [Overview](/api-overview.md): LINKs API are implemented around RESTful. Our APIs use standard HTTP protocol requests, which return JSON payloads. Operations are performed via GET and POST requests.
- [Authentication](/authentication.md): LINKs API offers two forms of authentication depending on the request type:

## Auth

- [Retrieve a JWT Token for Lite API Authorization](/api/auth/retrieve-a-jwt-token-for-lite-api-authorization.md): This endpoint returns a JWT token (GUID) which is used to authorize requests in the Lite version of the API.

## Payments

- [Authorize a Payment](/api/payments/authorize-a-payment.md): This endpoint authorizes a payment by providing the necessary payment method details, customer information, and whether the payment should be auto-captured.
- [Capture a Payment](/api/payments/capture-a-payment.md): This endpoint captures a payment that was previously authorized. It finalizes the transaction by moving funds from the customer to the merchant.
- [Create a New Payment](/api/payments/create-a-new-payment.md): This endpoint allows for the creation of a new payment by providing the necessary details such as the amount, currency, and merchant information.
- [Refund a Payment](/api/payments/refund-a-payment.md): This endpoint refunds a previously captured payment by providing the necessary refund details, including the amount to be refunded.
- [Retrieve Payment](/api/payments/retrieve-payment.md): This endpoint retrieves the details of a payment using its unique identifier. The response includes the payment status, amount, and other related details.
- [Void a Payment](/api/payments/void-a-payment.md): This endpoint voids a previously authorized payment before it has been captured. Voiding a payment cancels the transaction and prevents it from being processed.

## Payment Method

- [Create a New Payment Method](/api/paymentmethod/create-a-new-payment-method.md): This endpoint allows the creation of a new payment method for a customer or merchant. The request should include details such as the merchant identifier, optional customer identifier, and payment method information like credit card details and billing information. This API helps link a payment method to a merchant account, and optionally, to a customer.
- [Delete a Payment Method](/api/paymentmethod/delete-a-payment-method.md): This endpoint deletes a payment method identified by its unique identifier. Upon successful deletion, a confirmation response is returned.
- [Retrieve a Payment Method](/api/paymentmethod/retrieve-a-payment-method.md): This endpoint retrieves the details of a payment method using its unique identifier. The response includes information such as the merchant, customer, and billing details associated with the payment method.
- [Retrieve Customer Payment Methods by ID](/api/paymentmethod/retrieve-customer-payment-methods-by-id.md): This endpoint retrieves all payment methods associated with a specific customer, identified by the `customerIdentifier`. It returns details for each payment method linked to the customer.
- [Retrieve Customer Payment Methods by Reference](/api/paymentmethod/retrieve-customer-payment-methods-by-reference.md): This endpoint retrieves all payment methods associated with a specific customer, identified by the `customerReference`. It returns details for each payment method linked to the customer reference.
- [Update a Payment Method](/api/paymentmethod/update-a-payment-method.md): This endpoint allows updating an existing payment method by providing the necessary details such as payment method type, card information, and billing details. The `merchantIdentifier` and `paymentMethodIdentifier` are required to locate the payment method to update.
- [Update Card Type and Last 4 Digits (Test Method)](/api/paymentmethod/update-card-type-and-last-4-digits-test-method.md): This endpoint updates the `CardType` and `Last4Digits` columns for existing records. It is intended to be run in both test and production environments. Once it is executed successfully in these environments, this method can be commented out or disabled.

## Other Pages

- /
- /Homepage/
- /api-guides/
- /api-overview/
- /api/auth/retrieve-a-jwt-token-for-lite-api-authorization/
- /api/paymentmethod/create-a-new-payment-method/
- /api/paymentmethod/delete-a-payment-method/
- /api/paymentmethod/retrieve-a-payment-method/
- /api/paymentmethod/retrieve-customer-payment-methods-by-id/
- /api/paymentmethod/retrieve-customer-payment-methods-by-reference/
- /api/paymentmethod/update-a-payment-method/
- /api/paymentmethod/update-card-type-and-last-4-digits-test-method/
- /api/payments/authorize-a-payment/
- /api/payments/capture-a-payment/
- /api/payments/create-a-new-payment/
- /api/payments/refund-a-payment/
- /api/payments/retrieve-payment/
- /api/payments/void-a-payment/
- /authentication/
- /authorize-module/
- /authorize-module/styles-props/
- /authorize-payment/
- /choose-integration/
- /how-to-create-a-payment-method/
- /how-to-create-a-payment/
- /how-to-delete-a-payment-method/
- /how-to-refund-a-payment/
- /how-to-retrieve-a-payment-method/
- /how-to-update-a-payment-method/
- /how-to-void-a-payment/
- /links-ui/
- /overview/
- /payment-methods-module/
- /payment-methods-module/styles-props/
- /payment-methods/
- /payments/
- /search/