--- updatedAt: 2026-07-22T09:35:36.000Z agentTools: projectIndex: https://docs.moneyhubenterprise.com/llms.txt --- # Retrieve all payments created by an API client Requires **payment:read** scope. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "description": "Swagger 2.0 docs for the authentication/authorization Moneyhub API", "title": "Moneyhub Identity Service", "version": "2.0.0" }, "security": [ { "Bearer": [] } ], "paths": { "/payments": { "get": { "summary": "Retrieve all payments created by an API client", "description": "Requires **payment:read** scope.", "parameters": [ { "description": "The total number of records to retrieve", "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } }, { "description": "The offset at which to start retrieving records", "in": "query", "name": "offset", "schema": { "type": "integer", "minimum": 0, "maximum": 1000000000 } }, { "description": "The ID of the user to filter transactions on", "in": "query", "name": "userId", "schema": { "type": "string", "minLength": 24, "maxLength": 24 } }, { "description": "The ID of the payee to filter transactions on", "in": "query", "name": "payeeId", "schema": { "type": "string", "format": "uuid" } }, { "description": "The date to start filtering transactions on", "in": "query", "name": "startDate", "schema": { "type": "string", "format": "date" } }, { "description": "The date to end filtering transactions on", "in": "query", "name": "endDate", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Successful Payment Response", "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Payment" }, "type": "array" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object" } } } }, "401": { "description": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Unsuccessful Response - Forbidden - Invalid scopes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "tags": [ "payments" ] } } }, "servers": [ { "url": "https://identity.moneyhub.co.uk" } ], "components": { "securitySchemes": { "Bearer": { "type": "apiKey", "name": "Authorization", "in": "header" } }, "schemas": { "Payment": { "additionalProperties": false, "type": "object", "properties": { "id": { "description": "The id of the payment", "example": "c390a94f-2309-4cdf-8d02-b0c5304d9f66", "type": "string", "format": "uuid" }, "bankId": { "description": "The id of the bank", "example": "1ffe704d39629a929c8e293880fb449a", "type": "string" }, "amount": { "description": "Payment amount in minor units of the currency, eg. pennies for GBP.", "type": "integer", "minimum": 1, "maximum": 25000000, "example": 1500 }, "payeeId": { "description": "Payee id", "type": "string", "example": "bb1c7ebf-24a3-4e06-afc7-599de43b7bad", "format": "uuid" }, "payeeType": { "description": "Type of payee", "type": "string", "example": "api-payee", "enum": [ "api-payee", "mh-user-account" ] }, "payerId": { "description": "Payer Id", "type": "string", "example": "5f50bf05ab5bf185d5c94fb5:0bcdf548-24e7-4ebe-bee5-ab4fd2b6b22b" }, "payerRef": { "description": "Reference to display on payer's statement", "type": "string", "example": "Payer ref", "minLength": 2, "maxLength": 18 }, "payerType": { "description": "Payer Type", "type": "string", "enum": [ "mh-user-account", "api-payer" ] }, "payerName": { "description": "Payer name", "type": "string", "example": "John Smith", "minLength": 1, "maxLength": 254 }, "payerEmail": { "description": "Payer email", "type": "string", "format": "email", "example": "john.smith@gmail.com", "maxLength": 254 }, "currency": { "description": "Currency code", "type": "string", "example": "GBP" }, "isReversible": { "description": "Determines if payment is refundable", "type": "boolean" }, "status": { "description": "The status of the payment", "example": "complete", "type": "string", "enum": [ "inProgress", "pending", "completed", "cancelled", "rejected", "abandoned", "error:paymentSubmission", "error:redirect", "error:tokenGrant" ] }, "providerStatus": { "description": "The status of the payment", "example": "AcceptedCancellationRequest", "type": "string" }, "reversedPaymentId": { "description": "The ID of the payment that was reversed by this payment", "type": "string", "example": "2bbca903-613d-42bc-a395-917568f7522a", "format": "uuid" }, "paymentSubmissionId": { "description": "Original payment submission id from financial institution", "type": "string", "example": "1429d113-5ba2-452a-bcc4-2eb1c84a3f98" }, "charges": { "description": "List of payment charges", "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "bearer": { "description": "Specifies which party/parties will bear the charges associated with the processing of the payment transaction.", "type": "string", "enum": [ "BorneByCreditor", "BorneByDebtor", "FollowingServiceLevel", "Shared" ] }, "type": { "description": "Charge type, in a coded form.", "type": "string", "enum": [ "CHAPSOut", "BalanceTransferOut", "MoneyTransferOut" ] }, "amount": { "description": "Charge amount in minor units of the currency, eg. pennies for GBP.", "type": "integer", "minimum": 1, "example": 1500 }, "currency": { "description": "Currency code", "type": "string", "example": "GBP" } } } }, "initiatedAt": { "description": "The date that the payment was initiated", "example": "2020-07-10T12:10:32.362Z", "format": "date-time", "type": "string" }, "finalisedAt": { "description": "The date that the payment was finalised", "example": "2020-07-10T12:10:34.594Z", "format": "date-time", "type": "string" }, "statusUpdateDateTime": { "description": "The date that the payment status was last updated", "example": "2020-07-10T12:10:34.594Z", "format": "date-time", "type": "string" }, "expectedSettlementDateTime": { "description": "The date that the settlement of the payment is expected", "example": "2020-07-10T12:10:41.344Z", "format": "date-time", "type": "string" }, "endToEndId": { "description": "Unique identifier relevant to the transaction - Allowed characters (a-zA-Z0-9 :-).", "type": "string", "example": "moneyhub-2023", "maxLength": 31 }, "payFileConsent": { "additionalProperties": false, "type": "object", "properties": { "id": { "description": "The id of the pay file consent", "example": "7d28eb6b4452cc5d2399b9c23925e97f", "type": "string" }, "fileHash": { "description": "Hash of the payment file", "example": "4fAAzIOm8UCbKVmouQpKU1UeszvYp2o4GCTfvw+aU1g=", "type": "string" }, "fileType": { "description": "Type of the payment file", "example": "json", "type": "string" }, "numberOfTransactions": { "description": "The number of transactions within the file", "example": "3", "type": "string" }, "controlSum": { "description": "The total amount of the transactions within the file", "example": 151.5, "type": "number" }, "fileReference": { "description": "Reference or name of the payment file", "example": "payment.json", "type": "string" } }, "required": [ "id", "fileHash", "fileType", "numberOfTransactions", "controlSum", "fileReference" ] } }, "required": [ "id", "payeeId", "payeeType", "payerRef", "initiatedAt", "status", "amount", "currency", "isReversible", "charges" ] }, "Error": { "additionalProperties": false, "properties": { "code": { "description": "The error code", "type": "string" }, "message": { "description": "The error message", "type": "string" }, "correlationId": { "description": "Id that identifies the request and can be used to ask for more details related to the error", "type": "string" } }, "required": [ "code" ], "type": "object" }, "Meta": { "additionalProperties": false, "properties": { "limit": { "type": "integer", "minimum": 0, "maximum": 1000 }, "offset": { "type": "integer", "minimum": 0, "maximum": 1000000000 }, "total": { "type": "integer", "minimum": 0 } }, "type": "object" } } } } ```