# Create payment link

Route to create payment link

Endpoint: POST /payment-links
Version: 1.0

## Header parameters:

  - `x-api-key` (string, required)
    Api key provided on integrations tab in Easyflow platform.

  - `x-api-secret` (string, required)
    Api Secret provided on integrations tab in Easyflow platform.

  - `business-id` (string, required)
    Business Identifier

## Request fields (application/json):

  - `name` (string, required)

  - `description` (string, required)

  - `valueInCents` (integer, required)

  - `checkoutTemplateId` (string)

  - `preference` (object)

  - `preference.showSellerName` (boolean)

  - `preference.requestAddress` (boolean)

  - `preference.acceptNaturalPersonBuyer` (boolean)

  - `preference.acceptCorporationBuyer` (boolean)

  - `preference.requestDeliveryAddress` (boolean)

  - `paymentConfiguration` (object)

  - `paymentConfiguration.creditCard` (object)

  - `paymentConfiguration.creditCard.defaultInstallments` (integer)

  - `paymentConfiguration.creditCard.maxInstallments` (integer)

  - `paymentConfiguration.billet` (object)

  - `paymentConfiguration.billet.dueDateDelay` (integer)

  - `paymentConfiguration.pix` (object)

  - `paymentConfiguration.pix.expirationInMinutes` (integer)

## Response 200 fields (application/json):

  - `statusCode` (integer)
    Example: 200

  - `data` (object)

  - `data.paymentLink` (object)

  - `data.paymentLink.id` (string)

  - `data.paymentLink.createdAt` (string)

  - `data.paymentLink.updatedAt` (string)

  - `data.paymentLink.deletedAt` (string,null)

  - `data.paymentLink.deleted` (boolean)

  - `data.paymentLink.business` (string)

  - `data.paymentLink.checkout` (string)

  - `data.paymentLink.image` (object)

  - `data.paymentLink.image.name` (string,null)

  - `data.paymentLink.image.path` (string,null)

  - `data.paymentLink.image.url` (string,null)

  - `data.paymentLink.image.isPublic` (boolean,null)

  - `data.paymentLink.image.extension` (string,null)

  - `data.paymentLink.description` (string)

  - `data.paymentLink.status` (string)

  - `data.paymentLink.valueInCents` (integer)

  - `data.paymentLink.unpublishedAt` (string)

  - `data.paymentLink.publishedAt` (string)

  - `data.paymentLink.distUrl` (string)

  - `data.paymentLink.preference` (object)

  - `data.paymentLink.preference.acceptCorporationBuyer` (boolean)

  - `data.paymentLink.preference.acceptNaturalPersonBuyer` (boolean)

  - `data.paymentLink.preference.requestAddress` (boolean)

  - `data.paymentLink.preference.requestDeliveryAddress` (boolean)

  - `data.paymentLink.paymentConfiguration` (object)

  - `data.paymentLink.paymentConfiguration.creditCard` (object)

  - `data.paymentLink.paymentConfiguration.creditCard.defaultInstallments` (integer)

  - `data.paymentLink.paymentConfiguration.creditCard.maxInstallments` (integer)

  - `data.paymentLink.paymentConfiguration.pix` (object)

  - `data.paymentLink.paymentConfiguration.pix.expirationInMinutes` (integer)

  - `data.paymentLink.paymentConfiguration.billet` (object)

  - `data.paymentLink.paymentConfiguration.billet.dueDateDelay` (integer)

## Response 400 fields (application/json):

  - `message` (string)
    Invalid param: []
    Example: "Invalid param: []"

  - `error` (string)
    Bad Request
    Example: "Bad Request"

  - `statusCode` (integer)
    400
    Example: 400

## Response 401 fields (application/json):

  - `message` (string)
    Invalid field
    Example: "Unauthorized"

  - `error` (string)
    Unauthorized
    Example: "Unauthorized"

  - `statusCode` (integer)
    401
    Example: 401

## Response 403 fields (application/json):

  - `message` (string)
    Forbidden resource
    Example: "Forbidden resource"

  - `error` (string)
    Forbidden
    Example: "Forbidden"

  - `statusCode` (integer)
    403
    Example: 403

## Response 500 fields (application/json):

  - `message` (string)
    Internal server error
    Example: "Internal server error"

  - `error` (string)
    Internal Server Error
    Example: "Internal Server Error"

  - `statusCode` (integer)
    500
    Example: 500