--- title: "Get payment intents" method: GET path: "/payment_intents" tags: ["Payment intents"] --- # Get payment intents `GET /payment_intents` ## Request - Base URL: `https://api.sandbox.monite.com/v1` - URL: `https://api.sandbox.monite.com/v1/payment_intents` - Auth: HTTP bearer Returns a list of all [payment intents](https://docs.monite.com/payments/payment-intents). Monite creates payment intents automatically for each [payment link](https://docs.monite.com/payments/payment-links). Payment intents let you track the status of payments made via payment links. To find a payment intent for a specific payable or receivable invoice, provide the `object_id` parameter. Alternatively, you can use the `object_id__in` parameter to find payment intents for all invoices from the list. If no payment intents matching the search criteria were found, the response contains an empty `data` array. ## Query parameters - `order` 'asc' | 'desc' - `limit` integer - `pagination_token` string - `sort` 'id' | 'created_at' - `object_id` string, uuid - `object_id__in` string, uuid ## Headers - `x-monite-version` string, required - `x-monite-entity-id` string, required ## Response `200` Successful Response - PaymentIntentsListResponse - `data` PaymentIntentResponse[], required: A list of payment intents. - `id` string, uuid, required: A unique ID of this payment intent. - `updated_at` string, date-time, required: UTC date and time when this payment intent was last updated. - `amount` integer, required: The payment amount in [minor units](https://docs.monite.com/references/currencies#minor-units). - `application_fee_amount` integer - `batch_payment_id` string, uuid: Reserved for internal use. - `currency` string, required: The payment currency, as a three-letter ISO [currency code](https://docs.monite.com/references/currencies). - `invoice` Invoice - `due_date` string, date: The invoice due date (`yyyy-mm-dd`) to be displayed on the payment page. - `file` InvoiceFile - `mimetype` string, required - `name` string, required - `url` string, uri, required - `issue_date` string, date: The invoice issue date (`yyyy-mm-dd`) to be displayed on the payment page. - `object` PaymentObject - `id` string, uuid, required - `type` 'payable' | 'receivable', required - `payer` PayerAccountResponse - `id` string, uuid, required: ID of the entity or counterpart. - `bank_accounts` BankAccount[]: List of bank accounts - `id` string, uuid, required: The ID of the bank account. - `account_holder_name` string: The name of the person or business that owns this bank account. - `account_number` string: The bank account number. Typically used for UK and US bank accounts. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits. - `bic` string: The BIC/SWIFT code of the bank. - `country` 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'IC' | 'CV' | 'KY' | 'CF' | 'EA' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'SS' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'BL' | 'BQ' | 'CW' | 'MF' | 'SX' - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'SVC' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' - `display_name` string: User-defined name of this bank account, such as 'Primary account' or 'Savings account'. Used only for entity bank accounts. - `iban` string: The IBAN of the bank account. - `is_default` boolean: Indicates whether this bank account is the default one for its currency. - `name` string: User-defined name of this bank account, such as 'Primary account' or 'Savings account'. Used only for counterpart bank accounts. - `routing_number` string: The bank's routing transit number (RTN). Typically used for US banks. US routing numbers consist of 9 digits. - `sort_code` string: The bank's sort code. Typically used for UK banks. - `was_created_by_user_id` string, uuid: ID of the entity user who added this bank account, or `null` if it was added using a partner access token. Used only for entity bank accounts. - `name` string: The name of the specified entity or counterpart. For individuals, the name is formatted as `first_name last_name`. - `type` 'entity' | 'counterpart', required - `payment_link_id` string, uuid: ID of the [payment link](https://docs.monite.com/payments/payment-links) associated with this payment intent. The payment link object contains the URL of the payment page. - `payment_methods` MoniteAllPaymentMethodsTypes[], required - `payment_reference` string: The payment reference. If not provided explicitly by the client, Monite uses the invoice number (`document_id`) as the payment reference. **Note:** Monite [normalizes](https://docs.monite.com/payments/payment-references) payment references for certain types of payments when passing information to the payment processing provider. - `provider` string: Reserved for internal use. - `recipient` RecipientAccountResponse, required - `id` string, uuid, required: ID of the entity or counterpart that is the recipient of the payment. - `bank_accounts` BankAccount[]: The bank account where the payment will be transferred. This array always contains one account. **Note:** If the payment recipient is the entity, payout is made to the entity's [default bank account](https://docs.monite.com/entities/bank-accounts#default) rather than the account returned by this field. - `id` string, uuid, required: The ID of the bank account. - `account_holder_name` string: The name of the person or business that owns this bank account. - `account_number` string: The bank account number. Typically used for UK and US bank accounts. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits. - `bic` string: The BIC/SWIFT code of the bank. - `country` 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'IC' | 'CV' | 'KY' | 'CF' | 'EA' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'SS' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'BL' | 'BQ' | 'CW' | 'MF' | 'SX' - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'SVC' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' - `display_name` string: User-defined name of this bank account, such as 'Primary account' or 'Savings account'. Used only for entity bank accounts. - `iban` string: The IBAN of the bank account. - `is_default` boolean: Indicates whether this bank account is the default one for its currency. - `name` string: User-defined name of this bank account, such as 'Primary account' or 'Savings account'. Used only for counterpart bank accounts. - `routing_number` string: The bank's routing transit number (RTN). Typically used for US banks. US routing numbers consist of 9 digits. - `sort_code` string: The bank's sort code. Typically used for UK banks. - `was_created_by_user_id` string, uuid: ID of the entity user who added this bank account, or `null` if it was added using a partner access token. Used only for entity bank accounts. - `name` string: The name of the specified entity or counterpart. For individuals, the name is formatted as `first_name last_name`. - `type` 'entity' | 'counterpart', required - `selected_payment_method` 'sepa_credit' | 'us_ach' | 'blik' | 'card' | 'bacs_direct_debit' | 'bancontact' | 'eps' | 'giropay' | 'ideal' | 'p24' | 'sepa_debit' | 'sofort' | 'applepay' | 'googlepay' | 'affirm' | 'klarna' - `status` string, required: The [status](https://docs.monite.com/payments/payment-intents#lifecycle) of the payment intent. - `next_pagination_token` string: A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). - `prev_pagination_token` string: A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). ## Other responses - `400`: Possible reasons: * Missing `X-Monite-Version` request header. * An entity with the specified ID was not found. - `401`: The `Authorization` header is missing or contains an invalid or expired access token. See [Authentication](https://docs.monite.com/api/concepts/authentication) to learn how to authenticate API calls. - `422`: Possible reasons: * `X-Monite-Entity-Id` is missing or not a valid UUID. * `payment_intent_id` is not a valid UUID. - `429`: API rate limit has been exceeded. Check the response headers for the rate limit information. --- [API](https://skmtc.dev/monite/apis/monite-2.md) - [All operations](https://skmtc.dev/monite/apis/monite-2/llms.txt) - [OpenAPI document](https://skmtc.dev/monite/apis/monite-2/revisions/4299ccf95edb?raw)