> ## Documentation Index > Fetch the complete documentation index at: https://developers.staging01.melio.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # List payments > Returns the entity's payments, newest first. Use the filters below to narrow the list; they can be combined with each other and with pagination. ## OpenAPI ````yaml /openapi.json get /payments openapi: 3.0.3 info: title: Melio Payouts API version: '1.0' description: > Self-serve payouts API. Partners onboard an Entity, which is the business (organization plus owner, with the details required to be payment-eligible), then attach accounts (internal accounts and external accounts) and make payments. ## Resource ids Every resource has an opaque, prefixed id that is stable for the life of the resource: `ent_` (entity), `pay_` (payment), `acct_` (account, internal or external). Ids are Melio-issued; treat them as opaque strings and never parse or construct them. To attach your own identifier to a resource, use `externalId`. ## Pagination List endpoints are cursor-paginated and always return results newest-first (`createdAt` descending). The response envelope is: ```json { "data": [ /* resources */ ], "hasMore": true } ``` Page through results with `limit` (1 to 50, default 50) plus a cursor: - `startingAfter=`: return the page immediately **after** the given resource id (the next, older page). This is how you walk forward through a list. - `endingBefore=`: return the page immediately **before** the given resource id (the previous, newer page). `startingAfter` and `endingBefore` are mutually exclusive. The cursor is a resource id you already received (e.g. the `id` of the last item on the current page), not an index. Keep requesting the next page until `hasMore` is `false`. ## Filtering & sorting Ordering is fixed (newest-first); there is no `sortBy`. To narrow a list, filter it. Each list endpoint documents its own filter parameters (there is no generic query language). Date-range filters use bracket suffixes and accept RFC 3339 timestamps: `created[gte]`, `created[lte]`. Filter by your own identifier with `externalId`, and by metadata with `metadata[]=` (matches resources whose metadata contains every supplied key/value pair). Filters combine with AND and compose with pagination. ## External ids Every created resource accepts an optional `externalId`, your own unique identifier for the resource (≤255 chars, letters/digits/`-`/`_`). It is unique per partner per resource type: reusing one returns `409 DUPLICATE_EXTERNAL_ID`. Use it to correlate Melio resources with records in your system and to look resources up (`?externalId=`) without storing Melio ids. `externalId` identifies a *resource*; it is not a request-deduplication key (that is the `Idempotency-Key` header, below); the two are complementary. ## Idempotency Send an `Idempotency-Key` header on every create so retries are safe: the original response is replayed instead of creating a second resource. It is required on `POST /payments`. ## Metadata Most resources accept a `metadata` object: free-form string key/value pairs that Melio stores and returns verbatim but never interprets. Limits: up to 50 keys, key ≤40 chars, value ≤100 chars. Use it to stash your own structured context on a resource; it is also filterable (see above). ## Melio Sonar Session Token Write endpoints optionally accept a `Melio-Sonar-Token` header: a signed session token minted by the MelioSonar SDK on the end user's device, carrying device signals used for risk evaluation. Omit it when no SDK session is available. contact: name: Melio Platform External API email: platform@melio.com servers: - description: Production url: https://api.melio.com/v2 - description: Staging01 url: https://api.staging01.melio.com/v2 security: [] tags: - name: Entities description: >- A business you onboard and operate on behalf of: its profile, compliance details, and per-operation limitations. - name: Accounts description: Accounts the entity pays from (internal) and payees it pays to (external). - name: Payments description: >- Money moved from an internal account to an external account, and their lifecycle. - name: Tools description: >- Pre-flight calculators for fees, fast-payment eligibility, and delivery estimates. No resource is created. - name: Webhooks description: >- Your single endpoint for event notifications, and the events you can subscribe to. paths: /payments: parameters: - $ref: '#/components/parameters/MelioEntityId' get: tags: - Payments summary: List payments description: > Returns the entity's payments, newest first. Use the filters below to narrow the list; they can be combined with each other and with pagination. parameters: - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/StartingAfter' - $ref: '#/components/parameters/EndingBefore' - name: externalId in: query required: false description: Return only the payment whose `externalId` matches (your own id). schema: type: string - name: status in: query required: false description: Filter by payment status. schema: type: string enum: - scheduled - in-progress - completed - failed - canceled - name: originatingAccountId in: query required: false description: >- Return only payments drawn from this internal originating account (acct_). schema: type: string - name: receivingAccountId in: query required: false description: >- Return only payments sent to this external receiving account (acct_). schema: type: string - name: created[gte] in: query required: false description: Return payments created at or after this RFC 3339 timestamp. schema: type: string format: date-time - name: created[lte] in: query required: false description: Return payments created at or before this RFC 3339 timestamp. schema: type: string format: date-time - name: metadata in: query required: false style: deepObject explode: true description: > Filter by metadata key/value pairs, e.g. `metadata[invoiceId]=INV-42`. Matches payments whose metadata contains every supplied pair. schema: type: object additionalProperties: type: string responses: '200': description: A page of payments, newest first. content: application/json: schema: $ref: '#/components/schemas/PaymentList' examples: firstPage: summary: First page (limit=2, more available) value: hasMore: true data: - id: pay_9f8c7b6a5d4e3f21 externalId: invoice-2043 amount: 125000 currency: USD originatingAccountId: acct_3f2504e0-4f89-41d3-9a0c-0305e82c3301 receivingAccountId: acct_9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d deductionDate: '2026-07-10' deliveryDate: '2026-07-14' status: scheduled metadata: invoiceId: INV-2043 department: operations createdAt: '2026-07-08T15:04:05Z' updatedAt: '2026-07-08T15:04:05Z' - id: pay_1a2b3c4d5e6f7a8b externalId: invoice-2041 amount: 4200 currency: USD originatingAccountId: acct_3f2504e0-4f89-41d3-9a0c-0305e82c3301 receivingAccountId: acct_9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d deductionDate: '2026-07-09' deliveryDate: '2026-07-11' status: completed metadata: {} createdAt: '2026-07-07T09:22:00Z' updatedAt: '2026-07-07T09:22:00Z' lastPage: summary: Final page (hasMore=false) value: hasMore: false data: - id: pay_0000111122223333 externalId: invoice-1900 amount: 8000 currency: USD originatingAccountId: acct_3f2504e0-4f89-41d3-9a0c-0305e82c3301 receivingAccountId: acct_9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d deductionDate: '2026-06-30' deliveryDate: '2026-07-02' status: completed metadata: {} createdAt: '2026-06-29T12:00:00Z' updatedAt: '2026-06-29T12:00:00Z' '404': description: Entity not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - ApiKey: [] components: parameters: MelioEntityId: name: Melio-Entity-Id in: header required: true description: >- Entity the request operates on — an entity id (`ent_`) or `me` (the partner's sole entity). schema: type: string Limit: name: limit in: query required: false description: Maximum number of resources to return, 1 to 50. Defaults to 50. schema: type: integer minimum: 1 maximum: 50 default: 50 StartingAfter: name: startingAfter in: query required: false description: > Cursor for forward (older) pagination: a resource id. The page returned starts immediately after this resource. Mutually exclusive with `endingBefore`. schema: type: string EndingBefore: name: endingBefore in: query required: false description: > Cursor for backward (newer) pagination: a resource id. The page returned ends immediately before this resource. Mutually exclusive with `startingAfter`. schema: type: string schemas: PaymentList: type: object required: - data - hasMore properties: data: type: array items: $ref: '#/components/schemas/Payment' hasMore: type: boolean description: >- True when more resources exist after this page; page again using the last item's id as `startingAfter`. ErrorResponse: type: object required: - error properties: error: $ref: '#/components/schemas/Error' Payment: type: object required: - fees properties: id: type: string description: Opaque payment id (pay_) externalId: $ref: '#/components/schemas/ExternalId' amount: type: integer currency: type: string originatingAccountId: type: string description: Internal originating account id (acct_) receivingAccountId: type: string description: External receiving account id (acct_) deductionDate: type: string format: date deliveryPreference: type: string enum: - standard-ach - same-day-ach - rtp - standard-check - express-check - overnight-check - domestic-wire - instant-domestic-wire - virtual-card - instant-virtual-card description: > Effective delivery preference. Reflects the faster variant when one was applied, otherwise the receiving rail's normal-speed value. deliveryDate: type: string format: date status: type: string enum: - scheduled - in-progress - completed - failed - canceled description: > While a payment is being reviewed it is reported as `scheduled`; there is no separate review status. noteToSelf: type: string description: Payer-private memo, never shown to the recipient noteToRecipient: type: string description: Note shown to the payment recipient metadata: $ref: '#/components/schemas/Metadata' fees: type: array description: > The fees charged for this payment, as recorded by the fees service. Includes both the originator-side and receiver-side fees; use `chargeTo` on each item to tell them apart. Always present — an empty array when no fees have been recorded yet (e.g. a freshly created payment). items: $ref: '#/components/schemas/PaymentFee' createdAt: type: string format: date-time updatedAt: type: string format: date-time Error: type: object required: - type - code - message properties: type: type: string description: >- Coarse, machine-readable error category. Branch on this to handle a whole class of failures without enumerating every `code`. enum: - invalid_request_error - authentication_error - authorization_error - not_found_error - conflict_error - rate_limit_error - service_unavailable_error - internal_error code: type: string description: Machine-readable error code. enum: - VALIDATION_ERROR - INVALID_ACCOUNT_TYPE - INVALID_DELIVERY_PREFERENCE - MCC_REQUIRED - GOODS_RECEIVED_REQUIRED - IDEMPOTENCY_KEY_REQUIRED - FEE_CALCULATION_FAILED - UNAUTHORIZED - NOT_FOUND - NO_ACTIVE_API_KEY - DUPLICATE_ENTITY - DUPLICATE_ACCOUNT - DUPLICATE_PAYMENT - DUPLICATE_EXTERNAL_ID - ACCOUNT_IN_USE - BUSINESS_NOT_ELIGIBLE - PAYMENT_NOT_EDITABLE - PAYMENT_NOT_CANCELABLE - IDEMPOTENCY_KEY_REUSED - IDEMPOTENCY_KEY_IN_PROGRESS - IDEMPOTENCY_STORE_UNAVAILABLE - INTERNAL_ERROR message: type: string description: Human-readable error message. details: type: object description: Additional error context (e.g. field-level validation failures). ExternalId: type: string description: > Your own unique identifier for the resource. Unique per partner per resource type (reusing one returns 409 DUPLICATE_EXTERNAL_ID). Distinct from the Idempotency-Key header, which dedupes the request rather than identifying the resource. maxLength: 255 pattern: ^[A-Za-z0-9_-]+$ Metadata: type: object description: > Free-form string key/value pairs stored and returned verbatim, never interpreted by Melio. Up to 50 keys; each key 1 to 40 chars and may not contain square brackets (`[` `]`, reserved for the `metadata[key]` filter); value ≤100 chars. Filterable via `metadata[key]`. additionalProperties: type: string maxLength: 100 maxProperties: 50 PaymentFee: description: > A single fee charged for a payment. Shares the `Fee` shape used by the fee calculator (`type`, `chargeTo`, `fixed`/`percent`, `amount`, all monetary values in minor units), and adds `status`, which only applies once a fee has actually been applied to a payment. allOf: - $ref: '#/components/schemas/Fee' - type: object required: - status properties: status: type: string enum: - charged - pending description: Whether the fee has been charged or is still pending. Fee: type: object description: >- A single fee that would apply to the payment. All monetary values are minor units (cents). required: - type - chargeTo properties: type: type: string description: The fee category (e.g. ach, card, expedited-ach). chargeTo: type: string enum: - originator - receiver description: > Which side of the payment the fee is levied on: the account originating the payment or the account receiving it. Works for both estimated (calculator) and applied (payment) fees. fixed: type: object description: Present when the fee is a flat amount. properties: value: type: integer description: Flat fee, minor units (cents) percent: type: object description: Present when the fee is a percentage of the payment amount. properties: rate: type: number description: Percentage rate (e.g. 2.9 = 2.9%) min: type: integer description: Minimum fee, minor units (cents) max: type: integer description: Maximum fee, minor units (cents) amount: type: integer description: > The resolved fee for the requested payment amount, in minor units (cents). Absent only when the fee cannot be resolved without a per-payment quote (e.g. tiered pricing). securitySchemes: ApiKey: type: apiKey in: header name: api-key ````