{"openapi":"3.0.0","paths":{"/orders":{"get":{"operationId":"OrdersController_list","parameters":[],"responses":{"200":{"description":""}},"tags":["orders"],"x-permissions":["order.read"]},"post":{"operationId":"OrdersController_create","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"quantity":{"type":"integer","minimum":1,"maximum":10000000},"sellerOrgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["quantity"],"additionalProperties":false}}}},"responses":{"201":{"description":""}},"tags":["orders"],"x-permissions":["order.create"]}},"/orders/preview":{"get":{"operationId":"OrdersController_preview","parameters":[],"responses":{"200":{"description":""}},"tags":["orders"],"x-permissions":["order.create"]}},"/orders/{id}":{"get":{"operationId":"OrdersController_get","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["orders"],"x-permissions":["order.read"]}},"/orders/{id}/declare-payment":{"post":{"operationId":"OrdersController_declare","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"reference":{"type":"string","minLength":4,"maxLength":60,"pattern":"^[A-Za-z0-9][A-Za-z0-9 /._-]*$"},"amount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"currency":{"type":"string","minLength":3,"maxLength":3},"declaredOn":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"rail":{"default":"MANUAL","type":"string","enum":["MANUAL","ECOBANK_PAPSS"]},"proofDocumentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"proofReference":{"type":"string","maxLength":120},"idempotencyKey":{"type":"string","pattern":"^[a-f0-9]{32}$"}},"required":["reference","amount","declaredOn","rail"],"additionalProperties":false}}}},"responses":{"200":{"description":""}},"tags":["orders"],"x-permissions":["order.declare_payment"]}},"/orders/{id}/pay-online":{"post":{"operationId":"OrdersController_payOnline","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"idempotencyKey":{"type":"string","pattern":"^[a-f0-9]{32}$"}},"additionalProperties":false}}}},"responses":{"200":{"description":""}},"tags":["orders"],"x-permissions":["order.declare_payment"]}},"/orders/{id}/confirm-payment":{"post":{"operationId":"OrdersController_confirm","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"receivedAmount":{"type":"integer","minimum":0,"maximum":9007199254740991},"reason":{"type":"string","minLength":3,"maxLength":500}},"additionalProperties":false}}}},"responses":{"200":{"description":""}},"tags":["orders"],"x-permissions":["order.confirm_payment"]}},"/orders/{id}/release":{"post":{"operationId":"OrdersController_release","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["orders"],"x-permissions":["order.release"]}},"/orders/{id}/cancel":{"post":{"operationId":"OrdersController_cancel","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"reason":{"type":"string","minLength":3,"maxLength":500}},"required":["reason"],"additionalProperties":false}}}},"responses":{"200":{"description":""}},"tags":["orders"],"x-permissions":["order.cancel"]}},"/callbacks/{rail}":{"post":{"operationId":"CallbacksController_receive","parameters":[{"name":"rail","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["callbacks"],"x-public":true}},"/payments/exceptions":{"get":{"operationId":"PaymentsController_exceptions","parameters":[],"responses":{"200":{"description":""}},"tags":["payments"],"x-permissions":["order.confirm_payment"]}},"/statements":{"post":{"operationId":"StatementsController_import","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"fileName":{"type":"string","minLength":1,"maxLength":200},"content":{"type":"string","minLength":1,"maxLength":5000000},"format":{"type":"string","enum":["CSV","CAMT053"]}},"required":["fileName","content"],"additionalProperties":false}}}},"responses":{"201":{"description":""}},"tags":["statements"],"x-permissions":["statement.import"]},"get":{"operationId":"StatementsController_imports","parameters":[],"responses":{"200":{"description":""}},"tags":["statements"],"x-permissions":["statement.import"]}},"/statements/lines":{"get":{"operationId":"StatementsController_lines","parameters":[],"responses":{"200":{"description":""}},"tags":["statements"],"x-permissions":["statement.import"]}},"/statements/open-orders":{"get":{"operationId":"StatementsController_openOrders","parameters":[],"responses":{"200":{"description":""}},"tags":["statements"],"x-permissions":["statement.import"]}},"/statements/{id}":{"get":{"operationId":"StatementsController_get","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["statements"],"x-permissions":["statement.import"]}},"/statements/lines/{lineId}/match":{"post":{"operationId":"StatementsController_match","parameters":[{"name":"lineId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["orderId"],"additionalProperties":false}}}},"responses":{"200":{"description":""}},"tags":["statements"],"x-permissions":["statement.import"]}},"/statements/lines/{lineId}/unmatch":{"post":{"operationId":"StatementsController_unmatch","parameters":[{"name":"lineId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["statements"],"x-permissions":["statement.import"]}},"/settlements":{"get":{"operationId":"SettlementsController_list","parameters":[],"responses":{"200":{"description":""}},"tags":["settlements"],"x-permissions":["settlement.read"]}},"/settlements/{id}":{"get":{"operationId":"SettlementsController_get","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["settlements"],"x-permissions":["settlement.read"]}},"/settlements/{id}/entries/{entryId}/confirm":{"post":{"operationId":"SettlementsController_confirm","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"entryId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"transferReference":{"type":"string","minLength":4,"maxLength":60,"pattern":"^[A-Za-z0-9][A-Za-z0-9 /._-]*$"}},"required":["transferReference"],"additionalProperties":false}}}},"responses":{"200":{"description":""}},"tags":["settlements"],"x-permissions":["settlement.confirm_transfer"]}},"/pricing/tier-schedules":{"get":{"operationId":"PricingController_schedules","parameters":[],"responses":{"200":{"description":""}},"tags":["pricing"],"x-permissions":["pricing.read"]},"post":{"operationId":"PricingController_createSchedule","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"currency":{"default":"XOF","type":"string","minLength":3,"maxLength":3},"tiers":{"minItems":1,"type":"array","items":{"type":"object","properties":{"code":{"type":"string","minLength":2,"maxLength":20},"minAnnualVolume":{"type":"integer","minimum":0,"maximum":9007199254740991},"unitPrice":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["code","minAnnualVolume","unitPrice"],"additionalProperties":false}}},"required":["currency","tiers"],"additionalProperties":false}}}},"responses":{"201":{"description":""}},"tags":["pricing"],"x-permissions":["pricing.manage"]}},"/pricing/country-tiers":{"get":{"operationId":"PricingController_countryTiers","parameters":[],"responses":{"200":{"description":""}},"tags":["pricing"],"x-permissions":["pricing.read"]}},"/pricing/country-tiers/{country}/{year}":{"put":{"operationId":"PricingController_publishTier","parameters":[{"name":"country","required":true,"in":"path","schema":{"type":"string"}},{"name":"year","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"tier":{"type":"string","minLength":2,"maxLength":20},"reason":{"type":"string","maxLength":500}},"required":["tier"],"additionalProperties":false}}}},"responses":{"200":{"description":""}},"tags":["pricing"],"x-permissions":["pricing.manage"]}},"/pricing/proposals":{"get":{"operationId":"PricingController_proposals","parameters":[],"responses":{"200":{"description":""}},"tags":["pricing"],"x-permissions":["pricing.read"]}},"/pricing/proposals/{country}/approve":{"post":{"operationId":"PricingController_approve","parameters":[{"name":"country","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"observedYear":{"type":"integer","minimum":2000,"maximum":2100}},"required":["observedYear"],"additionalProperties":false}}}},"responses":{"201":{"description":""}},"tags":["pricing"],"x-permissions":["pricing.manage"]}},"/pricing/price-lists":{"get":{"operationId":"PricingController_priceLists","parameters":[],"responses":{"200":{"description":""}},"tags":["pricing"],"x-permissions":["pricing.read"]},"post":{"operationId":"PricingController_createPriceList","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"unitPrice":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"currency":{"default":"XOF","type":"string","minLength":3,"maxLength":3},"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["unitPrice","currency"],"additionalProperties":false}}}},"responses":{"201":{"description":""}},"tags":["pricing"],"x-permissions":["pricing.manage"]}},"/pricing/distribution-keys":{"get":{"operationId":"PricingController_keys","parameters":[],"responses":{"200":{"description":""}},"tags":["pricing"],"x-permissions":["pricing.read"]},"post":{"operationId":"PricingController_createKey","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"effectiveFrom":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"shares":{"minItems":1,"type":"array","items":{"type":"object","properties":{"party":{"type":"string","minLength":2,"maxLength":20},"percent":{"type":"number","exclusiveMinimum":0,"maximum":100}},"required":["party","percent"],"additionalProperties":false}},"remainderTo":{"type":"string"},"countingBasis":{"default":"CREDITS_PAID","type":"string","enum":["CREDITS_PAID"]}},"required":["shares","remainderTo","countingBasis"],"additionalProperties":false}}}},"responses":{"201":{"description":""}},"tags":["pricing"],"x-permissions":["pricing.manage"]}},"/deposits":{"get":{"operationId":"DepositsController_list","parameters":[],"responses":{"200":{"description":""}},"tags":["deposits"],"x-permissions":["deposit.read"]},"post":{"operationId":"DepositsController_request","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"bureauOrgId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"amount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"currency":{"default":"XOF","type":"string","minLength":3,"maxLength":3},"note":{"type":"string","maxLength":500}},"required":["bureauOrgId","amount","currency"],"additionalProperties":false}}}},"responses":{"201":{"description":""}},"tags":["deposits"],"x-permissions":["deposit.manage"]}},"/deposits/{id}/payments":{"post":{"operationId":"DepositsController_pay","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"reference":{"type":"string","minLength":4,"maxLength":60,"pattern":"^[A-Za-z0-9][A-Za-z0-9 /._-]*$"},"amount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["reference"],"additionalProperties":false}}}},"responses":{"200":{"description":""}},"tags":["deposits"],"x-permissions":["deposit.manage"]}}},"info":{"title":"Finance service","description":"Stock orders, payment declaration and confirmation (PAPSS via Ecobank), statement matching, tiers and pricing, the distribution key, settlement ledger and security deposits.","version":"1.0.0","contact":{}},"tags":[],"servers":[],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"x-api-key","description":"An integration key, created under Integrations → Integration keys. It looks like `bc_1a2b3c4d_…` and is shown once, when you create it."},"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http","description":"An integration key sent as `Authorization: Bearer bc_…`, or the session token of a signed-in user."}},"schemas":{}}}