Get paginated Payment Links
Get paginated Payment Links
GET {{Environment_URL}}/vendors/v1/payment-links?page=1&limit=20
Retrieve a list of created Payment Links with some available filters and pagination.
Headers
Name
Value
Authorization
Bearer <token>
Path Params
Key
Description
Required
Data Type
Example
page
Current page
false
Integer
1
limit
Number of documents per page
false
Integer
50
currency
Transaction Currency
false
String
USD
nature
Transaction Nature
false
String
SERVICES_AND_OTHERS
phone
Payer's phone number
false
String
+5511987654321
expireAtStart
Lists based on date interval. expireAtStart must be used with rexpireAtEnd
required if expireAtEnd is used
String
2025-02-15 YYYY-MM-DD
expireAtEnd
Lists based on date interval. expireAtEnd must be used with rexpireAtStart
required if expireAtStart is used
String
2026-03-15 YYYY-MM-DD
Response
{
"page": 1,
"totalPages": 1,
"docsShown": 4,
"totalDocs": 4,
"docs": [
{
"id": "plink_01j6j70y1ss68kdjd1bk7vxbj0",
"amount": 100,
"currency": "USD",
"nature": "SERVICES_AND_OTHERS",
"payerId": null,
"phone": null,
"email": 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",
"businessType": "INDIVIDUAL",
"businessClass": [
"RESTAURANT"
],
"name": "Frente Vendor",
"vendorResponsiblePhone": "+55323232323",
"commercialPhone": "+5532323232",
"fullNameResponsible": "42231323232",
"address": {
"city": "dasdasd",
"state": "3dasdas",
"street": "dasdasd 3123",
"country": "sc",
"latitude": "312312",
"longitude": "312312",
"neighborhood": "dasdasdas",
"openingHours": "312"
},
"email": "[email protected]",
"metadata": {
"additionalInformation[0].field": "",
"additionalInformation[0].value": ""
},
"controller": {},
"defaultCurrency": "USD",
"natures": [
"CRYPTO_ACTIVES"
],
"vendorResponsible": {},
"notificationsEmail": "[email protected]",
"commercialEmail": "[email protected]",
"externalAccounts": [],
"status": "PENDING",
"payoutsEnabled": true,
"settings": {},
"createdAt": "2024-05-15T00:37:14.728Z",
"updatedAt": "2024-08-15T12:49:37.119Z",
"financialDate": {
"metaData": [
{
"field": "BANK",
"value": "66263413"
},
{
"field": "AGENCY",
"value": "12332212"
}
],
"vendorBankDetails": {
"country": "as",
"currency": "USD",
"accountName": "312"
}
},
"agentId": "20",
"logo": "https://simple-pay-vendors-demo.s3.amazonaws.com/logos/frente_vendor/1666666666679.png"
}
},
{
"id": "plink_01j6j70a3jcy4qshtbz89g6aan",
"amount": 100,
"currency": "USD",
"nature": "SERVICES_AND_OTHERS",
"payerId": null,
"phone": null,
"email": null,
"externalComment": null,
"internalComment": null,
"externalId": "8ab63a20-12e0-4bb0-b282-34e0a78dc63d",
"expireAt": "2024-03-25T11:54:07.000Z",
"createdAt": "2024-08-30T17:58:19.499Z",
"vendor": {
"id": "vnd_01hxwtx4cj2cmdpbjxz0zsmzzg",
"businessType": "INDIVIDUAL",
"businessClass": [
"RESTAURANT"
],
"name": "Frente Vendor",
"vendorResponsiblePhone": "+55323232323",
"commercialPhone": "+5532323232",
"fullNameResponsible": "42231323232",
"address": {
"city": "dasdasd",
"state": "3dasdas",
"street": "dasdasd 3123",
"country": "sc",
"latitude": "312312",
"longitude": "312312",
"neighborhood": "dasdasdas",
"openingHours": "312"
},
"email": "[email protected]",
"metadata": {
"additionalInformation[0].field": "",
"additionalInformation[0].value": ""
},
"controller": {},
"defaultCurrency": "USD",
"natures": [
"CRYPTO_ACTIVES"
],
"vendorResponsible": {},
"notificationsEmail": "[email protected]",
"commercialEmail": "[email protected]",
"externalAccounts": [],
"status": "PENDING",
"payoutsEnabled": true,
"settings": {},
"createdAt": "2024-05-15T00:37:14.728Z",
"updatedAt": "2024-08-15T12:49:37.119Z",
"financialDate": {
"metaData": [
{
"field": "BANK",
"value": "66263413"
},
{
"field": "AGENCY",
"value": "12332212"
}
],
"vendorBankDetails": {
"country": "as",
"currency": "USD",
"accountName": "312"
}
},
"agentId": "20",
"logo": "https://simple-pay-vendors-demo.s3.amazonaws.com/logos/frente_vendor/1715731111111.png"
}
},
{
"id": "plink_01j6hq7cfta41wjchd3bh60g65",
"amount": 100,
"currency": "USD",
"nature": "SERVICES_AND_OTHERS",
"payerId": null,
"phone": null,
"email": null,
"externalComment": null,
"internalComment": null,
"externalId": "internal-identifier-partner",
"expireAt": "2024-03-25T11:54:07.000Z",
"createdAt": "2024-08-30T13:22:34.090Z",
"vendor": {
"id": "vnd_01hxwtx4cj2cmdpbjxz0zsmzzg",
"businessType": "INDIVIDUAL",
"businessClass": [
"RESTAURANT"
],
"name": "Frente Vendor",
"vendorResponsiblePhone": "+55323232323",
"commercialPhone": "+5532323232",
"fullNameResponsible": "42231323232",
"address": {
"city": "dasdasd",
"state": "3dasdas",
"street": "dasdasd 3123",
"country": "sc",
"latitude": "312312",
"longitude": "312312",
"neighborhood": "dasdasdas",
"openingHours": "312"
},
"email": "[email protected]",
"metadata": {
"additionalInformation[0].field": "",
"additionalInformation[0].value": ""
},
"controller": {},
"defaultCurrency": "USD",
"natures": [
"CRYPTO_ACTIVES"
],
"vendorResponsible": {},
"notificationsEmail": "[email protected]",
"commercialEmail": "[email protected]",
"externalAccounts": [],
"status": "PENDING",
"payoutsEnabled": true,
"settings": {},
"createdAt": "2024-05-15T00:37:14.728Z",
"updatedAt": "2024-08-15T12:49:37.119Z",
"financialDate": {
"metaData": [
{
"field": "BANK",
"value": "66263413"
},
{
"field": "AGENCY",
"value": "12332212"
}
],
"vendorBankDetails": {
"country": "as",
"currency": "USD",
"accountName": "312"
}
},
"agentId": "20",
"logo": "https://simple-pay-vendors-demo.s3.amazonaws.com/logos/frente_vendor/1234567893011.png"
}
},
{
"id": "plink_01j6hq5v5qcebxwbkpcyq71n7b",
"amount": 100,
"currency": "USD",
"nature": "SERVICES_AND_OTHERS",
"payerId": null,
"phone": null,
"email": null,
"externalComment": null,
"internalComment": null,
"externalId": "353fe53f-ac8d-436c-b833-826cd91c1265",
"expireAt": "2024-03-25T11:54:07.000Z",
"createdAt": "2024-08-30T13:21:43.595Z",
"vendor": {
"id": "vnd_01hxwtx4cj2cmdpbjxz0zsmzzg",
"businessType": "INDIVIDUAL",
"businessClass": [
"RESTAURANT"
],
"name": "Frente Vendor",
"vendorResponsiblePhone": "+55323232323",
"commercialPhone": "+5532323232",
"fullNameResponsible": "42231323232",
"address": {
"city": "dasdasd",
"state": "3dasdas",
"street": "dasdasd 3123",
"country": "sc",
"latitude": "312312",
"longitude": "312312",
"neighborhood": "dasdasdas",
"openingHours": "312"
},
"email": "[email protected]",
"metadata": {
"additionalInformation[0].field": "",
"additionalInformation[0].value": ""
},
"controller": {},
"defaultCurrency": "USD",
"natures": [
"CRYPTO_ACTIVES"
],
"vendorResponsible": {},
"notificationsEmail": "[email protected]",
"commercialEmail": "[email protected]",
"externalAccounts": [],
"status": "PENDING",
"payoutsEnabled": true,
"settings": {},
"createdAt": "2024-05-15T00:37:14.728Z",
"updatedAt": "2024-08-15T12:49:37.119Z",
"financialDate": {
"metaData": [
{
"field": "BANK",
"value": "66263413"
},
{
"field": "AGENCY",
"value": "12332212"
}
],
"vendorBankDetails": {
"country": "as",
"currency": "USD",
"accountName": "312"
}
},
"agentId": "20",
"logo": "https://simple-pay-vendors-demo.s3.amazonaws.com/logos/frente_vendor/1712222222222.png"
}
}
]
}