Payment-links

Payment links are shareable URLs that allow payers to complete a payment without requiring a direct API integration.

Each payment link is associated with a product, amount, and configured payment method. Links can be activated, shared with customers, and used to initiate checkout sessions. They can also be deactivated or deleted when no longer needed.

Use the Payment Links API to create, retrieve, activate, and delete payment links.

Endpoints

GET /payment-links
GET /payment-links/:id
POST /payment-links
DELETE /payment-links/:id
POST /payment-links/:id/activate

Get payment links

get

Lists payment links with filtering and pagination options.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

idstringOptional

Comma separated id to list payment links for.

statusstringOptional

Comma separated status to list payment links for.

destination.accountNumberstringOptional

Comma separated destination account number to list payment links for.

customer.emailstring · emailOptional

Comma separated customer email to list payment links for.

limitinteger · max: 50Optional

Specifies the maximum number of items to return in a single request.

Example: 0

nextintegerOptional

A cursor indicating the position of the last retrieved item.

Example: 0

offsetintegerOptional

A cursor indicating how many items to skip from the request

Example: 0

owner.identityIdstringOptional

Comma separated owner identityIds to list payment links for.

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Example: ConomyApp

Responses

200

Request processed successfully.

application/json

400

Invalid request parameters or payload.

application/json

500

Unexpected internal server error.

application/json

get

/payment-links

HTTPcURLJavaScriptPython

GET /payment-links HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*

{
  "pagination": {
    "count": 1,
    "next": 1,
    "previous": 1,
    "total": 1
  },
  "results": [
    {
      "id": "text",
      "checkoutToken": "text",
      "status": "ATTEMPT",
      "items": [
        {
          "preTaxAmount": "text",
          "totalAmount": "text",
          "description": "text",
          "tax": {
            "name": "text",
            "type": "FIXED",
            "value": "text",
            "amount": "text"
          }
        }
      ],
      "currency": "text",
      "preTaxAmount": "text",
      "totalAmount": "text",
      "url": "text",
      "paymentMethodsAllowed": [
        "CARD"
      ],
      "customer": {
        "id": "text",
        "firstName": "text",
        "email": "text",
        "lastName": "text",
        "phoneNumber": "text",
        "phoneNumberPrefix": "text",
        "documentType": "text",
        "documentNumber": "text",
        "address": {
          "administrativeAreaLevel1": "text",
          "administrativeAreaLevel2": "text",
          "administrativeAreaLevel3": "text",
          "street": "text",
          "streetNumber": "text",
          "optionalAddress": "text",
          "country": "text",
          "zipcode": "text"
        }
      },
      "createdAt": "2026-03-19T19:29:07.659Z",
      "destinations": [
        {
          "name": "text",
          "type": "ACCOUNT",
          "externalId": "text",
          "amount": "text",
          "metadata": {
            "image": "text",
            "description": "text",
            "category": "text"
          },
          "account": {
            "type": "CHECKING",
            "currency": "text",
            "accountNumber": "text",
            "accountHolder": "text"
          }
        }
      ],
      "duration": 1,
      "customerRequirements": [
        "firstName"
      ],
      "owner": {
        "identityId": "text",
        "name": "text",
        "lastname": "text",
        "nickname": "text",
        "documentNumber": "text",
        "entityType": "text"
      },
      "successUrl": "text",
      "failedUrl": "text"
    }
  ]
}

Get payment link

get

Retrieves a payment link by ID.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Paymen link id

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Responses

200

Request processed successfully.

application/json

Payment-link response schema including checkout and status fields.

idstringRequired

Unique identifier for the internal service.

checkoutTokenstringRequired

Reference for checkout url

statusstring · enumRequired

Whether the payment link’s url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated

Possible values:

currencystringRequired

Currency for payment

preTaxAmountstringRequired

Addition of all items preTaxAmounts

totalAmountstringRequired

Addition of all items totalAmounts

urlstringRequired

Url to open checkout flow

createdAtstring · date-timeRequired

When the link expires

durationinteger · min: 30Required

Amount of seconds for payment link to be inactivated after creation

successUrlstringOptional

The URL to which the end user will be redirected after successful payment completion.

failedUrlstringOptional

The URL to which the end user will be redirected after failed payment or cancellation.

400

Invalid request parameters or payload.

application/json

404

Requested resource was not found.

application/json

500

Unexpected internal server error.

application/json

get

/payment-links/{id}

HTTPcURLJavaScriptPython

GET /payment-links/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*

{
  "id": "text",
  "checkoutToken": "text",
  "status": "ATTEMPT",
  "items": [
    {
      "preTaxAmount": "text",
      "totalAmount": "text",
      "description": "text",
      "tax": {
        "name": "text",
        "type": "FIXED",
        "value": "text",
        "amount": "text"
      }
    }
  ],
  "currency": "text",
  "preTaxAmount": "text",
  "totalAmount": "text",
  "url": "text",
  "paymentMethodsAllowed": [
    "CARD"
  ],
  "customer": {
    "id": "text",
    "firstName": "text",
    "email": "text",
    "lastName": "text",
    "phoneNumber": "text",
    "phoneNumberPrefix": "text",
    "documentType": "text",
    "documentNumber": "text",
    "address": {
      "administrativeAreaLevel1": "text",
      "administrativeAreaLevel2": "text",
      "administrativeAreaLevel3": "text",
      "street": "text",
      "streetNumber": "text",
      "optionalAddress": "text",
      "country": "text",
      "zipcode": "text"
    }
  },
  "createdAt": "2026-03-19T19:29:07.659Z",
  "destinations": [
    {
      "name": "text",
      "type": "ACCOUNT",
      "externalId": "text",
      "amount": "text",
      "metadata": {
        "image": "text",
        "description": "text",
        "category": "text"
      },
      "account": {
        "type": "CHECKING",
        "currency": "text",
        "accountNumber": "text",
        "accountHolder": "text"
      }
    }
  ],
  "duration": 1,
  "customerRequirements": [
    "firstName"
  ],
  "owner": {
    "identityId": "text",
    "name": "text",
    "lastname": "text",
    "nickname": "text",
    "documentNumber": "text",
    "entityType": "text"
  },
  "successUrl": "text",
  "failedUrl": "text"
}

Create payment link

post

Creates a reusable payment link for collecting payments.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Body

application/json

Request payload used to create a checkout session.

checkoutTokenstringRequired

Reference for checkout url

currencystringRequired

Currency for payment

durationinteger · min: 30Required

Amount of seconds for payment link to be inactivated after creation

successUrlstringOptional

The URL to which the end user will be redirected after successful payment completion.

failedUrlstringOptional

The URL to which the end user will be redirected after failed payment or cancellation.

Responses

201

Resource created successfully.

application/json

400

Invalid request parameters or payload.

application/json

500

Unexpected internal server error.

application/json

post

/payment-links

HTTPcURLJavaScriptPython

POST /payment-links HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Content-Type: application/json
Accept: */*
Content-Length: 1061

{
  "checkoutToken": "text",
  "items": [
    {
      "preTaxAmount": "text",
      "totalAmount": "text",
      "description": "text",
      "tax": {
        "name": "text",
        "type": "FIXED",
        "value": "text",
        "amount": "text"
      }
    }
  ],
  "currency": "text",
  "paymentMethodsAllowed": [
    "CARD"
  ],
  "customer": {
    "id": "text",
    "firstName": "text",
    "email": "text",
    "lastName": "text",
    "phoneNumber": "text",
    "phoneNumberPrefix": "text",
    "documentType": "text",
    "documentNumber": "text",
    "address": {
      "administrativeAreaLevel1": "text",
      "administrativeAreaLevel2": "text",
      "administrativeAreaLevel3": "text",
      "street": "text",
      "streetNumber": "text",
      "optionalAddress": "text",
      "country": "text",
      "zipcode": "text"
    }
  },
  "destinations": [
    {
      "name": "text",
      "type": "ACCOUNT",
      "externalId": "text",
      "amount": "text",
      "metadata": {
        "image": "text",
        "description": "text",
        "category": "text"
      },
      "account": {
        "type": "CHECKING",
        "currency": "text",
        "accountNumber": "text",
        "accountHolder": "text"
      }
    }
  ],
  "duration": 1,
  "customerRequirements": [
    "firstName"
  ],
  "owner": {
    "identityId": "text",
    "name": "text",
    "lastname": "text",
    "nickname": "text",
    "documentNumber": "text",
    "entityType": "text"
  },
  "successUrl": "text",
  "failedUrl": "text"
}

{
  "id": "text",
  "checkoutToken": "text",
  "status": "ATTEMPT",
  "items": [
    {
      "preTaxAmount": "text",
      "totalAmount": "text",
      "description": "text",
      "tax": {
        "name": "text",
        "type": "FIXED",
        "value": "text",
        "amount": "text"
      }
    }
  ],
  "currency": "text",
  "preTaxAmount": "text",
  "totalAmount": "text",
  "url": "text",
  "paymentMethodsAllowed": [
    "CARD"
  ],
  "customer": {
    "id": "text",
    "firstName": "text",
    "email": "text",
    "lastName": "text",
    "phoneNumber": "text",
    "phoneNumberPrefix": "text",
    "documentType": "text",
    "documentNumber": "text",
    "address": {
      "administrativeAreaLevel1": "text",
      "administrativeAreaLevel2": "text",
      "administrativeAreaLevel3": "text",
      "street": "text",
      "streetNumber": "text",
      "optionalAddress": "text",
      "country": "text",
      "zipcode": "text"
    }
  },
  "createdAt": "2026-03-19T19:29:07.659Z",
  "destinations": [
    {
      "name": "text",
      "type": "ACCOUNT",
      "externalId": "text",
      "amount": "text",
      "metadata": {
        "image": "text",
        "description": "text",
        "category": "text"
      },
      "account": {
        "type": "CHECKING",
        "currency": "text",
        "accountNumber": "text",
        "accountHolder": "text"
      }
    }
  ],
  "duration": 1,
  "customerRequirements": [
    "firstName"
  ],
  "owner": {
    "identityId": "text",
    "name": "text",
    "lastname": "text",
    "nickname": "text",
    "documentNumber": "text",
    "entityType": "text"
  },
  "successUrl": "text",
  "failedUrl": "text"
}

Delete payment link

delete

Only ATTEMPT and EXPIRED links can be deleted

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Paymen link id

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Responses

204

Request processed successfully. No response body is returned.

400

Invalid request parameters or payload.

application/json

404

Requested resource was not found.

application/json

500

Unexpected internal server error.

application/json

delete

/payment-links/{id}

HTTPcURLJavaScriptPython

DELETE /payment-links/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*

No content

Activate payment link

post

Activates a payment link so it can accept new checkout sessions.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Unique identifier of the payment link to activate.

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Responses

200

Request processed successfully.

application/json

Payment-link response schema including checkout and status fields.

idstringRequired

Unique identifier for the internal service.

checkoutTokenstringRequired

Reference for checkout url

statusstring · enumRequired

Whether the payment link’s url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated

Possible values:

currencystringRequired

Currency for payment

preTaxAmountstringRequired

Addition of all items preTaxAmounts

totalAmountstringRequired

Addition of all items totalAmounts

urlstringRequired

Url to open checkout flow

createdAtstring · date-timeRequired

When the link expires

durationinteger · min: 30Required

Amount of seconds for payment link to be inactivated after creation

successUrlstringOptional

The URL to which the end user will be redirected after successful payment completion.

failedUrlstringOptional

The URL to which the end user will be redirected after failed payment or cancellation.

400

Invalid request parameters or payload.

application/json

500

Unexpected internal server error.

application/json

post

/payment-links/{id}/activate

HTTPcURLJavaScriptPython

POST /payment-links/{id}/activate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*

{
  "id": "text",
  "checkoutToken": "text",
  "status": "ATTEMPT",
  "items": [
    {
      "preTaxAmount": "text",
      "totalAmount": "text",
      "description": "text",
      "tax": {
        "name": "text",
        "type": "FIXED",
        "value": "text",
        "amount": "text"
      }
    }
  ],
  "currency": "text",
  "preTaxAmount": "text",
  "totalAmount": "text",
  "url": "text",
  "paymentMethodsAllowed": [
    "CARD"
  ],
  "customer": {
    "id": "text",
    "firstName": "text",
    "email": "text",
    "lastName": "text",
    "phoneNumber": "text",
    "phoneNumberPrefix": "text",
    "documentType": "text",
    "documentNumber": "text",
    "address": {
      "administrativeAreaLevel1": "text",
      "administrativeAreaLevel2": "text",
      "administrativeAreaLevel3": "text",
      "street": "text",
      "streetNumber": "text",
      "optionalAddress": "text",
      "country": "text",
      "zipcode": "text"
    }
  },
  "createdAt": "2026-03-19T19:29:07.659Z",
  "destinations": [
    {
      "name": "text",
      "type": "ACCOUNT",
      "externalId": "text",
      "amount": "text",
      "metadata": {
        "image": "text",
        "description": "text",
        "category": "text"
      },
      "account": {
        "type": "CHECKING",
        "currency": "text",
        "accountNumber": "text",
        "accountHolder": "text"
      }
    }
  ],
  "duration": 1,
  "customerRequirements": [
    "firstName"
  ],
  "owner": {
    "identityId": "text",
    "name": "text",
    "lastname": "text",
    "nickname": "text",
    "documentNumber": "text",
    "entityType": "text"
  },
  "successUrl": "text",
  "failedUrl": "text"
}