--- title: "Search payments" method: POST path: "/v0/organizations/{organization-id}/payments/search" tags: ["Payments"] --- # Search payments `POST /v0/organizations/{organization-id}/payments/search` Returns a list of payments which reference or scheme ID match the `search-query` supplied in the request. ## Path parameters - `organization-id` string, required ## Query parameters - `include` string[] ## Request body - object - `search-query` string, required ## Response `200` OK - object - `search-results` object[], required - `creditor` union - object - `account-url` union, required — Link to the bank account resource. - string - string - `creditor-type` 'griffin-bank-account', required - object — Creditor specified with bank details - `iban` string — An International Bank Account Number. - `uk-domestic-sort-code` string — A UK sort code. - `bic` string — A BIC. - `account-number` string — A UK account number. - `account-holder` string — The name of the [account holder](/docs/terms/account-holder). - `bank-id-code` 'gbdsc' - `bank-id` string — A UK sort code. - `creditor-type` 'uk-domestic', required - `bban` string — A country-specific Basic Bank Account Number. - `account-url` union — Link to the bank account resource. - string - string - `uk-domestic-account-number` string — A UK account number. - `other-account-identification` string — Uncategorised account identification - `account-number-code` 'bban' - `other-institution-identification` string — Uncategorised financial institution identification - `rejected-at` string, date-time — ISO 8601 formatted date-time. - `latest-submission-url` string — Most recent submission (if any made) - `rejected-by-url` string — Link to the user. - `payment-direction` 'inbound-payment' | 'outbound-payment', required — Whether the payment is moving money into or out of the account. - `created-by-url` string — Link to the user. - `created-via` 'api' | 'ui' - `created-at` string, date-time, required — ISO 8601 formatted date-time. - `payment-url` string, required — Link to the payment resource. - `payment-reference` string — Free-text field to help identify and categorise payments. - `payment-amount` object, required — Compound value representing both the currency and amount of money being sent. - `currency` 'GBP', required - `value` string, required — The value as a decimal-formatted string - `payment-type` 'credit-transfer' | 'direct-debit', required — Whether the payment is a credit transfer or direct debit. - `ultimate-debtor` object - `iban` string — An International Bank Account Number. - `uk-domestic-sort-code` string — A UK sort code. - `bic` string — A BIC. - `account-number` string — A UK account number. - `account-holder` string — The name of the [account holder](/docs/terms/account-holder). - `bank-id-code` 'gbdsc' - `bank-id` string — A UK sort code. - `bban` string — A country-specific Basic Bank Account Number. - `account-url` union — Link to the bank account resource. - string - string - `uk-domestic-account-number` string — A UK account number. - `other-account-identification` string — Uncategorised account identification - `account-number-code` 'bban' - `other-institution-identification` string — Uncategorised financial institution identification - `payment-admissions-url` string — Link to the endpoint for listing payment admissions. - `payment-submissions-url` string — Link to the endpoint for creating and listing payment submissions. - `debtor` object - `iban` string — An International Bank Account Number. - `uk-domestic-sort-code` string — A UK sort code. - `bic` string — A BIC. - `account-number` string — A UK account number. - `account-holder` string — The name of the [account holder](/docs/terms/account-holder). - `bank-id-code` 'gbdsc' - `bank-id` string — A UK sort code. - `bban` string — A country-specific Basic Bank Account Number. - `account-url` union — Link to the bank account resource. - string - string - `uk-domestic-account-number` string — A UK account number. - `other-account-identification` string — Uncategorised account identification - `account-number-code` 'bban' - `other-institution-identification` string — Uncategorised financial institution identification - `rejection-reason` string, nullable - `mandate-url` union — Link to a direct debit mandate. - string - string - `meta` object, required - `page` object - `total` integer — Total number of items. Present when the total number of items in the full result set is less than 10,000. - `estimated-total` object - `at-least` 10000 — Present when the total number of items in the full result set exceeds 10,000. This indicates that the actual number of items is at least 10,000, but the exact total is not provided due to performance considerations. - `included` object — Present only when the request uses the `include` parameter. - `accounts` object[] - `account-submissions-url` union, required — Link to the [payment submissions](#tag/Payments) debiting from this account. - string - string - `bank-account-product-url` union — Link to the [bank account](#tag/Bank-accounts) product. - string - string - `account-restricted` boolean, required — Specifies whether the bank account has restrictions applied by Griffin. - `account-payments-url` union, required — Link to the [payments](#tag/Payments) associated with this account. - string - string - `pooled-account-memberships-url` union — Link to the list of [pool members](#tag/Pooled-account-membership) associated with this account. - string - string - `account-admissions-url` union, required — Link to the [payment admissions](#tag/Payments) crediting to this account. - string - string - `bank-product-type` 'savings-account' | 'client-money-account' | 'safeguarding-account' | 'embedded-account' | 'operational-account', required — Specifies the type of bank account. (For more detail on bank account types, see our guide for [types of bank accounts](/docs/guides/types-of-bank-accounts). - `account-mandates-url` union — Link to the direct debit mandates associated with this account. - string - string - `display-name` string, required — A human readable label for an entity - `controller-url` string, required — Link to the [legal person](#tag/Legal-persons) that represents the [controller](/docs/terms/controller) of the account. - `pooled-funds` boolean, required — Specifies whether the bank account holds funds belonging to multiple beneficiaries. - `accrued-interest` object, required — Shows the [accrued interest](/docs/terms/accrued-interest). - `currency` 'GBP', required - `value` string, required — The value as a decimal-formatted string - `account-status` 'closing' | 'open' | 'closed' | 'opening', required — Shows the status of the account. An account can be moved between statuses during its lifecycle. The status value affects the operations that you can perform. An account must be `"open"` to be fully operational. - `client-money-type` 'designated-client-fund' | 'designated-client-money' | 'general-client-money' — Specifies the type of client money account. - `owner-url` union, required — Link to the [legal person](#tag/Legal-persons) that represents the [owner](/docs/terms/owner) of the account. - string - string - `closed-at` string, date-time — ISO 8601 formatted date-time. - `created-at` string, date-time, required — ISO 8601 formatted date-time. - `opened-at` string, date-time — ISO 8601 formatted date-time. - `close-account-url` union — Link to the endpoint that enables account closure for this account. - string - string - `available-balance` object, required — Shows the [available balance](/docs/terms/available-balance). - `currency` 'GBP', required - `value` string, required — The value as a decimal-formatted string - `pooled-account-membership-updates-url` union — Link to manage [pooled account membership](#tag/Pooled-account-membership) - string - string - `bank-account-restrictions-url` union — Link to the [restrictions](#tag/Bank-account-restrictions) on this account. - string - string - `bank-addresses` object[] — Shows a collection of public addresses which uniquely identify the account. Any one of these can be used to pay into the account. - `account-holder` string, required — The name of the [account holder](/docs/terms/account-holder). - `bank-id-code` 'gbdsc', required - `bank-id` string, required — A UK sort code. - `account-number` string, required — A UK account number. - `account-number-code` 'bban', required - `account-transactions-url` union, required — Link to the [transactions](#tag/Transactions) associated with this account. - string - string - `account-url` union, required — Link to the bank account resource. - string - string - `bank-account-events-url` union — Link to the events for this bank account. - string - string - `beneficiary-url` union — Link to the [legal person](#tag/Legal-persons) that represents the [beneficiary](/docs/terms/beneficiary) of the account. - string - string - `primary-account` boolean, required — Specifies whether the bank account is the organization's [primary account](/docs/guides/primary-account). - `account-balance` object, required — Shows the [account balance](/docs/terms/account-balance). - `currency` 'GBP', required - `value` string, required — The value as a decimal-formatted string - `savings-type` 'easy-access' | 'bare-trust' — Specifies the type of savings account. - `submissions` object[] - `submission-scheme-information` union, required - object - `end-to-end-identification` string, required — An identifier for a payment, assigned by the originator, passed along unchanged throughout the entire end-to-end chain. Not necessarily unique. - `scheme-status-code` string — A scheme-specific code describing the current status. - `scheme-status-code-description` string — A human-readable description of the scheme status code. - `payment-scheme` 'fps', required - object - `end-to-end-identification` string, required — An identifier for a payment, assigned by the originator, passed along unchanged throughout the entire end-to-end chain. Not necessarily unique. - `payment-scheme` 'book-transfer', required - `submission-status` 'scheduled' | 'failed' | 'processing' | 'returned' | 'delivered', required — Specifies the progress of the outbound payment. - `created-by-url` string — Link to the user. - `scheduled-at` string, date-time — ISO 8601 formatted date-time. - `created-at` string, date-time, required — ISO 8601 formatted date-time. - `submission-status-reason` string - `payment-url` string, required — Link to the payment resource. - `unique-scheme-identifier` string - `account-url` union, required — Link to the bank account resource. - string - string - `submission-url` string, required - `users` object[] - `user-email` string, required — The user's email address. - `user-url` string, required — Link to the user. - `user-username` string, required — The username. - `api-keys-url` union, required — Link to the user's [api keys](#tag/API-keys). - string - string - `user-memberships-url` union, required — Link to the user's [memberships](#tag/Memberships). - string - string - `given-name` string - `surname` string ## Other responses - `401` — Requires an API key to continue - `404` — Not Found --- [API](https://skmtc.net/griffin/apis/the-griffin-api.md) · [All operations](https://skmtc.net/griffin/apis/the-griffin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/griffin/the-griffin-api/revisions/178ed43d543b/schema)