--- title: "Confirm incoming payment" method: POST path: "/incoming_payments/{id}/confirm" tags: ["Incoming Payments"] --- # Confirm incoming payment `POST /incoming_payments/{id}/confirm` Confirm an incoming payment in status `pending_confirmation`. This is only relevant for incoming payments with `type` = `sepa_instant`. Confirming an incoming payment updates its status to `confirmed`. ## Path parameters - `id` string, required ## Response `200` 200 - IncomingPaymentDetails - `id` string, uuid, required — The UUID of the incoming payment. - `status` string, required — The lifecycle stage of this incoming payment. It will be updated as the incoming payment is processed. - `status_details` string, required — The details of the status of this incoming payment. - `object` string, required — Type of the object, `incoming_payment`. - `idempotency_key` string, required — An idempotency key is a unique value sent by the client, which the server uses to recognize subsequent retries of the same request. - `bank_data` object, required — Bank data, such as message and transaction IDs, in JSON format. - `file_id` string, uuid, required - `message_id` string, required - `transaction_id` string, required - `end_to_end_id` string, required - `reconciliation_status` 'partially_reconciled' | 'reconciled' | 'unreconciled' | 'excluded', required — The reconciliation status of the incoming payment, which is either `unreconciled`, `reconciled`, `partially_reconciled`, or `excluded`. - `initiated_at` string, date-time, required — The payment order initiation UTC timestamp with ISO 8601 format to the milliseconds without trailing zeros. Only supported for `sepa_instant` payments. - `reconciled_amount` integer, required — The reconciled amount. - `created_at` string, date-time, required — The UTC timestamp of the creation of this incoming payment. - `type` 'ae_aani' | 'ae_uaefts' | 'ae_uaefts_rtgs' | 'ar_coelsa' | 'ar_mep' | 'ar_transfer_30' | 'au_becs' | 'au_npp' | 'au_rits' | 'bacs' | 'becs' | 'bh_benefit' | 'bh_fawri' | 'bh_rtgs' | 'br_pix' | 'br_str' | 'br_ted' | 'ca_eft' | 'ca_lynx' | 'ca_rtr' | 'cbs_transfer' | 'ch_sct' | 'ch_sic' | 'ch_sip' | 'chaps' | 'cl_cca' | 'cl_lbtr' | 'cl_tef' | 'co_ach' | 'co_bre_b' | 'co_cud' | 'fps' | 'icelandic_exp' | 'id_bifast' | 'id_birtgs' | 'id_sknbi' | 'internal_transfer' | 'ke_eft' | 'ke_pesalink' | 'ke_rtgs' | 'mx_spei' | 'my_duitnow' | 'my_ibg' | 'my_rentas' | 'no_nbo' | 'no_nics' | 'no_nics_instant' | 'osko' | 'ph_instapay' | 'ph_pddts' | 'ph_philpass' | 'pl_elixir' | 'pl_express_elixir' | 'pl_sorbnet' | 'rits' | 'ro_regis' | 'ro_sent' | 'ro_sent_instant' | 'sa_sarie' | 'sa_sarie_instant' | 'sa_sarie_rtgs' | 'se_bankgirot' | 'se_rix' | 'se_rix_instant' | 'sepa' | 'sepa_instant' | 'sepa_urgent' | 'sg_giro' | 'sg_meps' | 'sg_paynow' | 'swift' | 'swift_fi_to_fi' | 'target2' | 'target2_fi_to_fi' | 'th_bahtnet' | 'th_nitmx' | 'th_promptpay' | 'tl_ips' | 'tl_rtimor_ach' | 'tl_rtimor_rtgs' | 'treasury' | 'us_ach' | 'us_fednow' | 'us_rtp' | 'us_wire' | 'za_eft' | 'za_rpp' | 'za_samos', required — The type of payment. - `direction` 'credit', required — Either credit or debit. Describes the direction the money is flowing. A credit moves money from someone else's account to your account. A debit moves money from your account to someone else's account. An incoming payment of type:sepa and direction:credit is a SEPA Credit Transfer (SCT). An incoming payment of type:sepa and direction:debit is a SEPA Direct Debit (SDD). Only credit is supported for now. - `amount` integer, required — The absolute amount of a payment, in the specified currency's smallest units. For euro payments, the smallest unit is cents. €20 is represented as `2000`. - `currency` 'EUR', required — The three-letter ISO 4217 currency code, in lowercase. Only `EUR` is supported for now. - `connected_account_id` string, uuid, required — The ID of the connected account that receives the incoming payment. - `originating_account` IncomingPaymentOriginatingAccount, required — The account from which the payment originates. This field is available only to financial institution customers and specific authorized 4th-party payments. For corporate customers, the originating account is automatically derived from the connected account information and must be left empty. - `account_number` string — The account number, for example an IBAN. Always present only for incoming payments types other than `swift_fi_to_fi` or `target2_fi_to_fi`. - `bank_code` string, required — The bank code. For example, a BIC or SWIFT code. - `fi_bank_code` string — The `fi_bank_code` attribute is only set for incoming payments where type = `swift_fi_to_fi` or `target2_fi_to_fi`. - `holder_name` string, required — The name of the legal entity or individual holding the account. - `holder_address` IncomingPaymentAddress — The address of the account holder. - `line_1` string — Line 1. - `line_2` string — Line 2. - `building_number` string — Building number. - `street_name` string — Street name. - `postal_code` string — Postal / zip code. - `region_state` string — Region or state. - `city` string — City. - `country` string — ISO 3166 alpha-2 country code. - `department` string, nullable — Department name or code. - `sub_department` string, nullable — Sub-department name. - `building_name` string, nullable — Name of the building. - `floor` string, nullable — Floor number or identifier. - `postal_box` string, nullable — Postal box. - `room` string, nullable — Room number. - `city_location_name` string, nullable — Specific city location or landmark. - `district_name` string, nullable — District name or administrative region. - `bank_name` string — The name of the bank holding the account. - `bank_address` CommonAddress — The address of the account holder, as an address object. - `line_1` string — Line 1. - `line_2` string — Line 2. - `building_number` string — Building number. - `street_name` string — Street name. - `postal_code` string — Postal / zip code. - `region_state` string — Region or state. - `city` string — City. - `country` string — ISO 3166 alpha-2 country code. - `department` string, nullable — Department name or code. - `sub_department` string, nullable — Sub-department name. - `building_name` string, nullable — Name of the building. - `floor` string, nullable — Floor number or identifier. - `postal_box` string, nullable — Postal box. - `room` string, nullable — Room number. - `city_location_name` string, nullable — Specific city location or landmark. - `district_name` string, nullable — District name or administrative region. - `creditor_identifier` string, required — The unique reference for organisations collecting payments by SEPA Direct Debit. - `organization_identification` OrganizationIdentification - `legal_entity_identifier` string — Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". - `business_identification_code` string — Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)". - `default_other_identifier_type` 'bank_identification' | 'central_bank_identification' | 'clearing_house_identification' | 'company_incorporation_number' | 'company_identification' | 'customer_number' | 'duns_number' | 'employee_number' | 'global_location_number' | 'siren' | 'siret' | 'tax_number' | 'telephone_number' | 'business_domain_identification' | 'other_identification' | 'unknown' — Note: set type to unknown if the type of the value is not in the list provided or unknown. - `others` object[] - `type` 'bank_identification' | 'central_bank_identification' | 'clearing_house_identification' | 'company_incorporation_number' | 'company_identification' | 'customer_number' | 'duns_number' | 'employee_number' | 'global_location_number' | 'siren' | 'siret' | 'tax_number' | 'telephone_number' | 'business_domain_identification' | 'other_identification' | 'unknown', required — Note: set type to unknown if the type of the value is not in the list provided or unknown. - `value` string, required — Allowed value format depends on the type - `private_identification` PrivateIdentification - `birth_date` string, date — The person’s birth date. - `birth_city` string — The person’s birth city. - `birth_country` string — The person's birth country as an ISO 3166 alpha-2 country code. - `other` object - `identification` string — The person’s identification, such as its passport ID, national ID, driving license ID, etc. - `identification_type` 'alien_registration_number' | 'passport_number' | 'customer_identification_number' | 'drivers_license_number' | 'employee_identification_number' | 'national_identity_number' | 'social_security_number' | 'telephone_number' | 'tax_identification_number' | 'person_commercial_identification' - `custom_identification_type` string — The person’s custom identification type, if no pre-defined identification has been filled in identification_type. - `identification_issuer` string — The identification issuing authority. - `receiving_account` IncomingPaymentReceivingAccount, required — The receiving account of the payment. - `account_number` string — The account number, for example an IBAN. Always present only for incoming payments types other than `swift_fi_to_fi` or `target2_fi_to_fi`. - `bank_code` string, required — The bank code. For example, a BIC or SWIFT code. - `fi_bank_code` string — The `fi_bank_code` attribute is only set for incoming payments where type = `swift_fi_to_fi` or `target2_fi_to_fi`. - `holder_name` string, required — The name of the legal entity or individual holding the account. - `holder_address` IncomingPaymentAddress — The address of the account holder. - `line_1` string — Line 1. - `line_2` string — Line 2. - `building_number` string — Building number. - `street_name` string — Street name. - `postal_code` string — Postal / zip code. - `region_state` string — Region or state. - `city` string — City. - `country` string — ISO 3166 alpha-2 country code. - `department` string, nullable — Department name or code. - `sub_department` string, nullable — Sub-department name. - `building_name` string, nullable — Name of the building. - `floor` string, nullable — Floor number or identifier. - `postal_box` string, nullable — Postal box. - `room` string, nullable — Room number. - `city_location_name` string, nullable — Specific city location or landmark. - `district_name` string, nullable — District name or administrative region. - `bank_name` string — The name of the bank holding the account. - `bank_address` CommonAddress — The address of the account holder, as an address object. - `line_1` string — Line 1. - `line_2` string — Line 2. - `building_number` string — Building number. - `street_name` string — Street name. - `postal_code` string — Postal / zip code. - `region_state` string — Region or state. - `city` string — City. - `country` string — ISO 3166 alpha-2 country code. - `department` string, nullable — Department name or code. - `sub_department` string, nullable — Sub-department name. - `building_name` string, nullable — Name of the building. - `floor` string, nullable — Floor number or identifier. - `postal_box` string, nullable — Postal box. - `room` string, nullable — Room number. - `city_location_name` string, nullable — Specific city location or landmark. - `district_name` string, nullable — District name or administrative region. - `organization_identification` OrganizationIdentification - `legal_entity_identifier` string — Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". - `business_identification_code` string — Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)". - `default_other_identifier_type` 'bank_identification' | 'central_bank_identification' | 'clearing_house_identification' | 'company_incorporation_number' | 'company_identification' | 'customer_number' | 'duns_number' | 'employee_number' | 'global_location_number' | 'siren' | 'siret' | 'tax_number' | 'telephone_number' | 'business_domain_identification' | 'other_identification' | 'unknown' — Note: set type to unknown if the type of the value is not in the list provided or unknown. - `others` object[] - `type` 'bank_identification' | 'central_bank_identification' | 'clearing_house_identification' | 'company_incorporation_number' | 'company_identification' | 'customer_number' | 'duns_number' | 'employee_number' | 'global_location_number' | 'siren' | 'siret' | 'tax_number' | 'telephone_number' | 'business_domain_identification' | 'other_identification' | 'unknown', required — Note: set type to unknown if the type of the value is not in the list provided or unknown. - `value` string, required — Allowed value format depends on the type - `private_identification` PrivateIdentification - `birth_date` string, date — The person’s birth date. - `birth_city` string — The person’s birth city. - `birth_country` string — The person's birth country as an ISO 3166 alpha-2 country code. - `other` object - `identification` string — The person’s identification, such as its passport ID, national ID, driving license ID, etc. - `identification_type` 'alien_registration_number' | 'passport_number' | 'customer_identification_number' | 'drivers_license_number' | 'employee_identification_number' | 'national_identity_number' | 'social_security_number' | 'telephone_number' | 'tax_identification_number' | 'person_commercial_identification' - `custom_identification_type` string — The person’s custom identification type, if no pre-defined identification has been filled in identification_type. - `identification_issuer` string — The identification issuing authority. - `ultimate_originator` IncomingPaymentUltimateOriginator — The ultimate originating account of the payment (sometimes called ultimate debtor for a credit transfer or ultimate creditor for a direct debit). - `holder_name` string — The account holder name of the ultimate originator. - `holder_address` CommonAddress — The address of the account holder, as an address object. - `line_1` string — Line 1. - `line_2` string — Line 2. - `building_number` string — Building number. - `street_name` string — Street name. - `postal_code` string — Postal / zip code. - `region_state` string — Region or state. - `city` string — City. - `country` string — ISO 3166 alpha-2 country code. - `department` string, nullable — Department name or code. - `sub_department` string, nullable — Sub-department name. - `building_name` string, nullable — Name of the building. - `floor` string, nullable — Floor number or identifier. - `postal_box` string, nullable — Postal box. - `room` string, nullable — Room number. - `city_location_name` string, nullable — Specific city location or landmark. - `district_name` string, nullable — District name or administrative region. - `organization_identification` OrganizationIdentification - `legal_entity_identifier` string — Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". - `business_identification_code` string — Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)". - `default_other_identifier_type` 'bank_identification' | 'central_bank_identification' | 'clearing_house_identification' | 'company_incorporation_number' | 'company_identification' | 'customer_number' | 'duns_number' | 'employee_number' | 'global_location_number' | 'siren' | 'siret' | 'tax_number' | 'telephone_number' | 'business_domain_identification' | 'other_identification' | 'unknown' — Note: set type to unknown if the type of the value is not in the list provided or unknown. - `others` object[] - `type` 'bank_identification' | 'central_bank_identification' | 'clearing_house_identification' | 'company_incorporation_number' | 'company_identification' | 'customer_number' | 'duns_number' | 'employee_number' | 'global_location_number' | 'siren' | 'siret' | 'tax_number' | 'telephone_number' | 'business_domain_identification' | 'other_identification' | 'unknown', required — Note: set type to unknown if the type of the value is not in the list provided or unknown. - `value` string, required — Allowed value format depends on the type - `private_identification` PrivateIdentification - `birth_date` string, date — The person’s birth date. - `birth_city` string — The person’s birth city. - `birth_country` string — The person's birth country as an ISO 3166 alpha-2 country code. - `other` object - `identification` string — The person’s identification, such as its passport ID, national ID, driving license ID, etc. - `identification_type` 'alien_registration_number' | 'passport_number' | 'customer_identification_number' | 'drivers_license_number' | 'employee_identification_number' | 'national_identity_number' | 'social_security_number' | 'telephone_number' | 'tax_identification_number' | 'person_commercial_identification' - `custom_identification_type` string — The person’s custom identification type, if no pre-defined identification has been filled in identification_type. - `identification_issuer` string — The identification issuing authority. - `ultimate_receiver` IncomingPaymentUltimateReceiver — The ultimate receiving account of the payment (sometimes called ultimate creditor for a credit transfer or ultimate debtor for a direct debit). - `holder_name` string — The account holder name of the ultimate receiver. - `holder_address` CommonAddress — The address of the account holder, as an address object. - `line_1` string — Line 1. - `line_2` string — Line 2. - `building_number` string — Building number. - `street_name` string — Street name. - `postal_code` string — Postal / zip code. - `region_state` string — Region or state. - `city` string — City. - `country` string — ISO 3166 alpha-2 country code. - `department` string, nullable — Department name or code. - `sub_department` string, nullable — Sub-department name. - `building_name` string, nullable — Name of the building. - `floor` string, nullable — Floor number or identifier. - `postal_box` string, nullable — Postal box. - `room` string, nullable — Room number. - `city_location_name` string, nullable — Specific city location or landmark. - `district_name` string, nullable — District name or administrative region. - `organization_identification` OrganizationIdentification - `legal_entity_identifier` string — Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". - `business_identification_code` string — Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)". - `default_other_identifier_type` 'bank_identification' | 'central_bank_identification' | 'clearing_house_identification' | 'company_incorporation_number' | 'company_identification' | 'customer_number' | 'duns_number' | 'employee_number' | 'global_location_number' | 'siren' | 'siret' | 'tax_number' | 'telephone_number' | 'business_domain_identification' | 'other_identification' | 'unknown' — Note: set type to unknown if the type of the value is not in the list provided or unknown. - `others` object[] - `type` 'bank_identification' | 'central_bank_identification' | 'clearing_house_identification' | 'company_incorporation_number' | 'company_identification' | 'customer_number' | 'duns_number' | 'employee_number' | 'global_location_number' | 'siren' | 'siret' | 'tax_number' | 'telephone_number' | 'business_domain_identification' | 'other_identification' | 'unknown', required — Note: set type to unknown if the type of the value is not in the list provided or unknown. - `value` string, required — Allowed value format depends on the type - `private_identification` PrivateIdentification - `birth_date` string, date — The person’s birth date. - `birth_city` string — The person’s birth city. - `birth_country` string — The person's birth country as an ISO 3166 alpha-2 country code. - `other` object - `identification` string — The person’s identification, such as its passport ID, national ID, driving license ID, etc. - `identification_type` 'alien_registration_number' | 'passport_number' | 'customer_identification_number' | 'drivers_license_number' | 'employee_identification_number' | 'national_identity_number' | 'social_security_number' | 'telephone_number' | 'tax_identification_number' | 'person_commercial_identification' - `custom_identification_type` string — The person’s custom identification type, if no pre-defined identification has been filled in identification_type. - `identification_issuer` string — The identification issuing authority. - `receiving_account_id` string, uuid, required — The ID of the internal account that receives the incoming payment. - `reference` string, required — The reference that will appear on the origin and destination account statements, with a maximum of 140 characters. - `structured_reference` object[] — Structured reference data - `creditor_reference_information` IncomingPaymentCreditorReferenceInformation — Reference information provided by the creditor to allow the identification of the underlying documents. - `type` IncomingPaymentCreditorReferenceType — Specifies the type of creditor reference. - `code` 'dispatch_advice' | 'foreign_exchange_deal_reference' | 'purchase_order' | 'related_payment_instruction' | 'remittance_advice_message' | 'structured_communication_reference' | 'other' — Type of creditor reference. - `issuer` string — Entity that assigns the credit reference type. - `reference` string — Unique and unambiguous identification of the referred document. - `referred_document_information` IncomingPaymentReferredDocumentInformation[] - `type` IncomingPaymentReferredDocumentType — Specifies the type of referred document. - `code` 'commercial_invoice' | 'credit_note_related_to_financial_adjustment' | 'contract' | 'credit_note' | 'debit_note' | 'dispatch_advice' | 'debit_note_related_to_financial_adjustment' | 'hire_invoice' | 'invoice_signed' | 'metered_service_invoice' | 'proforma_invoice' | 'purchase_order' | 'quotation' | 'self_billed_invoice' | 'seller_presentment' | 'time_sheet' | 'usage_report' | 'account_receivable_open_item' | 'bill_of_lading' | 'commercial_contract' | 'statement_of_account' | 'trade_services_utility_transaction' | 'voucher' | 'other' — Type of referred document. - `issuer` string — Identification of the issuer of the reference document type. - `number` string — Unique and unambiguous identification of the referred document. - `related_date` string, date — Date associated with the referred document. - `invoicer` object — Identification of the organisation issuing the invoice. - `name` string — Name by which a party is known and which is usually used to identify that party. - `invoicee` object — Identification of the party to whom an invoice is issued. - `name` string — Name by which a party is known and which is usually used to identify that party. - `additional_remittance_info` string[] — Additional information, in free text form, to complement the structured remittance information. - `value_date` string, date, required — The value date of the incoming payment. - `requested_execution_date` string, date, required — The requested execution date of the incoming payment. - `purpose` string — The purpose code of the incoming payment, ensuring compliance with regulatory requirements of certain beneficiary countries. Only applicable to `swift` and `chaps` payment types. - `category_purpose_code` string — The category purpose of the incoming payment. Recommended for CHAPS payments. - `uetr` string, uuid — Unique End-to-end Transaction Reference (UETR). Can be used to track payments with Swift GPI. - `direct_debit_mandate` object, nullable, required — The mandate authorizing the direct debit. - `reference` string, required — The unique code that is assigned to a mandate. The mandate reference is displayed in the destination account statements when a direct debit is debited. - `signature_date` string, date, required — The signature date of the mandate. - `last_debit_collection_date` string, date, nullable — The date of the last direct debit collection processed against this mandate. - `expiry_date` string, date, nullable — The date after which the mandate is expired and cannot be used for subsequent direct debit collections. - `type` 'sepa_core' | 'sepa_b2b' | 'bacs_debit', required — The type of the mandate. - `sequence` 'one_off' | 'recurring' — Deprecated, use `frequency` instead. - `frequency` 'one_off' | 'recurring' — The frequency of the mandate, either `one_off` or `recurring`. Mandatory when type is `sepa_core` or `sepa_b2b`. - `direct_debit_mandate_id` string, uuid, required — The ID of the incoming payment’s direct debit mandate. - `direct_debit_sequence_type` 'first' | 'recurring' | 'final' | 'one_off', nullable, required — Identifies the direct debit sequence, such as first, recurrent, final or one-off. This field is optional and should only be used when `direct_debit_mandate` or `direct_debit_mandate_id` is provided. - `intermediary_agents` object[] — Intermediary financial institution agents via which the payment should be processed. Only applicable to `swift`, `swift_fi_to_fi`, and `chaps` payments. - `financial_institution_identification` CommonAgentFinancialInstitutionIdentification, required — ISO 20022 financial institution identification of the agent. - `swift_code` string — SWIFT BIC of the agent used as the network identifier (e.g. for SWIFT gpi routing). - `bank_code` string — Domestic or scheme-specific bank code of the agent (e.g. BIC for SEPA/Target2, sort code for CHAPS). - `bank_code_format` 'bic' | 'uk_sorting_code' | 'us_aba_routing_number' | 'tokenized' | 'other' — Format of `bank_code` (e.g. `bic`, `other`). - `name` string — Name of the agent's financial institution. - `legal_entity_identifier` string — Legal entity identifier (LEI) of the agent. - `postal_address` CommonAddress — The address of the account holder, as an address object. - `line_1` string — Line 1. - `line_2` string — Line 2. - `building_number` string — Building number. - `street_name` string — Street name. - `postal_code` string — Postal / zip code. - `region_state` string — Region or state. - `city` string — City. - `country` string — ISO 3166 alpha-2 country code. - `department` string, nullable — Department name or code. - `sub_department` string, nullable — Sub-department name. - `building_name` string, nullable — Name of the building. - `floor` string, nullable — Floor number or identifier. - `postal_box` string, nullable — Postal box. - `room` string, nullable — Room number. - `city_location_name` string, nullable — Specific city location or landmark. - `district_name` string, nullable — District name or administrative region. - `other` CommonAgentOtherIdentification - `identification` string — Identification value. - `identification_type` 'bank_identification' | 'central_bank_identification' | 'clearing_house_identification' | 'company_incorporation_number' | 'company_identification' | 'customer_number' | 'duns_number' | 'employee_number' | 'global_location_number' | 'siren' | 'siret' | 'tax_number' | 'telephone_number' | 'business_domain_identification' | 'other_identification' | 'unknown' — Note: set type to unknown if the type of the value is not in the list provided or unknown. - `custom_identification_type` string — Proprietary identification type, used when `identification_type` does not cover the use case. - `identification_issuer` string — Entity that issued the identification. - `account_number` string — Account number held at the intermediary agent. - `account_number_format` string — Format of `account_number` (e.g. `iban`, `bban`). - `organization_identification` object - `name` string — Name of the intermediary agent. - `bank_code` string — Bank code of the intermediary agent. - `legal_entity_identifier` string — Legal entity identifier (LEI) of the intermediary agent. - `other` string — Other identification of the intermediary agent. - `postal_address` CommonAddress — The address of the account holder, as an address object. - `line_1` string — Line 1. - `line_2` string — Line 2. - `building_number` string — Building number. - `street_name` string — Street name. - `postal_code` string — Postal / zip code. - `region_state` string — Region or state. - `city` string — City. - `country` string — ISO 3166 alpha-2 country code. - `department` string, nullable — Department name or code. - `sub_department` string, nullable — Sub-department name. - `building_name` string, nullable — Name of the building. - `floor` string, nullable — Floor number or identifier. - `postal_box` string, nullable — Postal box. - `room` string, nullable — Room number. - `city_location_name` string, nullable — Specific city location or landmark. - `district_name` string, nullable — District name or administrative region. - `previous_instructing_agents` object[] — Applicable to `swift`, `swift_fi_to_fi`, `chaps`, and `target2_fi_to_fi` payments. - `financial_institution_identification` CommonAgentFinancialInstitutionIdentification, required — ISO 20022 financial institution identification of the agent. - `swift_code` string — SWIFT BIC of the agent used as the network identifier (e.g. for SWIFT gpi routing). - `bank_code` string — Domestic or scheme-specific bank code of the agent (e.g. BIC for SEPA/Target2, sort code for CHAPS). - `bank_code_format` 'bic' | 'uk_sorting_code' | 'us_aba_routing_number' | 'tokenized' | 'other' — Format of `bank_code` (e.g. `bic`, `other`). - `name` string — Name of the agent's financial institution. - `legal_entity_identifier` string — Legal entity identifier (LEI) of the agent. - `postal_address` CommonAddress — The address of the account holder, as an address object. - `line_1` string — Line 1. - `line_2` string — Line 2. - `building_number` string — Building number. - `street_name` string — Street name. - `postal_code` string — Postal / zip code. - `region_state` string — Region or state. - `city` string — City. - `country` string — ISO 3166 alpha-2 country code. - `department` string, nullable — Department name or code. - `sub_department` string, nullable — Sub-department name. - `building_name` string, nullable — Name of the building. - `floor` string, nullable — Floor number or identifier. - `postal_box` string, nullable — Postal box. - `room` string, nullable — Room number. - `city_location_name` string, nullable — Specific city location or landmark. - `district_name` string, nullable — District name or administrative region. - `other` CommonAgentOtherIdentification - `identification` string — Identification value. - `identification_type` 'bank_identification' | 'central_bank_identification' | 'clearing_house_identification' | 'company_incorporation_number' | 'company_identification' | 'customer_number' | 'duns_number' | 'employee_number' | 'global_location_number' | 'siren' | 'siret' | 'tax_number' | 'telephone_number' | 'business_domain_identification' | 'other_identification' | 'unknown' — Note: set type to unknown if the type of the value is not in the list provided or unknown. - `custom_identification_type` string — Proprietary identification type, used when `identification_type` does not cover the use case. - `identification_issuer` string — Entity that issued the identification. - `account_number` string — Account number held at the previous instructing agent. - `account_number_format` string — Format of `account_number` (e.g. `iban`, `bban`). - `organization_identification` object - `name` string — Name of the previous instructing agent. - `bank_code` string — Bank code of the previous instructing agent. - `legal_entity_identifier` string — Legal entity identifier (LEI) of the previous instructing agent. - `other` string — Other identification of the previous instructing agent. - `postal_address` CommonAddress — The address of the account holder, as an address object. - `line_1` string — Line 1. - `line_2` string — Line 2. - `building_number` string — Building number. - `street_name` string — Street name. - `postal_code` string — Postal / zip code. - `region_state` string — Region or state. - `city` string — City. - `country` string — ISO 3166 alpha-2 country code. - `department` string, nullable — Department name or code. - `sub_department` string, nullable — Sub-department name. - `building_name` string, nullable — Name of the building. - `floor` string, nullable — Floor number or identifier. - `postal_box` string, nullable — Postal box. - `room` string, nullable — Room number. - `city_location_name` string, nullable — Specific city location or landmark. - `district_name` string, nullable — District name or administrative region. - `routing_instruction` string — Specific instructions intended for the next financial institution in the payment chain to ensure proper processing of the transaction. Only applicable to `swift` payments. - `payment_validation` object — Information about the payment validation, like the validation rules and validation statuses. `null` if no payment validation rule is attached to the incoming payment. - `status` 'in_progress' | 'successful' | 'failed', required — The aggregated status of payment validation for this payment. - `validation_results` CommonPaymentValidationResult[], required — Array of objects detailing the results of payment validation for a given payment validation rule. If the incoming payment has 2 rules attached, then this array will contain 2 objects. - `payment_validation_rule_id` string, uuid, required — The ID of the payment validation rule. - `status` 'in_progress' | 'successful' | 'failed', required — The aggregated status of the payment validation contained in this rule. - `validations` array[], required — Array of array of objects detailing the result of one given payment validation. - object[] - `type` 'internal_account_is_active' | 'direct_debit_mandate_is_active' | 'liquidity_screening' | 'sanctions_screening' | 'risk_screening' | 'limits_screening' | 'mambu_authorization', required — The type of the payment validation. - `status` 'queued' | 'in_progress' | 'successful' | 'failed' | 'canceled' | 'pending_investigation' | 'pending_retry' | 'technical_error', required — The status of the payment validation. - `status_details` string — Details about the status. - `resource_id` string — ID of the resource used to perform the payment validation. - `resource_url` string — URL of the resource used to perform the payment validation. - `mode` 'pre_built' | 'custom' — The mode of the payment validation. - `last_updated_at` string, date-time — The UTC timestamp of the last updated time of the payment validation. - `retry_details` object, nullable — Tracks the retry context of an individual validation. Exposed only when: - `status` is `pending_retry` (a retry is scheduled), OR - `status` is `failed` after retries have been exhausted (in which case `final_action` was just executed). In every other state this field is `null`. No event is emitted while the validation sits in `pending_retry`; events fire only on transitions in and out of that state. - `attempt_count` integer — Number of attempts completed so far, including the initial. - `max_attempts` integer — Configured maximum number of attempts (from `retry_policy.max_attempts`). - `next_attempt_at` string, date-time, nullable — UTC timestamp of the next scheduled retry. `null` once retries have been exhausted. - `final_action` 'approve_payment' | 'cancel_payment' | 'confirm_payment' | 'reject_payment' | 'set_payment_to_received' | 'set_payment_to_pending_confirmation' | 'suspend_payment' — Action that will be (or has been) executed once retries are exhausted. Mirrors the outcome's `action` field from the matching `payment_validation_rule`. - `cbs_data` CommonCbsData - `transaction_id` string, uuid — The ID of the transaction booked in the core banking system. - `authorization_id` string — The ID of the authorization hold acquired in the core banking system. - `transactions` CommonCbsTransaction[] — List of all transactions on core banking system for the payment. - `id` string, uuid — The ID of the transaction booked in the core banking system. - `type` 'deposit' | 'withdrawal' | 'disbursement' | 'repayment' | 'adjustment' — Type of the transaction. - `context` 'deposit' | 'suspense' | 'disbursement' | 'repayment' — Context of the transaction. - `payment_validation_type` 'internal_account_is_active' | 'direct_debit_mandate_is_active' | 'liquidity_screening' | 'sanctions_screening' | 'risk_screening' | 'limits_screening' | 'mambu_authorization' — The type of the payment validation associated with transaction (key value in `suspense` context). - `account_id` string — Account ID on the core banking system used for the transaction. - `authorization_id` string — The ID of the authorization hold acquired in the core banking system. - `external_id` string — External ID used on the transaction. - `channel` string — Channel on the core banking system used for the transaction. - `booked_at` string, date-time — The UTC timestamp that the transaction has been booked on the core banking system. - `instructing_agent` string — When applicable, the instructing agent, or financial institution having sent the incoming payment. - `instructed_agent` string — When applicable, the instructed agent, or financial institution having received the incoming payment. - `settlement_method` string — When applicable, the settlement method of the incoming payment, whether `instructing_agent`, `instructed_agent`, or `cover`. - `instructing_settlement_agent` string — The instructing settlement agent. Only applicable to swift payments. - `instructed_settlement_agent` string — The instructed settlement agent. Only applicable to swift payments. - `fee_option` string — Network payment fee preference. Only applicable to Swift payments such as `originator` (fee beared by the originating party), `receiver` (fee beared by the receiving party), or `shared` (fee split between the originating and the receiving parties). - `fi_to_fi_option` 'advi' | 'core' | 'cover' — Filled for incoming payments with type = `swift_fi_to_fi` or `target2_fi_to_fi`. - `related_payment_id` string, uuid — Auto-filled for incoming payments with type = `swift_fi_to_fi` or `target2_fi_to_fi` and fi_to_fi_option = `cover`. If no related payment can be found by our system `related_payment_id`, and consequently `related_payment_type`, will be empty. In this case `related_payment` will contain data about the related payment. - `related_payment_type` string — The type of the related payment. Only filled when `related_payment_id` could be determined by our system. - `related_payment` object — See `related_payment_id` for details about when this property is present. If it's present, it will have the same properties as it's encompassing object (incoming payment). - `metadata` object, required — Additional client data in JSON format. See [Metadata](https://docs.numeral.io/reference/metadata). ## Other responses - `404` — The specified resource was not found. - `409` — Conflict. --- [API](https://skmtc.net/numeral/apis/payments.md) · [All operations](https://skmtc.net/numeral/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/numeral/payments/versions/220f101cc2ef/schema)