Payments
List Payments
Acesso
Membro da organização com esta permissão:
payments:read
Uma chave de API com scopes também precisa da permissão nos seus scopes.
GET
Lists payments with filtering, sorting, pagination, optional includes, and relation-exists filters (has{Relation} style). Search matches Tillor payment IDs, references, descriptions, customers, and invoices. Use cardFingerprint for an exact match on Mollie channelInfo.details.cardFingerprint, maskedNumber for an exact match on channelInfo.details.maskedNumber or cardMaskedNumber, or pass the same values via search. Json path filters such as channelInfo.details.maskedNumber are also supported.
ApiKeyAuthheader
x-api-key<token>API key for authentication
organizationId*stringThe ID or slug of the organization
page?integerRange
-9007199254740991 <= value <= 9007199254740991limit?integerRange
-9007199254740991 <= value <= 9007199254740991sortBy?stringValue in
"id""amount""amountRefunded""amountRemaining""currency""description""reference""createdAt""updatedAt""expiresAt""paidAt""delayUntil""errorMessage""errorMessageTranslationKey""status""method""channel""provider""channelInfo""accountingSoftwareProvider""accountingSoftwareMetadata""createdById""invoiceId""customerId""mandateId""paymentReportId""paymentGroupId"sortDir?stringValue in
"asc""desc"include?|array<>|stringcreatedById?string|array<string>|nullinvoiceId?string|array<string>|nullcustomerId?string|array<string>|nullmandateId?string|array<string>|nullpaymentReportId?string|array<string>|nullpaymentGroupId?string|array<string>|nullstatus?|array<>|method?|array<>|channel?|array<>|provider?|array<>|accountingSoftwareProvider?|array<>|amount?number||amountRefunded?number||amountRemaining?number||createdAt?|nullupdatedAt?|nullexpiresAt?|nullpaidAt?|nulldelayUntil?|nullcurrency?string|array<string>|description?string|array<string>|reference?string|array<string>|errorMessage?string|array<string>|errorMessageTranslationKey?string|array<string>|channelInfo?accountingSoftwareMetadata?hasStatusChanges?boolean|string|number|nullhasNoStatusChanges?boolean|string|number|nullhasEventLogs?boolean|string|number|nullhasNoEventLogs?boolean|string|number|nullhasAuditLogs?boolean|string|number|nullhasNoAuditLogs?boolean|string|number|nullhasNotificationDeliveries?boolean|string|number|nullhasNoNotificationDeliveries?boolean|string|number|nullhasComments?boolean|string|number|nullhasNoComments?boolean|string|number|nullstatusChangeId?string|array<string>|eventLogId?string|array<string>|auditLogId?string|array<string>|notificationDeliveryId?string|array<string>|commentId?string|array<string>|hasCreatedBy?boolean|string|number|nullhasNoCreatedBy?boolean|string|number|nullhasInvoice?boolean|string|number|nullhasNoInvoice?boolean|string|number|nullhasCustomer?boolean|string|number|nullhasNoCustomer?boolean|string|number|nullhasMandate?boolean|string|number|nullhasNoMandate?boolean|string|number|nullhasPaymentReport?boolean|string|number|nullhasNoPaymentReport?boolean|string|number|nullhasPaymentGroup?boolean|string|number|nullhasNoPaymentGroup?boolean|string|number|nullsearch?stringcardFingerprint?stringLength
1 <= lengthmaskedNumber?stringLength
1 <= lengthPaginated payments matching the filters.
application/json- response
curl -X GET 'https://api.tillor.eu/orgs//payments'Example Response
null