Payment Link Example
Payment Link Events
Event
Description
payment-link.created
Triggered when a payment-link is created.
payment-link.succeeded
Triggered when a payment-link is completed successfully.
payment-link.pending
Triggered when a payment-link is pending.
payment-link.failed
Triggered when a payment-link fails.
payment-link.refunded
Triggered when a payment-link is refunded.
payment-link.canceled
Triggered when a payment-link is canceled.
payment-link.expired
Triggered when a payment-link expires.
Event example
{
"metadata": null,
"id": "evt_01kbfja7d5cbm3dnvaexsrze6h",
"type": "payment-link.succeeded",
"data": {
"id": "plink_01mprrjg8zxu5dn63h4t4qbvkc",
"email": "[email protected]",
"phone": "54354353",
"amount": 777,
"nature": "SERVICES_AND_OTHERS",
"status": "SUCCEEDED",
"vendor": {
"id": "vnd_01q7m48xt2dlu69hjr7c31yv95",
"logo": "{{url}}.jpeg",
"name": "Vendor API",
"email": "[email protected]",
"status": "PENDING",
"address": {
"city": "São Veridiano",
"state": "Monte Azul",
"street": "Avenida das Auroras, 987 - 11223-445",
"country": "br",
"latitude": "0",
"longitude": "0",
"neighborhood": "Jardim Nebuloso",
"openingHours": "24h"
},
"natures": [
"SERVICES_AND_OTHERS"
],
"pricing": {
"taxesAndCosts": 3.5
},
"metadata": {
"additionalInformation[0].field": "",
"additionalInformation[0].value": ""
},
"settings": {
"broker": "FRENTE",
"products": [
"PAYMENT_LINK",
"PAY_WITH_PIX"
],
"withdrawal": {
"balance": true,
"currency": "BRL",
"withdraw": true
},
"releaseBatch": "backoffice",
"sendEmailToNewAccounts": false,
"enableNotificationEmail": false,
"minimumDaysToCreateBatch": {
"minDays": 0,
"isActive": false
}
},
"createdAt": "2025-07-23T16:16:49.341Z",
"updatedAt": "2025-11-17T15:54:24.395Z",
"controller": {},
"businessType": "COMPANY",
"businessClass": [
"OTHER_SERVICES"
],
"financialData": {
"metaData": [
{
"field": "",
"value": ""
}
],
"vendorBankDetails": {}
},
"payoutsEnabled": true,
"commercialEmail": "[email protected]",
"commercialPhone": "+55 11 99999-9999",
"defaultCurrency": "EUR",
"externalAccounts": [
{
"id": "ea_01m8z62qlvy5rk44tjsb21np8x",
"type": [
"CHARGE"
],
"status": "NEW",
"country": "BR",
"bankName": "Wise",
"currency": "EUR",
"metadata": {
"": ""
},
"bankChips": null,
"bankSwift": "TRWIBEB1XXX",
"bankAbaFed": null,
"accountHolderName": "John Doe",
"accountHolderType": "Checking",
"accountHolderNumber": "BE51967200819062"
}
],
"vendorResponsible": {},
"notificationsEmail": "[email protected]",
"fullNameResponsible": "John Doe",
"vendorResponsiblePhone": "+55 11 99999-9999",
"minimumValueForFinanceBatch": 50000
},
"account": {
"id": "acc_01m8z62qlvlirk44tjsb21np0q",
"logo": null,
"name": "John Doe",
"type": "ADMINISTRATOR",
"status": "PENDING",
"vendor": {
"id": "vnd_01q7m48xt2dlu69hjr7c31yv95",
"logo": "{{url}}.jpeg",
"name": "VENDOR API",
"address": {
"city": "São Veridiano",
"state": "Monte Azul",
"street": "Avenida das Auroras, 987 - 11223-445",
"country": "br",
"latitude": "0",
"longitude": "0",
"neighborhood": "Jardim Nebuloso",
"openingHours": "24h"
},
"commercialPhone": "+55 11 99999-9999"
},
"address": null,
"contact": null,
"metadata": {
"": ""
},
"provider": null,
"bankNumber": null,
"defaultPix": null,
"externalId": null,
"providerId": null,
"loginEnable": true,
"agencyNumber": null,
"accountNumber": null,
"chargesEnable": true,
"externalAccounts": []
},
"charges": [],
"payerId": null,
"currency": "USD",
"expireAt": "2025-12-25T00:00:00.000Z",
"metadata": null,
"createdAt": "2025-11-24T21:19:47.830Z",
"feeMaster": null,
"fsmEvents": {
"status": [
{
"to": "PENDING",
"from": "CREATED",
"timestamp": "2025-11-24T21:19:47.838Z",
"transition": "start"
},
{
"to": "SUCCEEDED",
"from": "PENDING",
"timestamp": "2025-11-24T21:20:54.473Z",
"transition": "success"
}
]
},
"externalId": "tere444",
"spreadMaster": null,
"externalComment": null,
"internalComment": null
},
"createdAt": "2025-12-02T12:59:02.946Z"
}