{"openapi":"3.1.0","info":{"title":"Reconciliations","description":"Automate payments across banks with a single API","version":"1","contact":{"name":"API Support","email":"dev@numeral.io"}},"tags":[{"name":"Expected Payments","description":"Expected payments endpoints"},{"name":"Payment Captures","description":"Payment captures endpoints"},{"name":"Reconciliations","description":"Reconciliations endpoints"}],"servers":[{"url":"https://sandbox.numeral.io/v1"}],"components":{"securitySchemes":{"sec0":{"type":"apiKey","in":"header","name":"x-api-key"}},"parameters":{"expected_payment.id":{"name":"id","in":"path","description":"The ID of the expected payment.","schema":{"type":"string","format":"uuid"},"required":true},"list.common_parameters.sort_order":{"name":"sort_order","in":"query","description":"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`.\n","schema":{"type":"string","enum":["asc","desc"]}},"payment_capture.id":{"name":"id","in":"path","description":"The ID of the payment capture.","schema":{"type":"string","format":"uuid"},"required":true}},"schemas":{"error":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"reason":{"type":"string"}}}},"correlation_id":{"type":"string"}}},"common.metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some label"}},"common.custom_fields":{"type":"object","description":"Custom fields in JSON `key:value` format. See [Custom fields](ref:custom-fields)."},"common.virtual_account":{"type":"object","required":["virtual_account_number"],"properties":{"virtual_account_number":{"type":"string","description":"The virtual account number."},"name":{"type":"string","maxLength":100,"description":"The name of the virtual account."}}},"common.cbs_data":{"type":"object","properties":{"transaction_id":{"type":"string","format":"uuid","description":"The ID of the transaction booked in the core banking system.","example":"c2c303de-c0f0-4015-801d-6ae24f248092","deprecated":true},"authorization_id":{"type":"string","description":"The ID of the authorization hold acquired in the core banking system.","example":"62f87f47-86c6-4b1e-b49d-e6df91922cd7","deprecated":true},"transactions":{"type":"array","description":"List of all transactions on core banking system for the payment.","items":{"$ref":"#/components/schemas/common.cbs_transaction"}}}},"common.cbs_transaction":{"type":"object","description":"Core banking system transaction properties","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the transaction booked in the core banking system.","example":"c2c303de-c0f0-4015-801d-6ae24f248092"},"type":{"type":"string","description":"Type of the transaction.","enum":["deposit","withdrawal","disbursement","repayment","adjustment"],"example":"withdrawal"},"context":{"type":"string","description":"Context of the transaction.","enum":["deposit","suspense","disbursement","repayment"],"example":"deposit"},"payment_validation_type":{"type":"string","description":"The type of the payment validation associated with transaction (key value in `suspense` context).","enum":["internal_account_is_active","direct_debit_mandate_is_active","liquidity_screening","sanctions_screening","risk_screening","limits_screening","mambu_authorization"]},"account_id":{"type":"string","description":"Account ID on the core banking system used for the transaction."},"authorization_id":{"type":"string","description":"The ID of the authorization hold acquired in the core banking system.","example":"62f87f47-86c6-4b1e-b49d-e6df91922cd7"},"external_id":{"type":"string","description":"External ID used on the transaction."},"channel":{"type":"string","description":"Channel on the core banking system used for the transaction.","example":"cash"},"booked_at":{"type":"string","format":"date-time","example":"2022-01-03T11:53:19.568Z","description":"The UTC timestamp that the transaction has been booked on the core banking system."}}},"expected_payment.counterparty_account":{"type":"object","properties":{"account_number":{"type":"string","description":"The account number of the counterparty.","example":"FR7601234567890627967100010"},"holder_name":{"type":"string","description":"The name of the counterparty.","example":"PartnerCo"}},"description":"The account of the counterparty, which is either the debtor or the creditor depending on the payment's direction. It must be left empty if `counterparty_account_id` parameter is filled."},"expected_payment.external_account":{"type":"object","properties":{"account_number":{"type":"string","description":"The number of the external account.","example":"FR7601234567890627967100010"},"holder_name":{"type":"string","description":"The name of the external account holder.","example":"PartnerCo"}},"description":"The external account, which is either the debtor or the creditor depending on the payment's direction. It must be left empty if `external_account_id` parameter is filled."},"expected_payment.internal_account":{"type":"object","properties":{"account_number":{"type":"string","description":"The number of the internal account.","example":"FR8414508000704858926265I89"},"name":{"type":"string","description":"The name of the internal account.","example":"Expenses account"},"type":{"type":"string","description":"The type of the internal account.","example":"virtual"}},"description":"The internal account, type 'virtual', that the payment is expected to credit or debit. It must be left empty if `internal_account_id` parameter is filled."},"expected_payment.creation_details.virtual_account":{"type":"object","description":"The virtual account that the payment is expected to credit or debit. It must be left empty if `virtual_account_id` parameter is filled.","required":["virtual_account_number"],"properties":{"virtual_account_number":{"type":"string","description":"The virtual account number."},"name":{"type":"string","maxLength":100,"description":"The name of the virtual account."}}},"expected_payment.creation_details.internal_account":{"type":"object","description":"The internal account of type `virtual` that the payment is expected to credit or debit. It must be left empty if `internal_account_id` parameter is filled.","required":["account_number"],"properties":{"account_number":{"type":"string","description":"The account number of the internal account."}}},"expected_payment.details":{"type":"object","required":["id","object","direction","amount_from","amount_to","currency","counterparty_account","virtual_account","reconciliation_status","reconciled_amount","metadata","custom_fields","descriptions","created_at","canceled_at"],"properties":{"id":{"type":"string","format":"uuid","example":"2086dfa8-2640-43ff-9144-e73bab721832"},"idempotency_key":{"type":"string","description":"An idempotency key is a unique value sent by the client, which the server uses to recognize subsequent retries of the same request.","example":"8A2gcC"},"object":{"type":"string","enum":["expected_payment"],"example":"expected_payment"},"direction":{"type":"string","enum":["credit","debit"],"example":"credit"},"amount_from":{"type":"integer","minimum":0,"default":0,"example":2000},"amount_to":{"type":"integer","minimum":0,"default":0,"example":3000},"currency":{"type":"string","example":"EUR"},"start_date":{"type":"string","format":"date","example":"2022-01-05"},"end_date":{"type":"string","format":"date","example":"2022-01-05"},"connected_account_id":{"type":"string","format":"uuid","example":"254e3100-afd6-44f2-8084-87e8ae67b554"},"counterparty_account_id":{"type":"string","format":"uuid","description":"The UUID of the counterparty account.","deprecated":true},"counterparty_account":{"$ref":"#/components/schemas/expected_payment.counterparty_account","deprecated":true},"virtual_account_id":{"type":"string","format":"uuid","description":"The UUID of the virtual account.","deprecated":true},"virtual_account":{"$ref":"#/components/schemas/common.virtual_account","deprecated":true},"external_account_id":{"type":"string","format":"uuid","description":"The UUID of the external account."},"external_account":{"$ref":"#/components/schemas/expected_payment.external_account"},"internal_account_id":{"type":"string","format":"uuid","description":"The UUID of the internal virtual account that the payment is expected to credit or debit."},"internal_account":{"$ref":"#/components/schemas/expected_payment.internal_account"},"reconciliation_status":{"type":"string","enum":["unreconciled","partially_reconciled","reconciled","excluded"],"example":"reconciled"},"reconciled_amount":{"type":"integer","minimum":0,"default":0,"example":2000},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some label"}},"custom_fields":{"$ref":"#/components/schemas/common.custom_fields"},"descriptions":{"type":"array","description":"Descriptions of the expected payment","items":{"type":"string","description":"A description of the expected payment"}},"virtual_account_number":{"type":"string","example":"FR4217569000705838477329D20"},"created_at":{"type":"string","format":"date-time","example":"2022-01-03T11:53:19.734182Z"},"canceled_at":{"type":["string","null"],"format":"date-time","example":"2022-01-03T15:12:20.644356Z"}}},"expected_payment.creation_details":{"type":"object","required":["direction","amount_from","amount_to","currency","start_date","end_date","connected_account_id"],"properties":{"direction":{"type":"string","description":"The direction of the expected payment. Direction is `credit` when one expects to receive money and `debit` when one expects to send money.","default":"credit","enum":["debit","credit"],"example":"credit"},"amount_from":{"type":"integer","minimum":0,"description":"The lowest amount to be expected for the payment, in the specified currency's smallest unit. For euro payments, the smallest unit is cents. €20 is represented as `2000`.","example":2500},"amount_to":{"type":"integer","minimum":0,"description":"The highest amount to be expected for the payment, in the specified currency's smallest unit. For euro payments, the smallest unit is cents. €20 is represented as `2000`.","example":2700},"currency":{"type":"string","description":"The ISO 4217 currency code of the expected payment.","example":"EUR"},"start_date":{"type":"string","format":"date","description":"The earliest date the payment is expected.","example":"2022-09-29"},"end_date":{"type":"string","format":"date","description":"The latest date the payment is expected.","example":"2022-10-02"},"counterparty_account_id":{"type":"string","format":"uuid","description":"The ID of the `counterparty_account`. It must be left empty if `counterparty_account` parameter is filled.","example":"b38f5318-a389-4278-9cbe-d16116750982","deprecated":true},"external_account_id":{"type":"string","format":"uuid","description":"The ID of the `external_account`. It must be left empty if `external_account` parameter is filled.","example":"24e3157c-4942-11ed-b878-0242ac120002"},"counterparty_account":{"$ref":"#/components/schemas/expected_payment.counterparty_account","deprecated":true},"external_account":{"$ref":"#/components/schemas/expected_payment.external_account"},"virtual_account_id":{"type":"string","format":"uuid","description":"The ID of the `virtual_account`. It must be left empty if `virtual_account` parameter is filled.","deprecated":true},"internal_account_id":{"type":"string","format":"uuid","description":"The ID of the internal virtual account that the payment is expected to credit or debit. It must be left empty if `internal_account` parameter is filled."},"virtual_account":{"$ref":"#/components/schemas/expected_payment.creation_details.virtual_account","deprecated":true},"internal_account":{"$ref":"#/components/schemas/expected_payment.creation_details.internal_account"},"connected_account_id":{"type":"string","format":"uuid","description":"The ID of the connected account.","example":"24e3157c-4942-11ed-b878-0242ac120002"},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some label"}},"custom_fields":{"$ref":"#/components/schemas/common.custom_fields"},"descriptions":{"type":"array","description":"Descriptions of the expected payment","items":{"type":"string","description":"A description of the expected payment"}}}},"expected_payment.update_details":{"type":"object","properties":{"amount_from":{"type":"integer","minimum":0,"default":0,"example":2000},"amount_to":{"type":"integer","minimum":0,"default":0,"example":3000},"start_date":{"type":"string","format":"date","example":"2022-01-05"},"end_date":{"type":"string","format":"date","example":"2022-01-05"},"counterparty_account":{"$ref":"#/components/schemas/expected_payment.counterparty_account","deprecated":true},"external_account":{"$ref":"#/components/schemas/expected_payment.external_account"},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some label"}},"custom_fields":{"$ref":"#/components/schemas/common.custom_fields"},"descriptions":{"type":"array","description":"Descriptions of the expected payment","items":{"type":"string","description":"A description of the expected payment"}},"virtual_account_number":{"type":"string","example":"FR4217569000705838477329D20","deprecated":true},"internal_account_number":{"type":"string","example":"FR4217569000705838477329D20"}}},"payment_capture.details":{"type":"object","required":["id","object","connected_account_id","amount","currency","type","authorization_id","payment_reference","date","value_date","network","remittance_reference","remittance_date","fee_amount","fee_currency","net_amount","net_currency","reconciled_amount","reconciliation_status","source","metadata","canceled_at","created_at"],"properties":{"id":{"type":"string","format":"uuid","description":"The UUID of the payment capture."},"idempotency_key":{"type":"string","description":"An idempotency key is a unique value sent by the client, which the server uses to recognize subsequent retries of the same request.","example":"8A2gcC"},"object":{"type":"string","enum":["payment_capture"],"example":"payment_capture","description":"Label used to identify this kind of object."},"connected_account_id":{"type":"string","format":"uuid","description":"The ID of the connected account."},"transaction_reference":{"type":"string","description":"The transaction reference of the payment capture."},"amount":{"type":"integer","format":"int64","example":500,"description":"The absolute amount of the payment capture, in the specified currency's smallest units. For euro payments, the smallest unit is cents. €20 is represented as `2000`."},"original_payment_amount":{"type":"integer","format":"int64","example":500,"description":"The original amount of the payment capture, in the specified currency's smallest units. For euro payments, the smallest unit is cents. €20 is represented as `2000`."},"currency":{"type":"string","description":"The ISO 4217 currency code of the payment capture.","example":"EUR"},"type":{"type":"string","description":"The type of the payment capture.","enum":["charge","chargeback","refund"]},"authorization_id":{"type":"string","description":"The authorization ID of the payment capture."},"payment_reference":{"type":"string","description":"The payment reference of the payment capture (e.g. archiving reference)."},"date":{"type":"string","format":"date","example":"2022-01-03","description":"The date of the payment capture."},"value_date":{"type":"string","format":"date","example":"2022-01-03","description":"The value date of the payment capture."},"network":{"type":"string","enum":["visa","mastercard","cb","american_express"],"description":"The network of the payment capture."},"remittance_reference":{"type":"string","description":"The remittance reference of the payment capture."},"remittance_date":{"type":"string","format":"date","example":"2022-01-03","description":"The remittance date of the payment capture."},"fee_amount":{"type":"integer","format":"uint","example":500,"description":"The fee amount of the payment capture."},"fee_currency":{"type":"string","description":"The ISO 4217 fee currency code of the payment capture.","example":"EUR"},"net_amount":{"type":"integer","format":"uint","example":500,"description":"The net amount of the payment capture."},"net_currency":{"type":"string","description":"The ISO 4217 net currency code of the payment capture.","example":"EUR"},"reconciled_amount":{"type":"integer","minimum":0,"default":0,"example":2000,"description":"The reconciled amount."},"reconciliation_status":{"type":"string","enum":["unreconciled","partially_reconciled","reconciled","excluded"],"description":"The reconciliation status of the payment order, which is either `unreconciled`, `reconciled`, `partially_reconciled`, or `excluded`."},"source":{"type":"string","enum":["api","reporting_file"],"description":"The source of the payment capture."},"merchant_id":{"type":"string","description":"The merchant ID of the payment capture."},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some label"}},"canceled_at":{"type":["string","null"],"format":"date-time","description":"The UTC timestamp of the cancelation of the payment capture."},"created_at":{"type":"string","format":"date-time","description":"The UTC timestamp of the creation of the payment capture."},"cbs_data":{"$ref":"#/components/schemas/common.cbs_data"}}},"payment_capture.creation_details":{"type":"object","required":["connected_account_id","amount","currency","type","payment_reference","date"],"properties":{"connected_account_id":{"type":"string","format":"uuid","description":"The ID of the connected account."},"transaction_reference":{"type":"string","description":"The transaction reference of the payment capture."},"amount":{"type":"integer","format":"int64","example":500,"description":"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":{"type":"string","description":"The ISO 4217 currency code of the payment capture.","example":"EUR"},"type":{"type":"string","description":"The type of the payment capture.","enum":["charge","chargeback","refund"]},"authorization_id":{"type":"string","description":"The authorization ID of the payment capture."},"payment_reference":{"type":"string","description":"The payment reference of the payment capture (e.g. archiving reference)."},"date":{"type":"string","format":"date","example":"2022-01-03","description":"The date of the payment capture."},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some label"}},"lending":{"type":"object","description":"Lending details to associate with the payment capture. Provide either `credit_arrangement_id` or `loan_ids`, not both.","properties":{"credit_arrangement_id":{"type":"string","format":"uuid","description":"The ID of the credit arrangement to associate with this payment capture. Mutually exclusive with `loan_ids`."},"loan_ids":{"type":"array","description":"The IDs of the loans to associate with this payment capture. Accepts at most one ID. Mutually exclusive with `credit_arrangement_id`.","maxItems":1,"items":{"type":"string","format":"uuid"}}}}}}},"responses":{"errors.400.validation":{"description":"Validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"errors.404.not_found":{"description":"The specified resource was not found."},"errors.409.conflict":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"errors.415.unsupported_media_type":{"description":"Unsupported Media Type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"security":[{"sec0":[]}],"paths":{"/reconciliations":{"post":{"summary":"Create reconciliation","description":"Create a reconciliation by matching a transaction with a payment.","operationId":"create-reconciliation","tags":["Reconciliations"],"parameters":[{"name":"Idempotency-Key","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"At least one of `transaction_id` or `payment_id` must be provided. Providing both reconciles the transaction with the payment. Providing only one (on an `unreconciled` object) excludes that object from reconciliation (`reconciliation_status` = `excluded`).\n","properties":{"transaction_id":{"type":"string","description":"The ID of the transaction to be reconciled. If empty and the payment is unreconciled (`reconciliation_status` = `unreconciled`), will exclude the payment from reconciliation (`reconciliation_status` = `excluded`).\n","example":"288ea7c0-4944-76ab-c658-0756ab150043"},"payment_id":{"type":"string","description":"The ID of the `payment_order`, `incoming_payment`, `return`, `expected_payment` or `payment_capture` to be reconciled. If empty and the transaction is unreconciled (`reconciliation_status` = `unreconciled`), will exclude the transaction from reconciliation (`reconciliation_status` = `excluded`).\n","example":"15b88a94-4944-11ed-b878-0242ac120002"},"amount":{"type":"integer","description":"The amount of the reconciliation, in the related payment and transaction currency’s smallest unit. For euro, the smallest unit is cents. €20 is represented as `2000`. If unspecified, the system will try to create a reconciliation with the maximum amount possible. It must be left empty if `payment_id` is empty.\n","format":"int32","example":3000},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some label"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"id":"7d399984-b435-4a63-ab11-4a4185c13cba","amount":500,"match_type":"manual","object":"reconciliation","metadata":{},"transaction_id":"8a0e3912-59c7-4b86-980f-d1ab4b8786e2","payment_id":"fb9ec63e-7b32-47ef-9326-fe214ebeadb7","payment_type":"expected_payment","canceled_at":null,"created_at":"2022-05-09T12:17:07.48448Z"}}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"7d399984-b435-4a63-ab11-4a4185c13cba"},"amount":{"type":"integer","example":500,"default":0},"match_type":{"type":"string","example":"manual"},"object":{"type":"string","example":"reconciliation"},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some label"}},"transaction_id":{"type":"string","example":"8a0e3912-59c7-4b86-980f-d1ab4b8786e2"},"payment_id":{"type":"string","example":"fb9ec63e-7b32-47ef-9326-fe214ebeadb7"},"payment_type":{"type":"string","example":"expected_payment"},"canceled_at":{},"created_at":{"type":"string","example":"2022-05-09T12:17:07.48448Z"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":{"error":"validation_error","message":"validation errors occurred while processing request","details":[{"field":"amount","reason":"amount of the reconciliation exceeds expected payment's unreconciled amount_to"}]}}},"schema":{"type":"object","properties":{"error":{"type":"string","example":"validation_error"},"message":{"type":"string","example":"validation errors occurred while processing request"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","example":"amount"},"reason":{"type":"string","example":"amount of the reconciliation exceeds expected payment's unreconciled amount_to"}}}}}}}}},"415":{"$ref":"#/components/responses/errors.415.unsupported_media_type"}}},"get":{"summary":"List reconciliations","description":"List and filter reconciliations.","operationId":"list-reconciliations","tags":["Reconciliations"],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":25}},{"name":"starting_after","in":"query","description":"The ID of the object from which your list request will start. It is not included in the result.","schema":{"type":"string"}},{"$ref":"#/components/parameters/list.common_parameters.sort_order"},{"name":"transaction_id","in":"query","description":"The ID of the transaction. All the reconciliations related to this transaction will be fetched.","schema":{"type":"string"}},{"name":"payment_id","in":"query","description":"The ID of the payment. All the reconciliations related to this payment will be fetched.","schema":{"type":"string"}},{"name":"payment_type","in":"query","description":"The type of the payment.","schema":{"type":"string","enum":["payment_order","incoming_payment","return","expected_payment","payment_capture"]}},{"name":"match_type","in":"query","description":"The type of the reconciliation.","schema":{"type":"string","enum":["manual","auto"]}},{"name":"start_date","in":"query","description":"The creation date of the reconciliation.","schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","description":"The creation date of the reconciliation.","schema":{"type":"string","format":"date"}},{"name":"canceled","in":"query","description":"If true, only canceled reconciliations will be fetched.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"records":[{"id":"d0f894f5-8c0e-4ab2-bbf2-d70fc35a205f","amount":300,"match_type":"manual","object":"reconciliation","metadata":{"foo":"bar"},"transaction_id":"c6baa031-7f8f-4402-88b3-3bca68c5d81f","payment_id":"34855536-af38-4c2f-929f-a8144d936db1","payment_type":"expected_payment","canceled_at":null,"created_at":"2022-05-04T15:23:36.273498Z"},{"id":"fe6fcb92-cf1e-4858-9626-f94a3eedba6d","amount":1000000,"match_type":"manual","object":"reconciliation","metadata":{},"transaction_id":"86cfd8c6-a70d-4a02-a137-e404f44e6aba","payment_id":"ada2bea5-aa81-4f1f-924c-449e14cfec31","payment_type":"expected_payment","canceled_at":null,"created_at":"2022-05-04T15:25:50.971553Z"}]}}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"cbe093aa-339f-498f-b08a-9fc11593b755"},"object":{"type":"string","example":"reconciliation"},"amount":{"type":"integer","example":2000,"default":0},"match_type":{"type":"string","example":"auto"},"created_at":{"type":"string","example":"2022-01-03"},"canceled_at":{},"transaction":{"type":"object","properties":{"id":{"type":"string","example":"ac2925f7e06944b"},"object":{"type":"string","example":"reconciliation"},"amount":{"type":"integer","example":2000,"default":0},"match_type":{"type":"string","example":"manual"},"created_at":{"type":"string","example":"2022-19-01"},"canceled_at":{},"transaction":{"type":"object","properties":{"id":{"type":"string","example":"f902cace-8a56-11ec-a8a3-0242ac120002"},"object":{"type":"string","example":"transaction"},"connected_account_id":{"type":"string","example":"ff1714ae-3ec8-450d-984c-c6ee44c82a88"},"booking_date":{"type":"string","example":"2021-01-01"},"value_date":{"type":"string","example":"2021-01-02"},"direction":{"type":"string","example":"credit"},"category":{"type":"string","example":"credit_transfer"},"amount":{"type":"integer","example":2000,"default":0},"currency":{"type":"string","example":"EUR"},"description":{"type":"string","example":"MyCompany Invoice 5678"},"counterparty_account_details":{"type":"object","properties":{"account_number":{"type":"string","example":"FR5412739000504811631858C47"},"holder_name":{"type":"string","example":"Jane Doe"}}},"virtual_account_number":{"type":"string","example":"FR4714508000301359366727T71"},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some label"}},"reconciled_amount":{"type":"integer","example":2000,"default":0},"reconciliation_status":{"type":"string","example":"reconciled"},"bank_data":{"type":"object","properties":{"file_id":{"type":"string","example":""},"message_id":{"type":"string","example":""},"transaction_id":{"type":"string","example":""},"end_to_end_id":{"type":"string","example":""}}},"created_at":{"type":"string","example":"2021-01-01T00:11:07Z"},"updated_at":{"type":"string","example":"2021-19-01T00:11:07Z"}}}}},"payment":{"type":"object","properties":{"id":{"type":"string","example":"b69837bf-e784-4bd1-b0d0-2ad0e61a89b6"},"object":{"type":"string","example":"payment_order"},"connected_account_id":{"type":"string","example":"254e3100-afd6-44f2-8084-87e8ae67b554"},"type":{"type":"string","example":"sepa"},"direction":{"type":"string","example":"credit"},"amount":{"type":"integer","example":2000,"default":0},"currency":{"type":"string","example":"EUR"},"purpose":{"type":"string","example":"Invoice 1234"},"originating_account":{"type":"object","properties":{"account_number":{"type":"string","example":"FR7601234567890627967100010"},"bank_code":{"type":"string","example":"SOGEFRPP"},"holder_name":{"type":"string","example":"SoftwareCo"},"holder_address":{"type":"object","properties":{"line_1":{"type":"string","example":"1, place de la Concorde"},"line_2":{"type":"string","example":""},"building_number":{"type":"string","example":"1"},"street_name":{"type":"string","example":"place de la Concorde"},"postal_code":{"type":"string","example":"75008"},"region_state":{"type":"string","example":""},"city":{"type":"string","example":"Paris"},"country":{"type":"string","example":"FR"}}}}},"receiving_account":{"type":"object","properties":{"account_number":{"type":"string","example":"FR7601234567891127967100082"},"bank_code":{"type":"string","example":"BNPAFRPPXXX"},"holder_name":{"type":"string","example":"PartnerCo"},"holder_address":{"type":"object","properties":{"line_1":{"type":"string","example":"1, rue de la Bourse"},"line_2":{"type":"string","example":""},"building_number":{"type":"string","example":"1"},"street_name":{"type":"string","example":"rue de la Bourse"},"postal_code":{"type":"string","example":"59000"},"region_state":{"type":"string","example":""},"city":{"type":"string","example":"Lille"},"country":{"type":"string","example":"FR"}}}}},"value_date":{"type":"string","example":"2022-01-03"},"status":{"type":"string","example":"executed"},"status_details":{"type":"string","example":""},"reconciled_amount":{"type":"integer","example":2000,"default":0},"reconciliation_status":{"type":"string","example":"reconciled"},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some label"}},"bank_data":{"type":"object","properties":{"file_id":{"type":"string","example":"a815e756-5576-4d40-9fbd-38ec304b856c"},"message_id":{"type":"string","example":"1gXrtKMxLJ"},"transaction_id":{"type":"string","example":"1zDrzOMxCJ"},"end_to_end_id":{"type":"string","example":"c3b2d737bc"}}},"created_at":{"type":"string","example":"2022-01-03T11:53:19.734182Z"},"updated_at":{"type":"string","example":"2022-01-03T15:12:20.644356Z"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":{}}},"schema":{"type":"object","properties":{}}}}}}}},"/reconciliations/{id}/cancel":{"post":{"summary":"Cancel reconciliation","description":"Cancel a reconciliation","operationId":"cancel-reconciliation","tags":["Reconciliations"],"parameters":[{"name":"id","in":"path","description":"The ID of the reconciliation.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":{}}},"schema":{"type":"object","properties":{}}}}}}}},"/reconciliations/{id}":{"post":{"summary":"Update reconciliation","description":"Update a reconciliation.","operationId":"update-reconciliation","tags":["Reconciliations"],"parameters":[{"name":"id","in":"path","description":"The UUID of the reconciliation.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["metadata"],"properties":{"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some label"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"id":"c0f8a4f5-8c1e-4aa2-bbf2-d704835a705f","amount":300,"match_type":"manual","object":"reconciliation","metadata":{"foo":"bar"},"transaction_id":"c6bb4031-7f2f-4a02-88b3-3bc268d0281f","payment_id":"34ac5536-af38-4c99-921f-a81447966db1","payment_type":"expected_payment","canceled_at":null,"created_at":"2022-05-04T15:23:36.273498Z"}}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"c0f8a4f5-8c1e-4aa2-bbf2-d704835a705f"},"amount":{"type":"integer","example":300,"default":0},"match_type":{"type":"string","example":"manual"},"object":{"type":"string","example":"reconciliation"},"metadata":{"<<":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some label"}},"example":{"foo":"bar"}},"transaction_id":{"type":"string","example":"c6bb4031-7f2f-4a02-88b3-3bc268d0281f"},"payment_id":{"type":"string","example":"34ac5536-af38-4c99-921f-a81447966db1"},"payment_type":{"type":"string","example":"expected_payment"},"canceled_at":{},"created_at":{"type":"string","example":"2022-05-04T15:23:36.273498Z"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":{}}},"schema":{"type":"object","properties":{}}}}},"415":{"$ref":"#/components/responses/errors.415.unsupported_media_type"}}},"get":{"summary":"Retrieve reconciliation","description":"Retrieve the details of a reconciliation.","operationId":"retrieve-reconciliation","tags":["Reconciliations"],"parameters":[{"name":"id","in":"path","description":"The ID of the reconciliation.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"id":"fe6fcb92-cf1e-4858-9626-f94a3eedba6d","amount":1000000,"match_type":"manual","object":"reconciliation","metadata":{},"transaction_id":"86cfd8c6-a70d-4a02-a137-e404f44e6aba","payment_id":"ada2bea5-aa81-4f1f-924c-449e14cfec31","payment_type":"expected_payment","canceled_at":null,"created_at":"2022-05-04T15:25:50.971553Z"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":{}}},"schema":{"type":"object","properties":{}}}}}}}},"/expected_payments":{"post":{"summary":"Create expected payment","description":"Create an expected payment, that can be used for reconciliation purposes.","operationId":"create-expected-payment","tags":["Expected Payments"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request.","schema":{"type":"string","example":"8A2gcC"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/expected_payment.creation_details"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/expected_payment.details"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"415":{"$ref":"#/components/responses/errors.415.unsupported_media_type"}}},"get":{"summary":"List expected payments","description":"List and filter expected payments.","operationId":"list-expected-payments","tags":["Expected Payments"],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","minimum":0,"maximum":100,"default":25}},{"name":"starting_after","in":"query","description":"The ID of the object from which your list request will start. It is not included in the result.","schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/list.common_parameters.sort_order"},{"name":"start_date","in":"query","description":"The creation date of the expected payment.","schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","description":"The creation date of the expected payment.","schema":{"type":"string","format":"date"}},{"name":"start_expected_date","in":"query","description":"The expected date of the expected payment.","schema":{"type":"string","format":"date"}},{"name":"end_expected_date","in":"query","description":"The expected date of the expected payment.","schema":{"type":"string","format":"date"}},{"name":"direction","in":"query","description":"The direction of the expected payment.","schema":{"type":"string","enum":["credit","debit"]}},{"name":"amount_from","in":"query","description":"The amount of the expected payment.","schema":{"type":"integer","format":"int32"}},{"name":"amount_to","in":"query","description":"The amount of the expected payment.","schema":{"type":"integer","format":"int32"}},{"name":"currency","in":"query","description":"The currency of the payment.","schema":{"type":"string"}},{"name":"canceled","in":"query","description":"If `true`, only canceled expected payments will be fetched.","schema":{"type":"boolean"}},{"name":"connected_account_id","in":"query","description":"The ID of the connected account related to the expected payment.","schema":{"type":"string","format":"uuid"}},{"name":"counterparty_account_number","in":"query","description":"The account number of the counterparty, which can be the IBAN or any other identification provided by the bank.","schema":{"type":"string"},"deprecated":true},{"name":"external_account_number","in":"query","description":"The external account number, which can be the IBAN or any other identification provided by the bank.","schema":{"type":"string"}},{"name":"counterparty_holder_name","in":"query","description":"The name of the counterparty.","schema":{"type":"string"},"deprecated":true},{"name":"external_account_holder_name","in":"query","description":"The name of the external account holder.","schema":{"type":"string"}},{"name":"description","in":"query","description":"The description of the `expected_payment`.","schema":{"type":"string"}},{"name":"virtual_account_number","in":"query","description":"The number of the virtual account linked to the expected payment.","schema":{"type":"string"},"deprecated":true},{"name":"internal_account_number","in":"query","description":"The number of the internal account of type `virtual` linked to the expected payment.","schema":{"type":"string"}},{"name":"reconciliation_status","in":"query","description":"The reconciliation status of the expected payment.","schema":{"type":"string","enum":["unreconciled","partially_reconciled","reconciled","excluded"]}},{"name":"counterparty_id","in":"query","description":"The ID of the counterparty of the expected payment.","schema":{"type":"string","format":"uuid"},"deprecated":true},{"name":"external_account_holder_id","in":"query","description":"The ID of the external account holder.","schema":{"type":"string","format":"uuid"}},{"name":"counterparty_account_id","in":"query","description":"The ID of the counterparty account of the expected payment.","schema":{"type":"string","format":"uuid"},"deprecated":true},{"name":"external_account_id","in":"query","description":"The ID of the external account.","schema":{"type":"string","format":"uuid"}},{"name":"idempotency_key","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","required":["records"],"properties":{"records":{"type":"array","items":{"$ref":"#/components/schemas/expected_payment.details"}}}}}}},"400":{"$ref":"#/components/responses/errors.400.validation"}}}},"/expected_payments/{id}/cancel":{"post":{"summary":"Cancel expected payment","description":"Cancel an expected payment. Only unreconciled expected payments can be canceled. To cancel an expected payment which is already part of a reconciliation, cancel the related reconciliations beforehand.","operationId":"cancel-expected-payment","tags":["Expected Payments"],"parameters":[{"$ref":"#/components/parameters/expected_payment.id"}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/expected_payment.details"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"description":"Conflicts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"},"examples":{"Already canceled expected payment":{"value":{"error":"canceled_at","message":"An expected payment that has already been canceled cannot be canceled again."}},"Reconciled expected payment":{"value":{"error":"reconciliation_status","message":"A reconciled expected payment cannot be canceled."}},"Partially reconciled expected payment":{"value":{"error":"reconciliation_status","message":"A partially_reconciled expected payment cannot be canceled."}}}}}}}}},"/expected_payments/{id}":{"post":{"summary":"Update expected payment","description":"Update an expected payment","operationId":"update-expected-payment","tags":["Expected Payments"],"parameters":[{"name":"id","in":"path","description":"ID of the expected payment","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/expected_payment.update_details"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/expected_payment.details"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"415":{"$ref":"#/components/responses/errors.415.unsupported_media_type"}}},"get":{"summary":"Retrieve expected payment","description":"Retrieve the details of an expected payment.","operationId":"retrieve-expected-payment","tags":["Expected Payments"],"parameters":[{"$ref":"#/components/parameters/expected_payment.id"}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/expected_payment.details"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"}}}},"/payment_captures":{"post":{"summary":"Create payment capture","description":"Create a payment capture, that can be used for reconciliation purposes.","operationId":"create-payment-capture","tags":["Payment Captures"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request.","schema":{"type":"string","example":"8A2gcC"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_capture.creation_details"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_capture.details"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"415":{"$ref":"#/components/responses/errors.415.unsupported_media_type"}}},"get":{"summary":"List payment captures","description":"List and filter payment captures.","operationId":"list-payment-captures","tags":["Payment Captures"],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","minimum":0,"maximum":100,"default":25}},{"name":"starting_after","in":"query","description":"The ID of the object from which your list request will start. It is not included in the result.","schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/list.common_parameters.sort_order"},{"name":"start_date","in":"query","description":"The creation date of the payment capture.","schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","description":"The creation date of the payment capture.","schema":{"type":"string","format":"date"}},{"name":"idempotency_key","in":"query","schema":{"type":"string"}},{"name":"connected_account_id","in":"query","description":"The ID of the connected account related to the payment capture.","schema":{"type":"string","format":"uuid"}},{"name":"payment_reference","in":"query","description":"The payment reference of the payment capture (e.g. archiving reference).","schema":{"type":"string"}},{"name":"remittance_reference","in":"query","description":"The remittance reference of the payment capture.","schema":{"type":"string"}},{"name":"start_value_date","in":"query","description":"The value date of the payment capture.","schema":{"type":"string","format":"date"}},{"name":"end_value_date","in":"query","description":"The value date of the payment capture.","schema":{"type":"string","format":"date"}},{"name":"transaction_reference","in":"query","description":"The transaction reference of the payment capture.","schema":{"type":"string"}},{"name":"amount_from","in":"query","description":"The amount of the payment capture.","schema":{"type":"integer","format":"uint"}},{"name":"amount_to","in":"query","description":"The amount of the payment capture.","schema":{"type":"integer","format":"uint"}},{"name":"original_payment_amount_from","in":"query","description":"The original amount of the payment capture.","schema":{"type":"integer","format":"uint"}},{"name":"original_payment_amount_to","in":"query","description":"The original amount of the payment capture.","schema":{"type":"integer","format":"uint"}},{"name":"currency","in":"query","description":"The currency of the payment capture.","schema":{"type":"string"}},{"name":"canceled","in":"query","description":"If `true`, only canceled payment captures will be fetched.","schema":{"type":"boolean"}},{"name":"reconciliation_status","in":"query","description":"The reconciliation status of the payment capture.","schema":{"type":"string","enum":["unreconciled","partially_reconciled","reconciled","excluded"]}},{"name":"source","in":"query","description":"The source of the payment capture.","schema":{"type":"string","enum":["api","reporting_file"]}},{"name":"merchant_id","in":"query","description":"The merchant ID of the payment capture.","schema":{"type":"string"}},{"name":"type","in":"query","description":"The type of the payment capture.","schema":{"type":"string","enum":["charge","chargeback","refund"]}},{"name":"network","in":"query","description":"The scheme of the payment capture.","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","required":["records"],"properties":{"records":{"type":"array","items":{"$ref":"#/components/schemas/payment_capture.details"}}}}}}},"400":{"$ref":"#/components/responses/errors.400.validation"}}}},"/payment_captures/{id}/cancel":{"post":{"summary":"Cancel payment capture","description":"Cancel a payment capture. Only unreconciled payment captures can be canceled. To cancel a payment capture which is already part of a reconciliation, cancel the related reconciliations beforehand.","operationId":"cancel-payment-capture","tags":["Payment Captures"],"parameters":[{"$ref":"#/components/parameters/payment_capture.id"}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_capture.details"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"description":"Conflicts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"},"examples":{"Already canceled payment capture":{"value":{"error":"canceled_at","message":"A payment capture that has already been canceled cannot be canceled again."}},"Reconciled payment capture":{"value":{"error":"reconciliation_status","message":"A reconciled payment capture cannot be canceled."}},"Partially reconciled payment capture":{"value":{"error":"reconciliation_status","message":"A partially_reconciled payment capture cannot be canceled."}}}}}}}}},"/payment_captures/{id}":{"post":{"summary":"Update payment capture","description":"Update a payment capture.","operationId":"update-payment-capture","tags":["Payment Captures"],"parameters":[{"name":"id","in":"path","description":"The UUID of the payment capture.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["metadata"],"properties":{"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some label"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_capture.details"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"}}},"get":{"summary":"Retrieve payment capture","description":"Retrieve the details of a payment capture.","operationId":"retrieve-payment-capture","tags":["Payment Captures"],"parameters":[{"$ref":"#/components/parameters/payment_capture.id"}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment_capture.details"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"}}}}}}