Criar link de pagamento

POST

/api/v1/payment-links

Endpoint para criar um novo link de pagamento.

💾 Estrutura de Dados

Headers

Content-type: application/json

Authorization: Bearer <JWT_TOKEN>

Body (JSON)

Propriedade	Tipo	Obrigatório	Descrição	Valor (exemplo)
amount	Number	Sim	Valor do link de pagamento	300.50
description	String	Sim	Descrição breve sobre o link de pagamento	-

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/json

Examples

Responses

🟢201

application/json

Body

🟠400

🟠401

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://xpend-backend.onrender.com/api/v1/payment-links' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 200.5,
    "description": "Payment link example."
}'

Response Example

201 - Success

{
    "id": "0c2cfea4-6866-456b-bca8-17cb7f2bef6f",
    "sellerId": "cac09ce6-8fa1-4c3d-ae2c-cf3958be7450",
    "description": "Payment link example.",
    "url": "http://localhost:3000/checkout/link-IJE-CalF-k",
    "hash": "link-IJE-CalF-k",
    "status": "ACTIVE",
    "qtdPayments": 0,
    "amount": 200.5,
    "createdAt": "2025-11-14T18:40:01.503Z"
}

Modified at 2025-12-27 01:31:55

Atualizar credenciais

Listar links de pagamento

Criar link de pagamento

💾 Estrutura de Dados#

Headers#

Body (JSON)#

Request

Responses

💾 Estrutura de Dados

Headers

Body (JSON)