Initiates a new transaction where the sender and recipient have already been onboarded. Both must have active customer profiles.
Request Headers
string
required
JWT Access Token of the authenticated user.
string
required
A unique key for this transaction submission. If the same key is sent twice, the second request returns the result of the first rather than creating a duplicate transaction. Use a UUID or a unique reference from your system.
string
required
IP address of the device initiating the transaction.
string
default:"fincode"
required
Platform identifier. Use fincode.
string
default:"200"
required
Unique request identifier.
string
Optional. The password is not checked on create-transaction, so this header can be left out.
Request Body
number
required
The amount the recipient will receive, in the receiving currency.
number
required
The amount the sender pays, in the sending currency.
boolean
required
Whether fees are included in sendAmount. Set to true if the sender pays a fixed amount inclusive of all fees; false if fees are added on top.
string
required
ISO 4217 currency code the sender is paying in (e.g. GBP).
string
required
ISO 4217 currency code the recipient will receive (e.g. NGN).
string
required
Transaction / delivery method. Common values:
Value
Description
ACCOUNTPAYMENT
Bank account transfer
MOBILE_MONEY
Mobile money (e.g. M-Pesa)
CASHPICKUP
Cash pickup at agent location
WALLET
Wallet transfer
string
required
Aggregation mode for the transaction. Accepted values: NONE_AGGREGATION and AGGREGATION. Use NONE_AGGREGATION for a standard transaction.
string
Accepted but not currently used. Whatever value is sent, cashier bookings are recorded as CASHIER_PAY_FROM_CUSTOMER_E_WALLET, and every booking starts as PENDING_PAYMENT. To pay for a booking from a wallet, call Make Payment from Wallet. A value that is not a valid payment method is rejected.
string
Customer code of an existing sender (returned from find-customer-by-name-or-phone-no or register-customer). Required unless you send newSenderKyc to create a new sender in the same request. Send exactly one of the two. See Agent Integration for the new sender option.
string
Customer code of an existing recipient/beneficiary (returned from new-beneficiary). Required unless you send newRecipientKyc to create a new recipient in the same request. Send exactly one of the two.
array
required
Key-value pairs for the recipient’s bank/account details. See the Add Bank Details key reference for the full list of valid keys. All keys must be lowercase.
Show creditParty item
string
required
Field key — must be lowercase. Common values: bankname, bankaccountno, accountholdername, bankcode, swiftbic, sortcode, iban.
string
Field value.
object
required
Regulatory and routing information for the transfer.
Show internationalTransferInformation fields
string
required
ISO 3166-1 alpha-3 code of the sender’s country (e.g. GBR)
string
required
ISO 3166-1 alpha-3 code of the recipient’s country (e.g. NGA)
string
required
Purpose of the transfer (e.g. FAMILY_SUPPORT, GIFT, EDUCATION)
string
required
Declared source of funds (e.g. SALARY, SAVINGS, BUSINESS)
string
Sender’s relationship to the recipient (e.g. PARENT, SPOUSE, FRIEND)
string
Security question for cash pickup transactions. Required when type is CASHPICKUP.
string
Answer to the security question. Required when type is CASHPICKUP.
string
Your own reference for this transaction. Optional — the platform generates one if not provided.
object
Additional dynamic fields specific to your configuration. Pass an empty object {} if not applicable.
array
List of documents attached to this transaction (for transactions requiring document verification). Pass an empty array [] if none.
The response is returned as a plain object (not wrapped in data). On success, these fields carry values:
string
The payment reference number (PCN). Use it for payment and status calls such as checktransactionstatus/{pcn}.
string
The transaction ID.
string
The transaction ID, for use as payAbleId in payment calls.
string
SUCCESS when the transaction was created.
string
The transaction status, normally PENDING_PAYMENT for a new booking.
string
The sender’s customer code. Store it and reuse it for later bookings with the same sender.
string
The recipient’s customer code. Store it and reuse it for later bookings with the same recipient.
string
The sender’s user ID.
number
The amount the recipient will receive.
string
ISO 3166-1 alpha-3 code of the sending country.
string
ISO 3166-1 alpha-3 code of the receiving country.
string
TRANSACTION.
boolean
Whether the transaction has passed its compliance checks.
string
Compliance check result: PASS, WARNING, AWAITING_CUSTOMER_ACTION or FAIL.
array
Compliance requirements linked to this transaction.
string
Transaction created successfully.
Other fields in the response are not populated on success and come back empty (null, 0 or false). There are no fields named pcn or customerCode; the PCN is in objectReference.
When compliance documents are required
If the booking cannot go ahead until the customer provides documents, no PCN is returned. The response carries statusFAILED, transactionStatusFAILED, errorCode-1, errorCodeTypeKYC_DOCUMENT_REQUIRED_502, a message explaining the requirement, and customerComplianceCheckList listing what is needed. Collect the listed documents, then submit the booking again.
Headers
platform
string
default:fincode
required
uuid
string
default:200
required
X-Auth-Token
string
required
password
string
Optional. Not checked on create-transaction.
ipAddress
string
required
X-Idempotency-Key
string
required
Body
application/json
amount
string
required
sendAmount
string
required
inclussive
boolean
required
receivingCurrency
string
default:NGN
required
sendCurrency
string
default:GBP
required
type
string
default:ACCOUNTPAYMENT
required
preExistingSenderCustomerCode
string
required
preExistingRecipientCustomerCode
string
required
creditParty
object[]
required
internationalTransferInformation
object
required
transactionProcessingMode
string
default:NONE_AGGREGATION
descriptionText
string
transactionModule
string
default:REMITTANCE
Response
200 - application/json
Transaction created. On success these fields carry values; other fields come back empty (null, 0 or false). If compliance documents are required, status is FAILED, errorCodeType is KYC_DOCUMENT_REQUIRED_502 and no PCN is returned.
objectReference
string
Payment reference number (PCN)
serverCorrelationId
string
Transaction ID
payAbleId
string
Transaction ID, for use as payAbleId in payment calls
status
string
SUCCESS when created, FAILED when compliance documents are required
transactionStatus
string
Transaction status, normally PENDING_PAYMENT for a new booking
preExistingSenderCustomerCode
string
Sender's customer code
preExistingRecipientCustomerCode
string
Recipient's customer code
userId
string
Sender's user ID
receivingAmount
number
Amount the recipient will receive
iso3CountryFrom
string
ISO 3166-1 alpha-3 code of the sending country
iso3CountryTo
string
ISO 3166-1 alpha-3 code of the receiving country
payableType
string
TRANSACTION
compliant
boolean
Whether the transaction has passed its compliance checks
complienceCheck
enum<string>
Available options:
PASS,
WARNING,
AWAITING_CUSTOMER_ACTION,
FAIL
customerComplianceCheckList
object[]
Compliance requirements linked to this transaction
message
string
errorCode
string
-1 when compliance documents are required
errorCodeType
string
KYC_DOCUMENT_REQUIRED_502 when compliance documents are required
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"FinCode Platform","colors":{"primary":"#734CDC","light":"#734CDC","dark":"#79359F"},"logo":{"light":"https://mintcdn.com/fincode/8bMKpNvzhWMZ8TuP/logo/logo.png?fit=max\u0026auto=format\u0026n=8bMKpNvzhWMZ8TuP\u0026q=85\u0026s=db1240518f55835a324cde1e8377682d","dark":"https://mintcdn.com/fincode/8bMKpNvzhWMZ8TuP/logo/logo.png?fit=max\u0026auto=format\u0026n=8bMKpNvzhWMZ8TuP\u0026q=85\u0026s=db1240518f55835a324cde1e8377682d","href":"https://docs.fincode.technology"},"favicon":"https://mintcdn.com/fincode/ryDAHkGMzsGXiEgb/favicon.svg?fit=max\u0026auto=format\u0026n=ryDAHkGMzsGXiEgb\u0026q=85\u0026s=bc4af5ca2aa38e3d5a719288084c0e4e","appearance":{"default":"light"},"navbar":{"primary":{"type":"button","label":"Contact Sales","href":"https://fincode.co.uk/contact-us/"}},"footer":{"socials":{"github":"https://github.com/fincodeuk","linkedin":"https://linkedin.com/company/fincodeUk","twitter":"https://twitter.com/fincodehq"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"fincode","hasAudioNarration":false,"actualSubdomain":"fincode","customDomains":["docs.fincode.technology"],"gitSource":{"type":"github","owner":"trillionclues-fincode","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6aff1b141c16aa85135f5cef","clientVersion":"0.0.4248","searchFilterCounts":[{"language":"default","tag":"API Reference","count":151},{"language":"default","tag":"Customer Identity \u0026 Access Management","count":58},{"language":"default","tag":"Lending","count":37},{"language":"default","tag":"Remittance","count":26},{"language":"default","tag":"Getting Started","count":17},{"language":"default","tag":"Deposit Engine","count":15},{"language":"default","tag":"Core Flows","count":14},{"language":"default","tag":"Ledger Engine","count":12},{"language":"default","tag":"Songhai Exchange (Payment Switch)","count":12},{"language":"default","tag":"Savings \u0026 Investment","count":11}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api/transactions/create-transaction","slug":"/api/transactions/create-transaction","pageMetadata":{"title":"Create Transaction","openapi":"POST /transactionmanagement/create-transaction","description":"Initiate a new remittance transaction using existing customer profiles.","href":"/api/transactions/create-transaction"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Initiate a new remittance transaction using existing customer profiles.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,ParamField,ResponseField,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Initiates a new transaction where the sender and recipient have already been onboarded. Both must have active customer profiles.`}),`\n`,_jsx(Heading,{level:`2`,id:`request-headers`,children:`Request Headers`}),`\n`,_jsx(ParamField,{header:`X-Auth-Token`,type:`string`,required:true,id:`param-x-auth-token`,children:_jsx(_components.p,{children:`JWT Access Token of the authenticated user.`})}),`\n`,_jsx(ParamField,{header:`X-Idempotency-Key`,type:`string`,required:true,id:`param-x-idempotency-key`,children:_jsx(_components.p,{children:`A unique key for this transaction submission. If the same key is sent twice, the second request returns the result of the first rather than creating a duplicate transaction. Use a UUID or a unique reference from your system.`})}),`\n`,_jsx(ParamField,{header:`ipAddress`,type:`string`,required:true,id:`param-ip-address`,children:_jsx(_components.p,{children:`IP address of the device initiating the transaction.`})}),`\n`,_jsx(ParamField,{header:`platform`,type:`string`,required:true,default:`fincode`,id:`param-platform`,children:_jsxs(_components.p,{children:[`Platform identifier. Use `,_jsx(_components.code,{children:`fincode`}),`.`]})}),`\n`,_jsx(ParamField,{header:`uuid`,type:`string`,required:true,default:`200`,id:`param-uuid`,children:_jsx(_components.p,{children:`Unique request identifier.`})}),`\n`,_jsx(ParamField,{header:`password`,type:`string`,id:`param-password`,children:_jsx(_components.p,{children:`Optional. The password is not checked on create-transaction, so this header can be left out.`})}),`\n`,_jsx(Heading,{level:`2`,id:`request-body`,children:`Request Body`}),`\n`,_jsx(ParamField,{body:`amount`,type:`number`,required:true,id:`param-amount`,children:_jsx(_components.p,{children:`The amount the recipient will receive, in the receiving currency.`})}),`\n`,_jsx(ParamField,{body:`sendAmount`,type:`number`,required:true,id:`param-send-amount`,children:_jsx(_components.p,{children:`The amount the sender pays, in the sending currency.`})}),`\n`,_jsx(ParamField,{body:`inclussive`,type:`boolean`,required:true,id:`param-inclussive`,children:_jsxs(_components.p,{children:[`Whether fees are included in `,_jsx(_components.code,{children:`sendAmount`}),`. Set to `,_jsx(_components.code,{children:`true`}),` if the sender pays a fixed amount inclusive of all fees; `,_jsx(_components.code,{children:`false`}),` if fees are added on top.`]})}),`\n`,_jsx(ParamField,{body:`sendCurrency`,type:`string`,required:true,id:`param-send-currency`,children:_jsxs(_components.p,{children:[`ISO 4217 currency code the sender is paying in (e.g. `,_jsx(_components.code,{children:`GBP`}),`).`]})}),`\n`,_jsx(ParamField,{body:`receivingCurrency`,type:`string`,required:true,id:`param-receiving-currency`,children:_jsxs(_components.p,{children:[`ISO 4217 currency code the recipient will receive (e.g. `,_jsx(_components.code,{children:`NGN`}),`).`]})}),`\n`,_jsxs(ParamField,{body:`type`,type:`string`,required:true,id:`param-type`,children:[_jsx(_components.p,{children:`Transaction / delivery method. Common values:`}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Value`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ACCOUNTPAYMENT`})}),_jsx(_components.td,{children:`Bank account transfer`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`MOBILE_MONEY`})}),_jsx(_components.td,{children:`Mobile money (e.g. M-Pesa)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`CASHPICKUP`})}),_jsx(_components.td,{children:`Cash pickup at agent location`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`WALLET`})}),_jsx(_components.td,{children:`Wallet transfer`})]})]})]})]}),`\n`,_jsx(ParamField,{body:`transactionProcessingMode`,type:`string`,required:true,id:`param-transaction-processing-mode`,children:_jsxs(_components.p,{children:[`Aggregation mode for the transaction. Accepted values: `,_jsx(_components.code,{children:`NONE_AGGREGATION`}),` and `,_jsx(_components.code,{children:`AGGREGATION`}),`. Use `,_jsx(_components.code,{children:`NONE_AGGREGATION`}),` for a standard transaction.`]})}),`\n`,_jsx(ParamField,{body:`paymentMethod`,type:`string`,id:`param-payment-method`,children:_jsxs(_components.p,{children:[`Accepted but not currently used. Whatever value is sent, cashier bookings are recorded as `,_jsx(_components.code,{children:`CASHIER_PAY_FROM_CUSTOMER_E_WALLET`}),`, and every booking starts as `,_jsx(_components.code,{children:`PENDING_PAYMENT`}),`. To pay for a booking from a wallet, call `,_jsx(_components.a,{href:`/api/deposit-engine/make-payment-from-wallet`,children:`Make Payment from Wallet`}),`. A value that is not a valid payment method is rejected.`]})}),`\n`,_jsx(ParamField,{body:`preExistingSenderCustomerCode`,type:`string`,id:`param-pre-existing-sender-customer-code`,children:_jsxs(_components.p,{children:[`Customer code of an existing sender (returned from `,_jsx(_components.code,{children:`find-customer-by-name-or-phone-no`}),` or `,_jsx(_components.code,{children:`register-customer`}),`). Required unless you send `,_jsx(_components.code,{children:`newSenderKyc`}),` to create a new sender in the same request. Send exactly one of the two. See `,_jsx(_components.a,{href:`/remittance/agent-integration`,children:`Agent Integration`}),` for the new sender option.`]})}),`\n`,_jsx(ParamField,{body:`preExistingRecipientCustomerCode`,type:`string`,id:`param-pre-existing-recipient-customer-code`,children:_jsxs(_components.p,{children:[`Customer code of an existing recipient/beneficiary (returned from `,_jsx(_components.code,{children:`new-beneficiary`}),`). Required unless you send `,_jsx(_components.code,{children:`newRecipientKyc`}),` to create a new recipient in the same request. Send exactly one of the two.`]})}),`\n`,_jsxs(ParamField,{body:`creditParty`,type:`array`,required:true,id:`param-credit-party`,children:[_jsxs(_components.p,{children:[`Key-value pairs for the recipient’s bank/account details. See the `,_jsx(_components.a,{href:`/api/transactions/add-bank-details`,children:`Add Bank Details`}),` key reference for the full list of valid keys. All keys must be lowercase.`]}),_jsxs(Expandable,{title:`creditParty item`,children:[_jsx(ParamField,{body:`key`,type:`string`,required:true,id:`param-key`,children:_jsxs(_components.p,{children:[`Field key — must be lowercase. Common values: `,_jsx(_components.code,{children:`bankname`}),`, `,_jsx(_components.code,{children:`bankaccountno`}),`, `,_jsx(_components.code,{children:`accountholdername`}),`, `,_jsx(_components.code,{children:`bankcode`}),`, `,_jsx(_components.code,{children:`swiftbic`}),`, `,_jsx(_components.code,{children:`sortcode`}),`, `,_jsx(_components.code,{children:`iban`}),`.`]})}),_jsx(ParamField,{body:`value`,type:`string`,id:`param-value`,children:_jsx(_components.p,{children:`Field value.`})})]})]}),`\n`,_jsxs(ParamField,{body:`internationalTransferInformation`,type:`object`,required:true,id:`param-international-transfer-information`,children:[_jsx(_components.p,{children:`Regulatory and routing information for the transfer.`}),_jsxs(Expandable,{title:`internationalTransferInformation fields`,children:[_jsxs(ParamField,{body:`originCountry`,type:`string`,required:true,id:`param-origin-country`,children:[`ISO 3166-1 alpha-3 code of the sender’s country (e.g. `,_jsx(_components.code,{children:`GBR`}),`)`]}),_jsxs(ParamField,{body:`receivingCountry`,type:`string`,required:true,id:`param-receiving-country`,children:[`ISO 3166-1 alpha-3 code of the recipient’s country (e.g. `,_jsx(_components.code,{children:`NGA`}),`)`]}),_jsxs(ParamField,{body:`remittancePurpose`,type:`string`,required:true,id:`param-remittance-purpose`,children:[`Purpose of the transfer (e.g. `,_jsx(_components.code,{children:`FAMILY_SUPPORT`}),`, `,_jsx(_components.code,{children:`GIFT`}),`, `,_jsx(_components.code,{children:`EDUCATION`}),`)`]}),_jsxs(ParamField,{body:`sourceOfFunds`,type:`string`,required:true,id:`param-source-of-funds`,children:[`Declared source of funds (e.g. `,_jsx(_components.code,{children:`SALARY`}),`, `,_jsx(_components.code,{children:`SAVINGS`}),`, `,_jsx(_components.code,{children:`BUSINESS`}),`)`]}),_jsxs(ParamField,{body:`relationshipSender`,type:`string`,id:`param-relationship-sender`,children:[`Sender’s relationship to the recipient (e.g. `,_jsx(_components.code,{children:`PARENT`}),`, `,_jsx(_components.code,{children:`SPOUSE`}),`, `,_jsx(_components.code,{children:`FRIEND`}),`)`]})]})]}),`\n`,_jsx(ParamField,{body:`securityQuestion`,type:`string`,id:`param-security-question`,children:_jsxs(_components.p,{children:[`Security question for cash pickup transactions. Required when `,_jsx(_components.code,{children:`type`}),` is `,_jsx(_components.code,{children:`CASHPICKUP`}),`.`]})}),`\n`,_jsx(ParamField,{body:`securityAnswer`,type:`string`,id:`param-security-answer`,children:_jsxs(_components.p,{children:[`Answer to the security question. Required when `,_jsx(_components.code,{children:`type`}),` is `,_jsx(_components.code,{children:`CASHPICKUP`}),`.`]})}),`\n`,_jsx(ParamField,{body:`transactionReference`,type:`string`,id:`param-transaction-reference`,children:_jsx(_components.p,{children:`Your own reference for this transaction. Optional — the platform generates one if not provided.`})}),`\n`,_jsx(ParamField,{body:`dynamicFields`,type:`object`,id:`param-dynamic-fields`,children:_jsxs(_components.p,{children:[`Additional dynamic fields specific to your configuration. Pass an empty object `,_jsx(_components.code,{children:`{}`}),` if not applicable.`]})}),`\n`,_jsx(ParamField,{body:`eligibleDocumentList`,type:`array`,id:`param-eligible-document-list`,children:_jsxs(_components.p,{children:[`List of documents attached to this transaction (for transactions requiring document verification). Pass an empty array `,_jsx(_components.code,{children:`[]`}),` if none.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`code-example`,children:`Code Example`}),`\n`,_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`34`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`34`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'https://{your-domain}.fincode.software/api/v6/services/transactionmanagement/create-transaction'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`--header `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'X-Auth-Token: YOUR_TOKEN'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`--header `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'X-Idempotency-Key: a1b2c3d4-e5f6-7890-abcd-ef1234567890'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`--header `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'ipAddress: 192.168.1.100'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`--header `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Content-Type: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`--header `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'platform: fincode'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`--header `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'uuid: 200'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`--data `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"amount\": 150000,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"sendAmount\": 100,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"inclussive\": false,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"sendCurrency\": \"GBP\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"receivingCurrency\": \"NGN\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"type\": \"ACCOUNTPAYMENT\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"transactionProcessingMode\": \"NONE_AGGREGATION\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"preExistingSenderCustomerCode\": \"VJJGVE\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"preExistingRecipientCustomerCode\": \"BNADKO\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"creditParty\": [`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` {\"key\": \"bankname\", \"value\": \"GTBank\"},`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` {\"key\": \"bankaccountno\", \"value\": \"0123456789\"},`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` {\"key\": \"accountholdername\", \"value\": \"Ada Okonkwo\"},`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` {\"key\": \"bankcode\", \"value\": \"058\"},`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` {\"key\": \"swiftbic\", \"value\": \"GTBINGLA\"}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ],`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"internationalTransferInformation\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"originCountry\": \"GBR\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"receivingCountry\": \"NGA\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"remittancePurpose\": \"FAMILY_SUPPORT\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"sourceOfFunds\": \"SALARY\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"relationshipSender\": \"PARENT\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"dynamicFields\": {},`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"eligibleDocumentList\": []`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`}'`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsxs(_components.p,{children:[`The response is returned as a plain object (not wrapped in `,_jsx(_components.code,{children:`data`}),`). On success, these fields carry values:`]}),`\n`,_jsx(ResponseField,{name:`objectReference`,type:`string`,id:`param-object-reference`,children:_jsxs(_components.p,{children:[`The payment reference number (PCN). Use it for payment and status calls such as `,_jsx(_components.code,{children:`checktransactionstatus/{pcn}`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`serverCorrelationId`,type:`string`,id:`param-server-correlation-id`,children:_jsx(_components.p,{children:`The transaction ID.`})}),`\n`,_jsx(ResponseField,{name:`payAbleId`,type:`string`,id:`param-pay-able-id`,children:_jsxs(_components.p,{children:[`The transaction ID, for use as `,_jsx(_components.code,{children:`payAbleId`}),` in payment calls.`]})}),`\n`,_jsx(ResponseField,{name:`status`,type:`string`,id:`param-status`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`SUCCESS`}),` when the transaction was created.`]})}),`\n`,_jsx(ResponseField,{name:`transactionStatus`,type:`string`,id:`param-transaction-status`,children:_jsxs(_components.p,{children:[`The transaction status, normally `,_jsx(_components.code,{children:`PENDING_PAYMENT`}),` for a new booking.`]})}),`\n`,_jsx(ResponseField,{name:`preExistingSenderCustomerCode`,type:`string`,id:`param-pre-existing-sender-customer-code-1`,children:_jsx(_components.p,{children:`The sender’s customer code. Store it and reuse it for later bookings with the same sender.`})}),`\n`,_jsx(ResponseField,{name:`preExistingRecipientCustomerCode`,type:`string`,id:`param-pre-existing-recipient-customer-code-1`,children:_jsx(_components.p,{children:`The recipient’s customer code. Store it and reuse it for later bookings with the same recipient.`})}),`\n`,_jsx(ResponseField,{name:`userId`,type:`string`,id:`param-user-id`,children:_jsx(_components.p,{children:`The sender’s user ID.`})}),`\n`,_jsx(ResponseField,{name:`receivingAmount`,type:`number`,id:`param-receiving-amount`,children:_jsx(_components.p,{children:`The amount the recipient will receive.`})}),`\n`,_jsx(ResponseField,{name:`iso3CountryFrom`,type:`string`,id:`param-iso3-country-from`,children:_jsx(_components.p,{children:`ISO 3166-1 alpha-3 code of the sending country.`})}),`\n`,_jsx(ResponseField,{name:`iso3CountryTo`,type:`string`,id:`param-iso3-country-to`,children:_jsx(_components.p,{children:`ISO 3166-1 alpha-3 code of the receiving country.`})}),`\n`,_jsx(ResponseField,{name:`payableType`,type:`string`,id:`param-payable-type`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`TRANSACTION`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`compliant`,type:`boolean`,id:`param-compliant`,children:_jsx(_components.p,{children:`Whether the transaction has passed its compliance checks.`})}),`\n`,_jsx(ResponseField,{name:`complienceCheck`,type:`string`,id:`param-complience-check`,children:_jsxs(_components.p,{children:[`Compliance check result: `,_jsx(_components.code,{children:`PASS`}),`, `,_jsx(_components.code,{children:`WARNING`}),`, `,_jsx(_components.code,{children:`AWAITING_CUSTOMER_ACTION`}),` or `,_jsx(_components.code,{children:`FAIL`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`customerComplianceCheckList`,type:`array`,id:`param-customer-compliance-check-list`,children:_jsx(_components.p,{children:`Compliance requirements linked to this transaction.`})}),`\n`,_jsx(ResponseField,{name:`message`,type:`string`,id:`param-message`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`Transaction created successfully`}),`.`]})}),`\n`,_jsxs(_components.p,{children:[`Other fields in the response are not populated on success and come back empty (`,_jsx(_components.code,{children:`null`}),`, `,_jsx(_components.code,{children:`0`}),` or `,_jsx(_components.code,{children:`false`}),`). There are no fields named `,_jsx(_components.code,{children:`pcn`}),` or `,_jsx(_components.code,{children:`customerCode`}),`; the PCN is in `,_jsx(_components.code,{children:`objectReference`}),`.`]}),`\n`,_jsx(Heading,{level:`3`,id:`when-compliance-documents-are-required`,children:`When compliance documents are required`}),`\n`,_jsxs(_components.p,{children:[`If the booking cannot go ahead until the customer provides documents, no PCN is returned. The response carries `,_jsx(_components.code,{children:`status`}),` `,_jsx(_components.code,{children:`FAILED`}),`, `,_jsx(_components.code,{children:`transactionStatus`}),` `,_jsx(_components.code,{children:`FAILED`}),`, `,_jsx(_components.code,{children:`errorCode`}),` `,_jsx(_components.code,{children:`-1`}),`, `,_jsx(_components.code,{children:`errorCodeType`}),` `,_jsx(_components.code,{children:`KYC_DOCUMENT_REQUIRED_502`}),`, a `,_jsx(_components.code,{children:`message`}),` explaining the requirement, and `,_jsx(_components.code,{children:`customerComplianceCheckList`}),` listing what is needed. Collect the listed documents, then submit the booking again.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Transaction","openapi":"POST /transactionmanagement/create-transaction","description":"Initiate a new remittance transaction using existing customer profiles.","href":"/api/transactions/create-transaction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Request Headers","slug":"request-headers","depth":2,"children":[]},{"title":"Request Body","slug":"request-body","depth":2,"children":[]},{"title":"Code Example","slug":"code-example","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[{"title":"When compliance documents are required","slug":"when-compliance-documents-are-required","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create Transaction","description":"Initiate a new remittance transaction using existing customer profiles.","operationId":"createTransaction","parameters":["2eb4a733-9561-4036-90e7-fb80c6b1cdbd","019ddca0-8f3f-476f-848c-05548ea5d7e2","9a95bd9e-9bc1-47c3-8ca9-64a17a11fb6f","90f0d576-cf46-4976-83df-a656e1ea31e4","519e8041-0344-45d3-81ff-4e5053799164","f597e6c1-b4eb-45f8-b6cb-4d61193752e9"],"requestBody":"033b8af0-76fb-4d50-a4c2-012c82cb039c","responses":{"200":"4cac9532-dd7e-49f3-a93b-546ed9e26a2b"},"method":"post","type":"path","servers":["7565086e-1caf-42ad-aab2-595b1b1fdc38","d68cadc3-8e20-4f5a-8321-437566ffe4f7","51a28f80-086d-4d48-86ba-81229e977d30"],"security":[],"path":"/transactionmanagement/create-transaction","baseUrlOptions":["https://{your-domain}.fincode.software/api/v6/services","https://{your-domain}.fincode.software/api/v1/services","https://api.stag.songhaiexchange.io"],"title":"Create Transaction","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2eb4a733-9561-4036-90e7-fb80c6b1cdbd":{"in":"header","name":"platform","schema":{"type":"string","default":"fincode","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true},"019ddca0-8f3f-476f-848c-05548ea5d7e2":{"in":"header","name":"uuid","schema":{"type":"string","default":"200","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true},"9a95bd9e-9bc1-47c3-8ca9-64a17a11fb6f":{"in":"header","name":"X-Auth-Token","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true},"90f0d576-cf46-4976-83df-a656e1ea31e4":{"in":"header","name":"password","description":"Optional. Not checked on create-transaction.","schema":{"type":"string","isRequired":false,"description":"Optional. Not checked on create-transaction.","uniqueKey":"","typeLabel":"string"},"required":false},"519e8041-0344-45d3-81ff-4e5053799164":{"in":"header","name":"ipAddress","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true},"f597e6c1-b4eb-45f8-b6cb-4d61193752e9":{"in":"header","name":"X-Idempotency-Key","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"string","isRequired":true,"uniqueKey":"amount","typeLabel":"string"},"sendAmount":{"type":"string","isRequired":true,"uniqueKey":"sendAmount","typeLabel":"string"},"inclussive":{"type":"boolean","isRequired":true,"uniqueKey":"inclussive","typeLabel":"boolean"},"receivingCurrency":{"type":"string","default":"NGN","isRequired":true,"uniqueKey":"receivingCurrency","typeLabel":"string"},"sendCurrency":{"type":"string","default":"GBP","isRequired":true,"uniqueKey":"sendCurrency","typeLabel":"string"},"type":{"type":"string","default":"ACCOUNTPAYMENT","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"preExistingSenderCustomerCode":{"type":"string","isRequired":true,"uniqueKey":"preExistingSenderCustomerCode","typeLabel":"string"},"preExistingRecipientCustomerCode":{"type":"string","isRequired":true,"uniqueKey":"preExistingRecipientCustomerCode","typeLabel":"string"},"creditParty":{"type":"array","items":{"type":"object","uniqueKey":"creditParty.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"creditParty","typeLabel":"object[]"},"internationalTransferInformation":{"type":"object","isRequired":true,"uniqueKey":"internationalTransferInformation","typeLabel":"object"},"transactionProcessingMode":{"type":"string","default":"NONE_AGGREGATION","uniqueKey":"transactionProcessingMode","typeLabel":"string"},"descriptionText":{"type":"string","uniqueKey":"descriptionText","typeLabel":"string"},"transactionModule":{"type":"string","default":"REMITTANCE","uniqueKey":"transactionModule","typeLabel":"string"}},"required":["amount","sendAmount","inclussive","receivingCurrency","sendCurrency","type","preExistingSenderCustomerCode","preExistingRecipientCustomerCode","creditParty","internationalTransferInformation"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"amount":"\u003cstring>","sendAmount":"\u003cstring>","inclussive":true,"receivingCurrency":"NGN","sendCurrency":"GBP","type":"ACCOUNTPAYMENT","preExistingSenderCustomerCode":"\u003cstring>","preExistingRecipientCustomerCode":"\u003cstring>","creditParty":[{}],"internationalTransferInformation":{},"transactionProcessingMode":"NONE_AGGREGATION","descriptionText":"\u003cstring>","transactionModule":"REMITTANCE"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"4cac9532-dd7e-49f3-a93b-546ed9e26a2b":{"description":"Transaction created. On success these fields carry values; other fields come back empty (null, 0 or false). If compliance documents are required, status is FAILED, errorCodeType is KYC_DOCUMENT_REQUIRED_502 and no PCN is returned.","content":{"application/json":{"schema":{"type":"object","properties":{"objectReference":{"type":"string","description":"Payment reference number (PCN)","uniqueKey":"objectReference","typeLabel":"string"},"serverCorrelationId":{"type":"string","description":"Transaction ID","uniqueKey":"serverCorrelationId","typeLabel":"string"},"payAbleId":{"type":"string","description":"Transaction ID, for use as payAbleId in payment calls","uniqueKey":"payAbleId","typeLabel":"string"},"status":{"type":"string","description":"SUCCESS when created, FAILED when compliance documents are required","uniqueKey":"status","typeLabel":"string"},"transactionStatus":{"type":"string","description":"Transaction status, normally PENDING_PAYMENT for a new booking","uniqueKey":"transactionStatus","typeLabel":"string"},"preExistingSenderCustomerCode":{"type":"string","description":"Sender's customer code","uniqueKey":"preExistingSenderCustomerCode","typeLabel":"string"},"preExistingRecipientCustomerCode":{"type":"string","description":"Recipient's customer code","uniqueKey":"preExistingRecipientCustomerCode","typeLabel":"string"},"userId":{"type":"string","description":"Sender's user ID","uniqueKey":"userId","typeLabel":"string"},"receivingAmount":{"type":"number","description":"Amount the recipient will receive","uniqueKey":"receivingAmount","typeLabel":"number"},"iso3CountryFrom":{"type":"string","description":"ISO 3166-1 alpha-3 code of the sending country","uniqueKey":"iso3CountryFrom","typeLabel":"string"},"iso3CountryTo":{"type":"string","description":"ISO 3166-1 alpha-3 code of the receiving country","uniqueKey":"iso3CountryTo","typeLabel":"string"},"payableType":{"type":"string","description":"TRANSACTION","uniqueKey":"payableType","typeLabel":"string"},"compliant":{"type":"boolean","description":"Whether the transaction has passed its compliance checks","uniqueKey":"compliant","typeLabel":"boolean"},"complienceCheck":{"type":"string","enum":["PASS","WARNING","AWAITING_CUSTOMER_ACTION","FAIL"],"uniqueKey":"complienceCheck","typeLabel":"enum\u003cstring>"},"customerComplianceCheckList":{"type":"array","items":{"type":"object","uniqueKey":"customerComplianceCheckList.items.[INDEX]","typeLabel":"object"},"description":"Compliance requirements linked to this transaction","uniqueKey":"customerComplianceCheckList","typeLabel":"object[]"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"errorCode":{"type":"string","description":"-1 when compliance documents are required","uniqueKey":"errorCode","typeLabel":"string"},"errorCodeType":{"type":"string","description":"KYC_DOCUMENT_REQUIRED_502 when compliance documents are required","uniqueKey":"errorCodeType","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"objectReference":"\u003cstring>","serverCorrelationId":"\u003cstring>","payAbleId":"\u003cstring>","status":"\u003cstring>","transactionStatus":"\u003cstring>","preExistingSenderCustomerCode":"\u003cstring>","preExistingRecipientCustomerCode":"\u003cstring>","userId":"\u003cstring>","receivingAmount":123,"iso3CountryFrom":"\u003cstring>","iso3CountryTo":"\u003cstring>","payableType":"\u003cstring>","compliant":true,"complienceCheck":"PASS","customerComplianceCheckList":[{}],"message":"\u003cstring>","errorCode":"\u003cstring>","errorCodeType":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"7565086e-1caf-42ad-aab2-595b1b1fdc38":{"url":"https://{your-domain}.fincode.software/api/v6/services","description":"API v6","variables":{"your-domain":{"default":"remitjunction","description":"Enter your subdomain"}}},"d68cadc3-8e20-4f5a-8321-437566ffe4f7":{"url":"https://{your-domain}.fincode.software/api/v1/services","description":"API v1","variables":{"your-domain":{"default":"finlend","description":"Enter your subdomain"}}},"51a28f80-086d-4d48-86ba-81229e977d30":{"url":"https://api.stag.songhaiexchange.io","description":"Songhai Exchange API"}}},"originalFileLocation":"openapi.json"},"subdomain":"fincode","siteName":"FinCode Platform","title":"Create Transaction - FinCode Platform","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T14:00:20.494Z","originalFileLocation":"api/transactions/create-transaction.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Initiate a new remittance transaction using existing customer profiles.\">\u003cmeta data-mint-head name=\"application-name\" content=\"FinCode Platform\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fincode/F2sLn9W_rtCfFlNs/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/fincode/F2sLn9W_rtCfFlNs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fincode/F2sLn9W_rtCfFlNs/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/fincode/F2sLn9W_rtCfFlNs/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/fincode/F2sLn9W_rtCfFlNs/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fincode/F2sLn9W_rtCfFlNs/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fincode/F2sLn9W_rtCfFlNs/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/fincode/F2sLn9W_rtCfFlNs/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/fincode/F2sLn9W_rtCfFlNs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Transaction - FinCode Platform\">\u003cmeta data-mint-head property=\"og:description\" content=\"Initiate a new remittance transaction using existing customer profiles.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"FinCode Platform\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.fincode.technology/api/transactions/create-transaction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fincode.mintlify.site/_mintlify/api/og/v2?division=API+Endpoints\u0026amp;title=Create+Transaction\u0026amp;description=Initiate+a+new+remittance+transaction+using+existing+customer+profiles.\u0026amp;theme=5cb295c43f2caf87cf931732\u0026amp;signature=28aea002f0893670e59f8a54b4cc884b2bb14e24f20355efa32eada0a1ad3ab0\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create Transaction - FinCode Platform\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Initiate a new remittance transaction using existing customer profiles.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fincode.mintlify.site/_mintlify/api/og/v2?division=API+Endpoints\u0026amp;title=Create+Transaction\u0026amp;description=Initiate+a+new+remittance+transaction+using+existing+customer+profiles.\u0026amp;theme=5cb295c43f2caf87cf931732\u0026amp;signature=28aea002f0893670e59f8a54b4cc884b2bb14e24f20355efa32eada0a1ad3ab0\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/fincode/F2sLn9W_rtCfFlNs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"FinCode Platform\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#734CDC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.fincode.technology/api/transactions/create-transaction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/transactions/create-transaction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.fincode.technology/#organization\",\"name\":\"FinCode Platform\",\"url\":\"https://docs.fincode.technology\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/fincode/8bMKpNvzhWMZ8TuP/logo/logo.png?fit=max\u0026auto=format\u0026n=8bMKpNvzhWMZ8TuP\u0026q=85\u0026s=db1240518f55835a324cde1e8377682d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.fincode.technology#website\",\"name\":\"FinCode Platform\",\"url\":\"https://docs.fincode.technology\",\"publisher\":{\"@id\":\"https://docs.fincode.technology/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.fincode.technology/api/transactions/create-transaction#webpage\",\"url\":\"https://docs.fincode.technology/api/transactions/create-transaction\",\"name\":\"Create Transaction\",\"description\":\"Initiate a new remittance transaction using existing customer profiles.\",\"dateModified\":\"2026-11-18T14:00:20.494Z\",\"isPartOf\":{\"@id\":\"https://docs.fincode.technology#website\"},\"breadcrumb\":{\"@id\":\"https://docs.fincode.technology/api/transactions/create-transaction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.fincode.technology/api/transactions/create-transaction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Endpoints\",\"item\":\"https://docs.fincode.technology/api/transactions/wallet-account\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Transaction\",\"item\":\"https://docs.fincode.technology/api/transactions/create-transaction\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.fincode.technology/api/transactions/create-transaction#apireference\",\"headline\":\"Create Transaction\",\"name\":\"Create Transaction\",\"description\":\"Initiate a new remittance transaction using existing customer profiles.\",\"url\":\"https://docs.fincode.technology/api/transactions/create-transaction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.fincode.technology/api/transactions/create-transaction#webpage\"},\"dateModified\":\"2026-11-18T14:00:20.494Z\",\"publisher\":{\"@id\":\"https://docs.fincode.technology/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.fincode.technology#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"FinCode Platform\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"FinCode Platform\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api/transactions/create-transaction.md","siteName":"FinCode Platform","nav":{"global":null,"tabs":[{"tab":"Home","pages":[{"title":"Home","href":""}]},{"tab":"Remittance","groups":[{"group":"Getting Started","pages":[{"title":"Overview","icon":"atom","href":"/remittance/overview"},{"title":"Process Flow","icon":"diagram-project","href":"/remittance/process-flows"},{"title":"Agent Integration Guide","icon":"plug","href":"/remittance/agent-integration"}]},{"group":"Transaction Core","pages":[{"title":"Transaction Lifecycle","icon":"timeline","href":"/remittance/transactions"},{"title":"Beneficiary Lifecycle","icon":"user-plus","href":"/remittance/beneficiary-lifecycle"},{"title":"FX Conversion","icon":"money-bill-transfer","href":"/remittance/fx-rates"}]},{"group":"API Endpoints","pages":[{"title":"Wallet Account List","openapi":"GET /walletmanagement/walletaccountlist","href":"/api/transactions/wallet-account"},{"title":"Find All Beneficiary","openapi":"GET /usermanagement/find-all-beneficiery","href":"/api/transactions/beneficiary-list"},{"title":"Transaction Types","openapi":"GET /transactionmanagement/transaction-types","href":"/api/transactions/transaction-types"},{"title":"Beneficiary Details","openapi":"GET /usermanagement/view-beneficiery-details/{beneficiaryId}","href":"/api/transactions/beneficiary-details"},{"title":"Delivery Currencies","openapi":"GET /quote/supported-delivery-currencies/{sendingCountryCode}/{receivingCountryCode}/{deliveryMethod}/{sendingCurrencyCode}","href":"/api/transactions/delivery-currencies"},{"title":"Destination Countries","openapi":"GET /quote/destination-country-by-delivery-method/{sendingCountryCode}/{deliveryMethod}","href":"/api/transactions/destination-countries"},{"title":"Supported Currencies","openapi":"GET /quote/supported-currencies/{sendingCountryCode}/{receivingCountryCode}/{deliveryMethod}","href":"/api/transactions/supported-currencies"},{"title":"Validate Recipient Account","openapi":"GET /usermanagement/validate-bank-account","href":"/api/transactions/validate-account"},{"title":"List Supported Banks","openapi":"GET /bankmanagement/list-supported-banks-iso3/{country}","href":"/api/transactions/list-supported-banks"},{"title":"Required Bank Fields","openapi":"GET /bankmanagement/required-bank-fields/{country}","href":"/api/transactions/required-bank-fields"},{"title":"List Mobile Operators","openapi":"GET /admin/bank/config/find-all-mobile-operator/{country}","href":"/api/transactions/list-mobile-operators"},{"title":"Add Bank Details","openapi":"POST /bankmanagement/add-bank-details-key-value-pairs","href":"/api/transactions/add-bank-details"},{"title":"Get Transaction Quote","openapi":"POST /quote/callQuote","href":"/api/transactions/call-quote"},{"title":"Payment Methods","api":"POST /paymentmanagement/supported-payment-methods","href":"/api/transactions/payment-methods"},{"title":"Create Beneficiary","openapi":"POST /usermanagement/new-beneficiary","href":"/api/transactions/create-beneficiary"},{"title":"Customer Transaction History","openapi":"POST /transactionmanagement/history-data","href":"/api/transactions/history-data"},{"title":"Check Transaction Status","openapi":"GET /transactionmanagement/checktransactionstatus/{transaction_identification_number}","href":"/api/transactions/check-transaction-status"},{"title":"Fetch Transaction Details","openapi":"GET /transactionmanagement/fetch-payable-type/{pcn}/{payable_type}","description":"Returns the full details of a single transaction by its PCN, including the bank details selected when it was created.","href":"/api/transactions/fetch-transaction-details"},{"title":"Create Transaction","openapi":"POST /transactionmanagement/create-transaction","href":"/api/transactions/create-transaction"},{"title":"Create Transaction (Direct)","openapi":"POST /transactionmanagement/create-transaction","description":"Initiate a new remittance transaction using pre-registered sender and recipient customer codes.","href":"/api/transactions/create-transaction-direct"}]}]},{"tab":"Lending","pages":[{"title":"Lending","href":"/lending/overview"}]},{"tab":"Savings \u0026 Investment","pages":[{"title":"Savings \u0026 Investment","href":"/investment/overview"}]},{"tab":"Customer Identity \u0026 Access Management","pages":[{"title":"Customer Identity \u0026 Access Management","href":"/ciam/overview"}]},{"tab":"Payment Switch","pages":[{"title":"Payment Switch","href":"/songhai-exchange/overview"}]},{"tab":"Ledger Engine","pages":[{"title":"Ledger Engine","href":"/ledger/overview"}]},{"tab":"Deposit Engine","pages":[{"title":"Deposit Engine","href":"/deposit-engine/overview"}]},{"tab":"API Reference","groups":[{"group":"Introduction","pages":[{"title":"API Reference","icon":"code","href":"/api/authentication"}]},{"group":"Authentication","pages":[{"title":"Login","openapi":"PUT /securitymanagement/login","href":"/api/auth/login"},{"title":"Logout","openapi":"PUT /securitymanagement/logout","href":"/api/auth/logout"},{"title":"Refresh Token","openapi":"PUT /securitymanagement/refresh-token","href":"/api/auth/refresh-token"}]},{"group":"Security \u0026 Utilities","pages":[{"title":"List Countries","openapi":"GET /utilitiesmanagement/list-all-countries","href":"/api/security/list-countries"},{"title":"Active Countries","openapi":"GET /utilitiesmanagement/active-countries","href":"/api/security/active-countries"},{"title":"Password Policy","openapi":"GET /admin/security/view-password-policy","href":"/api/security/password-policy"},{"title":"Fetch Preference","openapi":"GET /admin/organisation-preference-management/fetch-organisaction-preference","href":"/api/security/fetch-preference"}]},{"group":"Remittance","pages":[{"title":"Wallet Account List","openapi":"GET /walletmanagement/walletaccountlist","href":"/api/transactions/wallet-account"},{"title":"Find All Beneficiary","openapi":"GET /usermanagement/find-all-beneficiery","href":"/api/transactions/beneficiary-list"},{"title":"Transaction Types","openapi":"GET /transactionmanagement/transaction-types","href":"/api/transactions/transaction-types"},{"title":"Beneficiary Details","openapi":"GET /usermanagement/view-beneficiery-details/{beneficiaryId}","href":"/api/transactions/beneficiary-details"},{"title":"Delivery Currencies","openapi":"GET /quote/supported-delivery-currencies/{sendingCountryCode}/{receivingCountryCode}/{deliveryMethod}/{sendingCurrencyCode}","href":"/api/transactions/delivery-currencies"},{"title":"Destination Countries","openapi":"GET /quote/destination-country-by-delivery-method/{sendingCountryCode}/{deliveryMethod}","href":"/api/transactions/destination-countries"},{"title":"Supported Currencies","openapi":"GET /quote/supported-currencies/{sendingCountryCode}/{receivingCountryCode}/{deliveryMethod}","href":"/api/transactions/supported-currencies"},{"title":"Validate Recipient Account","openapi":"GET /usermanagement/validate-bank-account","href":"/api/transactions/validate-account"},{"title":"List Supported Banks","openapi":"GET /bankmanagement/list-supported-banks-iso3/{country}","href":"/api/transactions/list-supported-banks"},{"title":"Required Bank Fields","openapi":"GET /bankmanagement/required-bank-fields/{country}","href":"/api/transactions/required-bank-fields"},{"title":"List Mobile Operators","openapi":"GET /admin/bank/config/find-all-mobile-operator/{country}","href":"/api/transactions/list-mobile-operators"},{"title":"Add Bank Details","openapi":"POST /bankmanagement/add-bank-details-key-value-pairs","href":"/api/transactions/add-bank-details"},{"title":"Get Transaction Quote","openapi":"POST /quote/callQuote","href":"/api/transactions/call-quote"},{"title":"Payment Methods","api":"POST /paymentmanagement/supported-payment-methods","href":"/api/transactions/payment-methods"},{"title":"Create Beneficiary","openapi":"POST /usermanagement/new-beneficiary","href":"/api/transactions/create-beneficiary"},{"title":"Customer Transaction History","openapi":"POST /transactionmanagement/history-data","href":"/api/transactions/history-data"},{"title":"Check Transaction Status","openapi":"GET /transactionmanagement/checktransactionstatus/{transaction_identification_number}","href":"/api/transactions/check-transaction-status"},{"title":"Fetch Transaction Details","openapi":"GET /transactionmanagement/fetch-payable-type/{pcn}/{payable_type}","description":"Returns the full details of a single transaction by its PCN, including the bank details selected when it was created.","href":"/api/transactions/fetch-transaction-details"},{"title":"Create Transaction","openapi":"POST /transactionmanagement/create-transaction","href":"/api/transactions/create-transaction"},{"title":"Create Transaction (Direct)","openapi":"POST /transactionmanagement/create-transaction","description":"Initiate a new remittance transaction using pre-registered sender and recipient customer codes.","href":"/api/transactions/create-transaction-direct"}]},{"group":"Lending","pages":[{"title":"Get Application","openapi":"GET /admin/loan-application/{loan-application-id}","href":"/api/lending/get-application"},{"title":"List Loan Products","openapi":"GET /user/list-products","href":"/api/lending/list-products"},{"title":"Eligibility Questions","openapi":"GET /user/loan-eligibility-questions/{productId}","href":"/api/lending/loan-eligibility-questions"},{"title":"Loan History","openapi":"GET /user/get-loan-history/{customerId}","href":"/api/lending/get-loan-history"},{"title":"Customers Total Loan","openapi":"GET /user/get-total/{customerId}","href":"/api/lending/get-total-loan"},{"title":"Get Loan Offer","openapi":"GET /user/get-loan-offer","href":"/api/lending/get-loan-offer"},{"title":"Available Banks","openapi":"GET /user/get-available-banks/","href":"/api/lending/get-available-banks"},{"title":"Verify Bank Account","openapi":"GET /user/verify-bank-account/{bankCode}/{accountNumber}","href":"/api/lending/verify-bank-account"},{"title":"List Bank Accounts","openapi":"GET /user/list-customer-bank-accounts/{customerId}","href":"/api/lending/list-customer-bank-accounts"},{"title":"Transfer History","openapi":"GET /user/transfer-history/{customerId}","href":"/api/lending/transfer-history"},{"title":"Manage Loans","openapi":"GET /user/manage-loans/{customerId}","href":"/api/lending/manage-loans"},{"title":"List Repayments","openapi":"GET /admin/repayments/list","href":"/api/lending/list-repayments"},{"title":"Transfer Status","api":"GET https://{your-domain}.fincode.software/api/v1/services/user/check-transfer-status/{transactionReference}","href":"/api/lending/transfer-status"},{"title":"Get Loan Terms","api":"GET https://{your-domain}.fincode.software/api/v1/services/user/get-loan-terms/{organisationId}","href":"/api/lending/get-loan-terms"},{"title":"Pending Repayments","api":"GET https://{your-domain}.fincode.software/api/v1/services/user/pending-repayments/{user-id}","href":"/api/lending/pending-repayments"},{"title":"Repaid Transactions","api":"GET https://{your-domain}.fincode.software/api/v1/services/user/repaid-transactions/{user-id}","href":"/api/lending/repaid-transactions"},{"title":"Repayment Instructions","api":"GET https://{your-domain}.fincode.software/api/v1/services/user/repayment-instructions/{loan-application-id}","href":"/api/lending/repayment-instructions"},{"title":"Loan Details with Payment History","api":"GET https://{your-domain}.fincode.software/api/v1/services/user/loan-details-with-payment-history/{loan-application-id}","href":"/api/lending/loan-details-with-payment-history"},{"title":"View Bank Account","api":"GET https://{your-domain}.fincode.software/api/v1/services/user/view-bank-account/{account-id}","href":"/api/lending/view-bank-account"},{"title":"Loan Application Details","api":"GET https://{your-domain}.fincode.software/api/v1/services/user/loan-application-details/{loan-application-id}","href":"/api/lending/loan-application-details"},{"title":"List Customer Repayments","api":"GET https://{your-domain}.fincode.software/api/v1/services/user/list-customer-repayments/{customer-id}","href":"/api/lending/list-customer-repayments"},{"title":"Update Loan Offer","api":"PUT https://{your-domain}.fincode.software/api/v1/services/user/update-application/{loan-application-id}","href":"/api/lending/update-application"},{"title":"Accept Loan Offer","openapi":"PUT /user/accept-loan-offer/{loanApplicationId}/accept","href":"/api/lending/accept-loan-offer"},{"title":"Reject Loan Offer","openapi":"PUT /user/accept-loan-offer/{loanApplicationId}/reject","href":"/api/lending/reject-loan-offer"},{"title":"Accept Loan Terms","openapi":"PUT /user/accept-terms-and-conditions/{loanApplicationId}","href":"/api/lending/accept-loan-terms"},{"title":"Transfer Funds to Bank","api":"POST https://{your-domain}.fincode.software/api/v1/services/user/transfer-funds-to-bank","href":"/api/lending/transfer-funds"},{"title":"Payoff Loan","api":"POST https://{your-domain}.fincode.software/api/v1/services/user/payoff-loan","href":"/api/lending/payoff-loan"},{"title":"Repay Loan","api":"POST https://{your-domain}.fincode.software/api/v1/services/user/repay-loan/{user-id}","href":"/api/lending/repay-loan"},{"title":"Calculate APR","api":"POST https://{your-domain}.fincode.software/api/v1/services/user/calculate-apr","href":"/api/lending/calculate-apr"},{"title":"Add Bank Account","api":"POST https://{your-domain}.fincode.software/api/v1/services/user/create-bank-account","href":"/api/lending/add-bank-account"},{"title":"Request Loan","openapi":"POST /user/request-loan","href":"/api/lending/loan-request"}]},{"group":"Ledger Engine","pages":[{"title":"Account Balance","openapi":"GET /ledger/account-balance/{account_id}","href":"/api/ledger/account-balance"},{"title":"Ledger History","openapi":"GET /ledger/account-ledger-history/{account_id}/{page}/{size}","href":"/api/ledger/ledger-history"},{"title":"Ledger History by ID","openapi":"GET /ledger/account-ledger-history-interaction-id","href":"/api/ledger/ledger-history-interaction-id"},{"title":"Ledger History by Idempotency Key","openapi":"GET /ledger/account-ledger-history-idempotencykey","href":"/api/ledger/ledger-history-idempotency-key"},{"title":"List Accounts","openapi":"GET /account-maintenance/list-accounts/{account-owner-id}","href":"/api/ledger/list-accounts"},{"title":"Change Account Permission","openapi":"GET /account-maintenance/change-account-permission/{id}/{permission}","href":"/api/ledger/change-account-permission"},{"title":"Post to Account","openapi":"POST /gateway/post-account","href":"/api/ledger/post-account"}]},{"group":"Savings \u0026 Investment","pages":[{"title":"Get Total Investments","openapi":"GET /get-total/{user-id}","href":"/api/investment/get-total-investments"},{"title":"List Customer Portfolios","openapi":"GET /portfolios/{customer-id}","href":"/api/investment/list-portfolios"},{"title":"Get Investment Quote","openapi":"GET /quote/get-quote/{product-id}/{number-of-units-to-purchase}","href":"/api/investment/get-quote"},{"title":"Fund Wallet","openapi":"PUT /wallet/fund-wallet/{wallet-id}/{amount}","href":"/api/investment/fund-wallet"},{"title":"Create Investment Application","openapi":"POST /apply","href":"/api/investment/create-investment-application"}]},{"group":"Deposit Engine","pages":[{"title":"List Awaiting Payments","openapi":"GET /paymentmanagement/awaiting-payments","href":"/api/deposit-engine/awaiting-payments"},{"title":"Bank Pay Later (Wallet)","openapi":"PUT /paymentmanagement/bank-iwillpaylater-wallet/{pcn}/{payableType_String}","href":"/api/deposit-engine/bank-iwillpaylater"},{"title":"Awaiting Payment Actions","openapi":"POST /paymentmanagement/awaiting-payment-actions","href":"/api/deposit-engine/awaiting-payment-actions"},{"title":"Payment Methods Charges","openapi":"POST /paymentmanagement/payment-methods-charges","href":"/api/deposit-engine/payment-methods-charges"},{"title":"Notify Bank Transfer Payment","openapi":"POST /paymentmanagement/notify-bank-transfer-payment","href":"/api/deposit-engine/notify-bank-transfer-payment"},{"title":"Supported Payment Methods","openapi":"POST /paymentmanagement/supported-payment-methods","href":"/api/deposit-engine/supported-payment-methods"},{"title":"Make Payment from Wallet","openapi":"POST /paymentmanagement/makepaymentfromwalletaccount","href":"/api/deposit-engine/make-payment-from-wallet"},{"title":"Fund Customer Wallet by Payment Token","openapi":"POST /paymentmanagement/processpaymentwithpaymenttoken","href":"/api/deposit-engine/process-payment-with-token"},{"title":"Process Card Payment","openapi":"POST /paymentmanagement/process-card-payment","href":"/api/deposit-engine/process-card-payment"}]},{"group":"Customer Identity \u0026 Access Management","pages":[{"title":"Customer Profile","openapi":"GET /usermanagement/profile","href":"/api/ciam/profile"},{"title":"Get Customer By ID","openapi":"GET /admin/customer-management/profile/{id}","href":"/api/ciam/customer-by-id"},{"title":"Deactivate User Account","openapi":"GET /usermanagement/deactivate-user-account/{id}","href":"/api/ciam/deactivate-user"},{"title":"Activate User Account","openapi":"GET /usermanagement/activate-user-account/{id}","href":"/api/ciam/activate-user"},{"title":"Find Customer By Name or Phone","openapi":"GET /usermanagement/find-customer-by-name-or-phone-no/{search-criteria}","href":"/api/ciam/find-customer-by-name-or-phone-no"},{"title":"Generate and send otp toemail","href":"/api/ciam/generate-and-send-otp-toemail"},{"title":"List Employees","openapi":"GET /admin/employee-management/list-employees","href":"/api/ciam/list-employees"},{"title":"Start/Continue Verification","openapi":"GET /admin/compliance/continue-enrolment","href":"/api/ciam/continue-enrolment"},{"title":"Get Dynamic Fields","openapi":"GET /dynamicfields/dynamic-fields-group/{processGroupCode}","href":"/api/ciam/dynamic-fields"},{"title":"Get Pay Centre By ID","openapi":"GET /admin/pay-centre-management/pay-centre-by/{id}","href":"/api/ciam/pay-centre-by-id"},{"title":"List Connectors","openapi":"GET /admin/connector-management/list-connectors","href":"/api/ciam/list-connectors"},{"title":"Reset Password","openapi":"GET /securitymanagement/reset-password/{email}","href":"/api/ciam/reset-password"},{"title":"KYC Detail By ID","openapi":"GET /admin/compliance/kyc-detail/{id}","href":"/api/ciam/kyc-detail-by-id"},{"title":"Dynamic Fields Group","openapi":"GET /dynamicfields/dynamic-fields-group/{groupName}","href":"/api/ciam/dynamic-fields-group"},{"title":"View Password Policy","openapi":"GET /admin/security/view-password-policy","href":"/api/ciam/view-password-policy"},{"title":"Fetch Organisation Preference","openapi":"GET /admin/organisation-preference-management/fetch-organisaction-preference","href":"/api/ciam/fetch-organisaction-preference"},{"title":"List Customers","openapi":"GET /admin/customer-management/list-customers","href":"/api/ciam/list-customers"},{"title":"Verify Customer","openapi":"GET /admin/customer-management/verify-customer/{id}","href":"/api/ciam/verify-customer"},{"title":"KYC Requirements by Country","openapi":"GET /compliance/kyc-requirements-by-isocountry/{countryIso}/{triggerPoint}","href":"/api/ciam/kyc-requirements-by-isocountry"},{"title":"Pre-Transaction Compliance Checklist","openapi":"PUT /compliance/customer-compliance-checklist","href":"/api/ciam/compliance-checklist"},{"title":"Organisation Compliance Policy","openapi":"GET /compliance/list-organisation-compliance-policy","href":"/api/ciam/list-organisation-compliance-policy"},{"title":"List Pay Centers by Type","openapi":"GET /branches/list-paycenters-by-type/{type}","href":"/api/ciam/list-paycenters-by-type"},{"title":"List Attached Dynamic Forms","openapi":"GET /admin/compliance/list-attached-form","href":"/api/ciam/cra-forms"},{"title":"List AML Rules","openapi":"GET /admin/compliance/list-aml-rules","href":"/api/ciam/list-aml-rules"},{"title":"Change Password","openapi":"PUT /securitymanagement/change-password","href":"/api/ciam/change-password"},{"title":"Edit Customer Profile","openapi":"PUT /usermanagement/profile-edit","href":"/api/ciam/edit-profile"},{"title":"Update Connector Instance","openapi":"PUT /admin/connector-management/update-connector-instance","href":"/api/ciam/update-connector-instance"},{"title":"Delete Customer Bank Details","openapi":"DELETE /bankmanagement/delete-customer-bank-details/{account-owner-id}/{bank-detail-id}","href":"/api/ciam/delete-customer-bank-details"},{"title":"Awaiting Payments","openapi":"PUT /admin/payment-management/awaiting-payments","href":"/api/ciam/awaiting-payments"},{"title":"Upload Profile Picture","openapi":"PUT /documentmanagement/upload-profile-picture","href":"/api/ciam/upload-profile-picture"},{"title":"Edit Employee","openapi":"PUT /admin/employee-management/edit-employee/{id}","href":"/api/ciam/edit-employee"},{"title":"Update Organisation Preference","openapi":"PUT /admin/organisation-preference-management/update-organisaction-preference","href":"/api/ciam/update-organisaction-preference"},{"title":"Deactivate AML Rule","openapi":"PUT /admin/compliance/deactivate-aml-rule/{id}","href":"/api/ciam/deactivate-aml-rule"},{"title":"Activate AML Rule","openapi":"PUT /admin/compliance/activate-aml-rule/{id}","href":"/api/ciam/activate-aml-rule"},{"title":"Update AML Rules","openapi":"PUT /admin/compliance/update-aml-rules","href":"/api/ciam/update-aml-rules"},{"title":"Edit KYC Rule","openapi":"PUT /admin/compliance/edit-kyc-rule","href":"/api/ciam/edit-kyc-rule"},{"title":"Create Transaction PIN","openapi":"POST /usermanagement/create-transaction-pin","href":"/api/ciam/create-transaction-pin"},{"title":"Create Customer","openapi":"POST /usermanagement/register-customer","href":"/api/ciam/create-customer"},{"title":"Verify Login OTP","openapi":"POST /securitymanagement/verify-login-otp","href":"/api/ciam/verify-login-otp"},{"title":"Submit CRA Form","openapi":"POST /admin/compliance/submit-cra","href":"/api/ciam/submit-cra"},{"title":"Create User PIN","openapi":"POST /securitymanagement/create-user-pin","href":"/api/ciam/create-user-pin"},{"title":"List Pay Points","openapi":"POST /branches/listpaypoints","href":"/api/ciam/listpaypoints"},{"title":"List Payout Points","openapi":"POST /branches/listpayoutpoints","href":"/api/ciam/listpayoutpoints"},{"title":"Add Default Charge","openapi":"POST /admin/fee-management/add-default-charge","href":"/api/ciam/add-default-charge"},{"title":"Create Connector Instance","openapi":"POST /admin/connector-management/create-connector-instance","href":"/api/ciam/create-connector-instance"},{"title":"Product Payment Details","openapi":"POST /admin/account-product/payment-details","href":"/api/ciam/product-payment-details"},{"title":"List Payment Collectors by Address","openapi":"POST /branches/listpaymentcollectorsbyaddress","href":"/api/ciam/listpaymentcollectorsbyaddress"},{"title":"List Allocated Payout Points","openapi":"POST /branches/listallocatedpayoutpoints","href":"/api/ciam/listallocatedpayoutpoints"},{"title":"Payout Center Branches","openapi":"POST /branches/payoutCenter","href":"/api/ciam/payoutCenter-branches"},{"title":"Documents Required For Transaction","openapi":"POST /complaince/documents-required-for-transaction","href":"/api/ciam/documents-required-for-transaction"},{"title":"Submit KYC Documents","openapi":"POST /documentmanagement/attach-documents","href":"/api/ciam/attach-documents"},{"title":"Initiate Compliance Action","openapi":"GET /compliance/initiate-awaiting-compliance-action/{customer-kyc-record-id}","href":"/api/ciam/initiate-compliance-action"},{"title":"Initiate External KYC Provider","openapi":"POST /compliance/external-provider/initiate","href":"/api/ciam/initiate-external-provider"},{"title":"External Screening Webhook","openapi":"POST /compliance/external-screening/webhooks/{provider-code}","href":"/api/ciam/external-screening-webhook"},{"title":"Verify Contact","openapi":"POST /compliance/external-provider/verify-contact","href":"/api/ciam/verify-contact"},{"title":"OTP Verification","openapi":"GET /securitymanagement/otp-verification/{email}/{verification-code}","href":"/api/ciam/otp-verification"},{"title":"Add KYC Rule","openapi":"POST /admin/compliance/add-kyc-rule","href":"/api/ciam/add-kyc-rule"},{"title":"Delete API Connector Instance","openapi":"DELETE /admin/connector-management/delete-api-connector-instance/{id}","href":"/api/ciam/delete-api-connector-instance"}]},{"group":"Songhai Exchange (Payment Switch)","pages":[{"title":"Change Password","openapi":"PUT /v1/services/usermanagement/change-password/{id}","href":"/api/songhai-exchange/change-password"},{"title":"Generate Token","openapi":"POST /oauth/token","href":"/api/songhai-exchange/generate-token"},{"title":"Exchange Rate","openapi":"POST /gateway/quote","href":"/api/songhai-exchange/exchange-rate"},{"title":"Create Transaction","openapi":"POST /gateway/transaction/banktransfers","href":"/api/songhai-exchange/create-transaction"},{"title":"Check Transaction Status","openapi":"POST /gateway/transaction/checkstatus","href":"/api/songhai-exchange/transaction-status"},{"title":"Client End-of-Day Report","openapi":"POST /gateway/list-end-Of-day-position-report","href":"/api/songhai-exchange/end-of-day-report"},{"title":"Generating Wallet Account Statement","openapi":"POST /v1/services/walletmanagement/walletledgerbyclient/{startDate}/{endDate}/{currency}/","href":"/api/songhai-exchange/wallet-account-statement"},{"title":"Bank Account Validation","openapi":"POST /gateway/v2/account-number-validation","href":"/api/songhai-exchange/bank-account-validation"},{"title":"Mobile Money Creation","openapi":"POST /gateway/v3/transaction/mobilemoney","href":"/api/songhai-exchange/mobile-money-creation"},{"title":"Mobile Money Validation","openapi":"POST /gateway/account-number-validation","href":"/api/songhai-exchange/mobile-money-validation"},{"title":"Domiciliary Account (Account Number)","openapi":"POST /gateway/create-domiciliary-bank-account","href":"/api/songhai-exchange/domiciliary-account-with-account-number"},{"title":"Domiciliary Account (BVN)","openapi":"POST /gateway/create-domiciliary-bank-account-with-bvn","href":"/api/songhai-exchange/domiciliary-account-with-bvn"}]},{"group":"Webhooks \u0026 Events","pages":[{"title":"Webhooks","href":"/api/webhooks"},{"title":"Webhook Security","href":"/api/webhook-security"}]},{"group":"Testing \u0026 Tools","pages":[{"title":"Postman collection","href":"/api/postman-collection"}]}]}]},"basePath":"","title":"Create Transaction - FinCode Platform","deploymentId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","buildId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BtG4DSkw.js","snippetPresets-C1k1xDhp.js","utils-PMJoEt4Y.js","style-to-object-BY3JEAdk.js","utils-DW3Pr7Jq.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DIISLO2w.js","conditional-requirements-CFM0id0Q.js","cloneDeep-BErNCZCm.js","_Uint8Array-f0PCu9f_.js","isObject-FP1Yky1u.js","ApiExamples-OjY-8mqu.js","usePlaygroundInputsStore-B2HS2hUb.js","shallow-DVFuuIDQ.js","isEqual-DG0UKiQC.js","CodeSnippets-Cy6FBgwN.js","CodeSnippet-D1PtG8ed.js","getApiPlaygroundDisplay-Dkx2eNtL.js","Page-C8Cg25if.js","DynamicMarkdown-BvJIe00T.js","SectionHeading-B0rKYV8d.js","icon-yclzBff4.js","MethodPill-DxA11cCF.js","getPastedJson-CpkIDpMk.js","DuplicateIcon-CFCQNJ-D.js","axios-CsQoIw0U.js","Markdown-CK5C-fmV.js","AssistantPageLink-Cw134Dd-.js","dist-3xM3Qrc7.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}