Get Payment Link by ID
Get Payment Link by ID
GET {{Environment_URL}}/vendors/v1/public/payment-links/{{paymentLinkId}}
Retrieve a created Payment Link by searching for it's ID
Headers
Name
Value
Authorization
Bearer <token>
Path Params
Name
Type
Description
Value
paymentLinkId
string
The created Payment Link ID
plink_01j6hq7cfta41wjchd3bh60g65
Response
{
"id": "plink_01j6hq7cfta41wjchd3bh60g64",
"amount": 100,
"currency": "USD",
"nature": "SERVICES_AND_OTHERS",
"payerId": null,
"phone": null,
"externalComment": null,
"internalComment": null,
"externalId": "62d464c6-abbd-4e48-b6b5-b4ef515fd496",
"expireAt": "2025-03-25T11:54:07.000Z",
"createdAt": "2024-08-30T17:58:39.919Z",
"vendor": {
"id": "vnd_01hxwtx4cj2cmdpbjxz0zsmzzg",
"name": "Frente Vendor",
"logo": "https://simple-pay-vendors-demo.s3.amazonaws.com/logos/frente_vendor/1710001111111.png",
"commercialPhone": "+5532323232",
"address": {
"city": "dasdasd",
"state": "3dasdas",
"street": "dasdasd 3123",
"country": "sc",
"latitude": "312312",
"longitude": "312312",
"neighborhood": "dasdasdas",
"openingHours": "312"
}
},
"quotation": {
"id": "feb817af7a94c9da21c527172b9728fe7d1830a9",
"metadata": {
"externalId": "plink_01j6j70y1ss68kdjd1bk7vxbj0"
},
"currency": {
"code": "USD",
"name": "Dólar Americano",
"commercialExchangeRate": {
"value": 49660,
"divisor": 10000,
"currency": "BRL",
"precision": 4,
"updatedAt": "2023-08-14T20:08:25.000Z"
},
"countryFlagUrl": "https://s3.amazonaws.com/simple-exchanges-demo/new-flags/united-states.svg",
"levelingRate": {
"value": 49680,
"divisor": 10000,
"currency": "BRL",
"precision": 4
},
"maxValueSimplePay": {
"value": 1000000,
"divisor": 100,
"currency": "USD",
"precision": 2
},
"minValueSimplePay": {
"value": 1,
"divisor": 100,
"currency": "USD",
"precision": 2
},
"clamp": "NORMAL",
"offer": {
"value": 100,
"divisor": 100,
"currency": "USD",
"precision": 2
},
"offerUSD": {
"value": 100,
"divisor": 100,
"currency": "USD",
"precision": 2
},
"price": {
"withoutTax": {
"value": 50674,
"divisor": 10000,
"currency": "BRL",
"precision": 4
},
"withTax": {
"value": 50866,
"divisor": 10000,
"currency": "BRL",
"precision": 4
},
"withTaxesAndFees": {
"value": 50866,
"divisor": 10000,
"currency": "BRL",
"precision": 4
},
"withFutureTax": {
"value": 50866,
"divisor": 10000,
"currency": "BRL",
"precision": 4
}
},
"spreads": [
{
"name": "SPREAD_FC",
"type": "percentage",
"receiver": "PLATFORM_FEE",
"percentage": 2,
"netValue": {
"value": 10,
"divisor": 100,
"currency": "BRL",
"precision": 2
}
}
],
"fees": []
},
"tax": {
"iof": {
"percentage": 0.38,
"total": {
"value": 2,
"divisor": 100,
"currency": "BRL",
"precision": 2
}
}
},
"futureTax": {
"ir": {
"percentage": 0,
"total": {
"value": 0,
"divisor": 100,
"currency": "BRL",
"precision": 2
}
}
},
"total": {
"withoutTax": {
"value": 507,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"withTax": {
"value": 509,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"withTaxesAndFees": {
"value": 509,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"withFutureTax": {
"value": 509,
"divisor": 100,
"currency": "BRL",
"precision": 2
}
},
"createdAt": "2024-08-30T17:58:47.243Z"
}
}