Criar novo pagamento
POST
/api/v1/payments
š¾ Estrutura de Dados
Headers
application/jsonseu_token_jwtBody (JSON)
| Propriedade | Tipo | ObrigatĆ³rio | DescriĆ§Ć£o | Valor (exemplo) |
|---|---|---|---|---|
| purchaser | Enum | Sim | Provider de pagamento, por enquanto o Ć© valor fixo | Valores possĆveis: pluggou |
| amount | Number | Sim | Valor do pagamento. Deve ser igual ou maior a 10 | 150 |
| currency | string | Sim | CĆ³digo da moeda usada no pagamento | BRL |
| sellerId | String | Sim | Identificador Ćŗnico (ID) do cliente (Seller) | - |
| paymentMethod | Enum | Sim | MĆ©todo de pagamento escolhido, por enquanto tem somente o Pix | pix |
| paymentLinkId | string | Sim | Identificador do link de pagamento utilizado na transaĆ§Ć£o | e2b1c0b2-4f0e-4f5d-9c8e-0e7f3d3e3b07 |
| customer.name | String | Sim | Nome completo do cliente do vendedor | JoĆ£o Silva |
| customer.email | String | Sim | Email de contato do cliente do vendedor | joao@email.com |
| customer.document.number | String | Sim | NĆŗmero do documento de identificaĆ§Ć£o do cliente do vendedor | 12345678900 |
| customer.document.type | Enum | Sim | Tipo de documento do cliente do vendedor | Valores possĆveis: CPF, CNPJ |
| customer.phone | String | Sim | Telefone do cliente do vendedor (DDD + NĆŗmero) | 11999999999 |
| postBackUrl | String | NĆ£o | Para criar um webhook automaticamente para o vendedor se nĆ£o existir | - |
| metadata | String | NĆ£o | Armazenar alguma informaĆ§Ć£o que serĆ” retornada na resposta do webhook | - |
ObservaĆ§Ć£o: O sellerIdĆ© o identificador para o vendedor (seller)
RequisiĆ§Ć£o
ParĆ¢metros Bodyapplication/json
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v1/payments' \
--header 'Content-Type: application/json' \
--data-raw '{
"purchaser": "pluggou",
"amount": 15,
"currency": "BRL",
"sellerId": "ad36072a-cbd7-48b1-a1fb-a5e75fbb8015",
"paymentMethod": "pix",
"paymentLinkId": "481ca7fe-c035-4586-aff9-5bd0e4b6756c",
"customer": {
"name": "JoĆ£o Silva",
"email": "joao@email.com",
"document": {
"number": "35359383097",
"type": "cpf"
},
"phone": "11999999999"
},
"postBackUrl": "",
"metadata": ""
}'Response Response Example
200 - Sucesso
{
"id": "69397a75-32b7-4524-b14b-996816b4f264",
"externalId": "e6650d0c-5292-42c6-a105-d8043face9df",
"amount": 15,
"status": "CREATED",
"qrCode": "00020101021226820014br.gov.bcb.pix2560qrcode.pagsm.com.br/pix/9ef8caca-617b-47b3-bb0d-b786edeed22a5204000053039865802BR59079inbank6006PARANA61088668000062070503***6304AA55",
"createdAt": "2025-12-02T18:34:34.432Z",
"expiresAt": "2025-12-03T18:34:35.347Z",
"confirmedAt": null,
"purchaser": "pluggou",
"method": "pix",
"customerEmail": "fredson@mail.com",
"customerName": "Fredson Luiz",
"paymentLinkId": "2dfc4271-d48e-4af5-85fb-69f787c8ec55",
"amountWithAllFees": 5.75,
"amountWithFeesPagLemon": 6.25,
"amountWithFeesGateway": 14.5,
"customerId": "ad36072a-cbd7-48b1-a1fb-a5e75fbb8015",
"metadata": null,
"paymentLink": {
"id": "2dfc4271-d48e-4af5-85fb-69f787c8ec55",
"description": "Produto qualquer",
"url": "http://localhost:3000/checkout/link-PQIV-3C-k7",
"status": "ACTIVE",
"qtdPayments": 0,
"amount": 1500,
"createdAt": "2025-12-02T18:34:03.509Z",
"hash": "link-PQIV-3C-k7",
"purchaser": "pluggou",
"sellerId": "ad36072a-cbd7-48b1-a1fb-a5e75fbb8015"
}
}Modificado emĀ 2025-12-31 00:48:40