v1
latestOpenAPI 3.1.02026-07-24180245513.9 KBPayment Orders
List payment orders
List and filter payment orders.
get/payment_orders
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 payment order.
end_datestring date
The creation date of the payment order.
connected_account_idstring uuid
The ID of the connected account used to trigger the payment order.
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 payment order.
direction'credit' | 'debit'
The direction of the payment order.
status'pending_approval' | 'approved' | 'processing' | 'sent' | 'rejected' | 'canceled' | 'executed' | 'pending' | 'denied' | 'failed'
The status of the payment order.
start_value_datestring date
The value date of the payment order.
end_value_datestring date
The value date of the payment order.
amount_frominteger
The amount of the payment order.
amount_tointeger
The amount of the payment order.
currencystring
The ISO 4217 currency code of the payment order.
mandate_referencestring
The reference of the direct debit mandate.
reconciliation_status'reconciled' | 'partially_reconciled' | 'unreconciled' | 'excluded'
The reconciliation status of the payment order.
file_idstring uuid
The ID of the file including the payment order.
idempotency_keystring
The idempotency key of the payment order.
auto_approvalboolean
If true, only payment orders which were automatically approved will be fetched.
counterparty_idstring uuid
The ID of the counterparty of the payment order.
counterparty_account_idstring uuid
The ID of the counterparty account receiving the payment order.
account_holder_idstring uuid
The ID of the account holder receiving the payment order.
external_account_idstring uuid
The ID of the external account receiving the payment order.
aggregation_referencestring
The aggregation reference of the payment order.
direct_debit_mandate_idstring uuid
The ID of the payment order's direct debit mandate.
retry_details.original_payment_idstring uuid
The ID of the original payment order that led to the current object through a chain of retries.
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 payment order.
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": [
{
"id": "b69837bf-e784-4bd1-b0d0-2ad0e61a89b6",
"idempotency_key": "8A2gcC",
"object": "payment_order",
"type": "sepa",
"direction": "credit",
"amount": 2000,
"currency": "EUR",
"value_date": "2022-01-03",
"status": "executed",
"reconciled_amount": 2000,
"reconciliation_status": "reconciled",
"reference": "Invoice 1234",
"end_to_end_id": "c3b2d737bc",
"connected_account_id": "254e3100-afd6-44f2-8084-87e8ae67b554",
"originating_account": {
"account_number": "FR7601234567890627967100010",
"account_number_format": "iban",
"bank_code": "SOGEFRPP",
"bank_code_format": "bic",
"fi_bank_code": "SOGEFRPP",
"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"
},
"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"
}
}
},
"originating_account_id": "8d97ed83-a6f7-4929-8e90-01b2912fb6a7",
"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"
}
}
},
"receiving_account": {
"account_number": "FR7601234567891127967100082",
"account_number_format": "iban",
"bank_code": "BNPAFRPPXXX",
"bank_code_format": "bic",
"fi_bank_code": "BNPAFRPPXXX",
"holder_name": "PartnerCo",
"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"
},
"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"
}
}
},
"receiving_account_id": "b38f5318-a389-4278-9cbe-d16116750982",
"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"
}
}
},
"direct_debit_mandate": {
"reference": "regmedia-mandate-rz47ash4",
"signature_date": "2022-01-20",
"type": "sepa_core",
"sequence": "recurring",
"frequency": "recurring"
},
"direct_debit_mandate_id": "15ee5994-9019-478c-b27a-a4edfec17c58",
"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"
}
}
],
"swift_gpi": {
"confirmed_amount": 3000,
"confirmed_currency": "EUR",
"tracking_progress": [
{
"id": "01",
"status_details": "G005",
"bank_code": "SOMEBIC0XXX",
"fee_amount": 3000,
"fee_currency": "EUR"
}
]
},
"purpose": "SALA",
"category_purpose_code": "B2B",
"fee_option": "shared",
"routing_instruction": "Cross-border routing instructions",
"requested_execution_date": "2022-01-03",
"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"
}
]
},
"retry_details": {
"payment_retry_rule_id": "5075f0d2-6a6b-49ea-ae63-b11368873157",
"original_payment_id": "10384f4e-3eef-42a3-bc8d-8d2f35eb279d",
"retried_from_payment_id": "8e91531e-c29c-4e69-ab94-71e04f8d0b55",
"retried_to_payment_id": "58ebd65d-bc3c-4d91-816e-5a011702acbc",
"retry_scheduled_at": "2024-05-31T15:42:07.314159Z"
},
"treasury_option": "local",
"confidentiality_option": "payroll",
"settlement_method": "cover",
"settlement_information": {
"settlement_account": "FR7630006000011234567890189"
},
"fi_to_fi_option": "core",
"related_payment_id": "a815e756-5576-4d40-9fbd-38ec304b856c",
"metadata": {
"property_a": true,
"property_b": "false"
},
"bank_data": {
"file_id": "a815e756-5576-4d40-9fbd-38ec304b856c",
"message_id": "1gXrtKMxLJ",
"transaction_id": "1zDrzOMxCJ",
"end_to_end_id": "c3b2d737bc"
},
"initiated_at": "2022-01-03T11:53:19.568Z",
"instructed_agent": "SOMEBIC0XXX",
"addressee_bank_code": "SOMEBIC0XXX",
"created_at": "2022-01-03T11:53:19.734182Z"
}
]
}