v1
latestOpenAPI 3.1.02026-07-24180245513.9 KBIncoming Payments
List incoming payments
List and filter incoming payments.
get/incoming_payments
Query parameters
limitinteger
starting_afterstring uuid
The ID of the object from which your list request will start. It is not included in the result.
sort_order'asc' | 'desc'
Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.
start_datestring date
The creation date of the incoming payment.
end_datestring date
The creation date of the incoming payment.
connected_account_idstring
The ID of the connected account used to receive the 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'
The type of payment.
Example:sepa
The type of the incoming payment.
direction'credit' | 'debit'
The direction of the incoming payment.
status'received' | 'returned' | 'pending_return' | 'pending_confirmation' | 'confirmed' | 'rejected'
The status of the incoming payment.
start_value_datestring date
The value date of the incoming payment.
end_value_datestring date
The value date of the incoming payment.
amount_frominteger
The amount of the incoming payment.
amount_tointeger
The amount of the incoming payment.
currencystring
The ISO 4217 currency code of the incoming payment.
mandate_referencestring
The reference of the direct debit mandate.
file_idstring uuid
The ID of the file including the incoming payment.
reconciliation_status'reconciled' | 'partially_reconciled' | 'unreconciled' | 'excluded'
The reconciliation status of the incoming payment.
aggregation_referencestring
The aggregation reference of the incoming payment.
direct_debit_mandate_idstring uuid
The ID of the incoming payment’s direct debit mandate.
internal_account_idstring uuid
The ID of the incoming payment’s receiving account.
uetrstring uuid
Unique End-to-end Transaction Reference (UETR). Can be used to track payments with Swift GPI.
settlement_method'cover' | 'instructed_agent' | 'instructing_agent'
The settlement method of the incoming payment.
Example:cover
cbs_data.transaction_idstring
The ID of the transaction (transaction_id) in CBS Data (cbs_data).
validation.type'internal_account_is_active' | 'direct_debit_mandate_is_active' | 'liquidity_screening' | 'sanctions_screening' | 'risk_screening' | 'limits_screening' | 'mambu_authorization'
The type of payment validation.
validation.status'queued' | 'in_progress' | 'successful' | 'failed' | 'pending_investigation' | 'pending_retry' | 'canceled' | 'technical_error'
The status of payment validation.
Response
200
Example response
{
"records": [
{
"status": "sent",
"object": "incoming_payment",
"idempotency_key": "8A2gcC",
"bank_data": {
"file_id": "a815e756-5576-4d40-9fbd-38ec304b856c",
"message_id": "1gXrtKMxLJ",
"transaction_id": "1zDrzOMxCJ",
"end_to_end_id": "c3b2d737bc"
},
"reconciliation_status": "partially_reconciled",
"initiated_at": "2024-04-12T14:23:45.123Z",
"reconciled_amount": 1500,
"type": "sepa",
"direction": "credit",
"amount": 3000,
"currency": "EUR",
"originating_account": {
"account_number": "FR7601234567891127967100082",
"bank_code": "BNPAFRPPXXX",
"fi_bank_code": "BNPAFRPPXXX",
"holder_name": "PartnerCo",
"holder_address": {
"building_number": "1",
"street_name": "rue de l'Abondance",
"postal_code": "69003",
"region_state": "Ile-de-France",
"city": "Lyon",
"country": "FR",
"department": "Marketing",
"sub_department": "Content team",
"building_name": "Bat. 4",
"floor": "3",
"postal_box": "67b",
"room": "47",
"city_location_name": "Confluences",
"district_name": "District 9"
},
"bank_name": "BankCo",
"bank_address": {
"line_1": "1, place de la Concorde",
"building_number": "1",
"street_name": "place de la Concorde",
"postal_code": "75008",
"city": "Paris",
"country": "FR",
"department": "Marketing",
"sub_department": "Content team",
"building_name": "Bat. 4",
"floor": "3",
"postal_box": "67b",
"room": "47",
"city_location_name": "Confluences",
"district_name": "District 9"
},
"creditor_identifier": "FR12ZZZ123456",
"organization_identification": {
"legal_entity_identifier": "529900T8BM49AURSDO55",
"business_identification_code": "SOGEFRPP",
"others": [
{
"value": "123456789123"
}
]
},
"private_identification": {
"birth_date": "1990-01-01",
"birth_city": "Paris",
"birth_country": "FR",
"other": {
"identification": "123456789",
"identification_type": "passport_number"
}
}
},
"receiving_account": {
"account_number": "FR7601234567891127967100082",
"bank_code": "BNPAFRPPXXX",
"fi_bank_code": "BNPAFRPPXXX",
"holder_name": "PartnerCo",
"holder_address": {
"building_number": "1",
"street_name": "rue de l'Abondance",
"postal_code": "69003",
"region_state": "Ile-de-France",
"city": "Lyon",
"country": "FR",
"department": "Marketing",
"sub_department": "Content team",
"building_name": "Bat. 4",
"floor": "3",
"postal_box": "67b",
"room": "47",
"city_location_name": "Confluences",
"district_name": "District 9"
},
"bank_name": "BankCo",
"bank_address": {
"line_1": "1, place de la Concorde",
"building_number": "1",
"street_name": "place de la Concorde",
"postal_code": "75008",
"city": "Paris",
"country": "FR",
"department": "Marketing",
"sub_department": "Content team",
"building_name": "Bat. 4",
"floor": "3",
"postal_box": "67b",
"room": "47",
"city_location_name": "Confluences",
"district_name": "District 9"
},
"organization_identification": {
"legal_entity_identifier": "529900T8BM49AURSDO55",
"business_identification_code": "SOGEFRPP",
"others": [
{
"value": "123456789123"
}
]
},
"private_identification": {
"birth_date": "1990-01-01",
"birth_city": "Paris",
"birth_country": "FR",
"other": {
"identification": "123456789",
"identification_type": "passport_number"
}
}
},
"ultimate_originator": {
"holder_name": "SoftwareCo",
"holder_address": {
"line_1": "1, place de la Concorde",
"building_number": "1",
"street_name": "place de la Concorde",
"postal_code": "75008",
"city": "Paris",
"country": "FR",
"department": "Marketing",
"sub_department": "Content team",
"building_name": "Bat. 4",
"floor": "3",
"postal_box": "67b",
"room": "47",
"city_location_name": "Confluences",
"district_name": "District 9"
},
"organization_identification": {
"legal_entity_identifier": "529900T8BM49AURSDO55",
"business_identification_code": "SOGEFRPP",
"others": [
{
"value": "123456789123"
}
]
},
"private_identification": {
"birth_date": "1990-01-01",
"birth_city": "Paris",
"birth_country": "FR",
"other": {
"identification": "123456789",
"identification_type": "passport_number"
}
}
},
"ultimate_receiver": {
"holder_name": "SoftwareCo",
"holder_address": {
"line_1": "1, place de la Concorde",
"building_number": "1",
"street_name": "place de la Concorde",
"postal_code": "75008",
"city": "Paris",
"country": "FR",
"department": "Marketing",
"sub_department": "Content team",
"building_name": "Bat. 4",
"floor": "3",
"postal_box": "67b",
"room": "47",
"city_location_name": "Confluences",
"district_name": "District 9"
},
"organization_identification": {
"legal_entity_identifier": "529900T8BM49AURSDO55",
"business_identification_code": "SOGEFRPP",
"others": [
{
"value": "123456789123"
}
]
},
"private_identification": {
"birth_date": "1990-01-01",
"birth_city": "Paris",
"birth_country": "FR",
"other": {
"identification": "123456789",
"identification_type": "passport_number"
}
}
},
"reference": "Invoice 1234",
"structured_reference": [
{
"creditor_reference_information": {
"type": {
"code": "dispatch_advice",
"issuer": "Issuer"
},
"reference": "RF18539007547034"
},
"referred_document_information": [
{
"type": {
"code": "commercial_invoice",
"issuer": "Issuer"
},
"number": "ABC-13679",
"related_date": "2024-03-15"
}
],
"invoicer": {
"name": "Invoicer name"
},
"invoicee": {
"name": "Invoicee name"
},
"additional_remittance_info": [
"Payment for invoice INV-2024-001"
]
}
],
"purpose": "SALA",
"category_purpose_code": "B2B",
"direct_debit_mandate": {
"reference": "REF-783232",
"sequence": "recurring",
"frequency": "recurring"
},
"direct_debit_sequence_type": "recurring",
"intermediary_agents": [
{
"financial_institution_identification": {
"swift_code": "SOMEBIC0XXX",
"bank_code": "SOMEBIC0XXX",
"bank_code_format": "bic",
"name": "Bank A",
"legal_entity_identifier": "219200WSGIIZEPF1P999",
"postal_address": {
"line_1": "1, place de la Concorde",
"building_number": "1",
"street_name": "place de la Concorde",
"postal_code": "75008",
"city": "Paris",
"country": "FR",
"department": "Marketing",
"sub_department": "Content team",
"building_name": "Bat. 4",
"floor": "3",
"postal_box": "67b",
"room": "47",
"city_location_name": "Confluences",
"district_name": "District 9"
},
"other": {
"identification": "35664632",
"custom_identification_type": "custom_type",
"identification_issuer": "HMRC"
}
},
"account_number": "GB7601234567890627967100010",
"account_number_format": "iban",
"organization_identification": {
"name": "Bank A",
"bank_code": "SOMEBIC0XXX",
"legal_entity_identifier": "219200WSGIIZEPF1P999",
"other": "35664632"
},
"postal_address": {
"line_1": "1, place de la Concorde",
"building_number": "1",
"street_name": "place de la Concorde",
"postal_code": "75008",
"city": "Paris",
"country": "FR",
"department": "Marketing",
"sub_department": "Content team",
"building_name": "Bat. 4",
"floor": "3",
"postal_box": "67b",
"room": "47",
"city_location_name": "Confluences",
"district_name": "District 9"
}
}
],
"previous_instructing_agents": [
{
"financial_institution_identification": {
"swift_code": "SOMEBIC0XXX",
"bank_code": "SOMEBIC0XXX",
"bank_code_format": "bic",
"name": "Bank A",
"legal_entity_identifier": "219200WSGIIZEPF1P999",
"postal_address": {
"line_1": "1, place de la Concorde",
"building_number": "1",
"street_name": "place de la Concorde",
"postal_code": "75008",
"city": "Paris",
"country": "FR",
"department": "Marketing",
"sub_department": "Content team",
"building_name": "Bat. 4",
"floor": "3",
"postal_box": "67b",
"room": "47",
"city_location_name": "Confluences",
"district_name": "District 9"
},
"other": {
"identification": "35664632",
"custom_identification_type": "custom_type",
"identification_issuer": "HMRC"
}
},
"account_number": "12345678",
"account_number_format": "iban",
"organization_identification": {
"name": "Bank A",
"bank_code": "SOMEBIC0XXX",
"legal_entity_identifier": "219200WSGIIZEPF1P999",
"other": "35664632"
},
"postal_address": {
"line_1": "1, place de la Concorde",
"building_number": "1",
"street_name": "place de la Concorde",
"postal_code": "75008",
"city": "Paris",
"country": "FR",
"department": "Marketing",
"sub_department": "Content team",
"building_name": "Bat. 4",
"floor": "3",
"postal_box": "67b",
"room": "47",
"city_location_name": "Confluences",
"district_name": "District 9"
}
}
],
"routing_instruction": "Cross-border routing instructions",
"payment_validation": {
"validation_results": [
{
"payment_validation_rule_id": "c2c303de-c0f0-4015-801d-6ae24f248092",
"validations": [
[
{
"status_details": "some details",
"resource_id": "b29b85ad-b2ef-4978-b27f-e44ae4914756",
"resource_url": "https://example.com/b29b85ad-b2ef-4978-b27f-e44ae4914756",
"last_updated_at": "2022-01-03T11:53:19.568Z",
"retry_details": {
"attempt_count": 1,
"max_attempts": 3,
"next_attempt_at": "2026-03-27T14:00:00Z",
"final_action": "reject_payment"
}
}
]
]
}
]
},
"cbs_data": {
"transaction_id": "c2c303de-c0f0-4015-801d-6ae24f248092",
"authorization_id": "62f87f47-86c6-4b1e-b49d-e6df91922cd7",
"transactions": [
{
"id": "c2c303de-c0f0-4015-801d-6ae24f248092",
"type": "withdrawal",
"context": "deposit",
"authorization_id": "62f87f47-86c6-4b1e-b49d-e6df91922cd7",
"channel": "cash",
"booked_at": "2022-01-03T11:53:19.568Z"
}
]
},
"settlement_method": "cover",
"fi_to_fi_option": "core",
"related_payment_id": "a815e756-5576-4d40-9fbd-38ec304b856c",
"metadata": {
"property_a": true,
"property_b": "false"
}
}
]
}