Create Transaction (Direct)

Initiate a new remittance transaction providing full sender and recipient KYC details inline.

POST /transactionmanagement/create-transaction

Create Transaction (Direct)

cURL

curl --request POST \
  --url https://{tenant}.fincode.software/api/v6/services/transactionmanagement/create-transaction/ \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <x-auth-token>' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --header 'ipAddress: <ipaddress>' \
  --header 'password: <password>' \
  --header 'platform: <platform>' \
  --header 'uuid: <uuid>' \
  --data '
{
  "amount": "24.240",
  "sendAmount": "7.000",
  "inclussive": true,
  "receivingCurrency": "NGN",
  "sendCurrency": "GBP",
  "type": "ACCOUNTPAYMENT",
  "creditParty": [
    {
      "key": "bankname",
      "value": "Anelik Bank CJSC"
    },
    {
      "key": "bankaccountno",
      "value": "87787786778"
    },
    {
      "key": "swiftbic",
      "value": "2345"
    },
    {
      "key": "bankcode",
      "value": ""
    },
    {
      "key": "branchcode",
      "value": null
    }
  ],
  "internationalTransferInformation": {
    "originCountry": "GBR",
    "receivingCountry": "NGA",
    "sourceOfFunds": "SAVINGS",
    "remittancePurpose": "GIFT",
    "relationshipSender": "<string>",
    "deliveryMethod": "directtoaccount"
  },
  "newSenderKyc": {
    "nationality": "Nigeria",
    "dateOfBirth": "2000-05-14",
    "occupation": "Software Engineer",
    "employerName": "TechWave Ltd",
    "contactPhone": "[phone]",
    "gender": "MALE",
    "CustomerType": "INDIVIDUAL",
    "emailAddress": "[e-mail]",
    "birthCountry": "GBR",
    "idDocument": [
      {
        "idType": "PASSPORT",
        "idNumber": "A12345678",
        "issueDate": "10-02-2018T00:00:00.000",
        "expiryDate": "09-02-2028T00:00:00.000",
        "dateOfBirth": "14-05-1990T00:00:00.000",
        "issuer": "Nigeria Immigration Service",
        "issuerPlace": "Lagos",
        "issuerCountry": "NGA",
        "otherIdDescription": "<string>",
        "fileName": "Passport",
        "base64FileData": "<string>"
      }
    ],
    "postalAddressObject": {
      "addressLine1": "12 Adeola Odeku Street",
      "addressLine2": "Block A",
      "addressLine3": "Victoria Island",
      "city": "Lagos",
      "stateProvince": "Lagos State",
      "postalCode": "101241",
      "iso3country": "NGA"
    },
    "subjectNameObject": {
      "title": "Mr",
      "firstName": "John",
      "middleName": "Chinedu",
      "lastName": "Okafor",
      "fullName": "John Chinedu Okafor",
      "nativeName": "John C. Okafor"
    }
  },
  "newRecipientKyc": {
    "nationality": "Ghana",
    "dateOfBirth": "2000-09-21",
    "occupation": "Accountant",
    "employerName": "Golden Finance Ltd",
    "contactPhone": "[phone]",
    "gender": "FEMALE",
    "CustomerType": "INDIVIDUAL",
    "emailAddress": "[e-mail]",
    "birthCountry": "NGA",
    "companyReg": "RC-458921",
    "idDocument": [
      {
        "idType": "NATIONAL_ID_CARD",
        "idNumber": "GF123456789",
        "issueDate": "15-01-2019T00:00:00.000",
        "expiryDate": "14-01-2029T00:00:00.000",
        "dateOfBirth": "21-09-1985T00:00:00.000",
        "issuer": "Registrar General",
        "issuerPlace": "Accra",
        "issuerCountry": "GHA",
        "otherIdDescription": "<string>",
        "fileName": "National Id Card",
        "base64FileData": "<string>"
      }
    ],
    "postalAddressObject": {
      "addressLine1": "14 Independence Avenue",
      "addressLine2": "Suite 10",
      "addressLine3": "Accra Central",
      "city": "Accra",
      "stateProvince": "Greater Accra",
      "postalCode": "GA-002-1234",
      "iso3country": "GHA"
    },
    "subjectName": {
      "title": "Ms",
      "firstName": "Ama",
      "middleName": "Serwaa",
      "lastName": "Mensah",
      "fullName": "Ama Serwaa Mensah",
      "nativeName": "Ama S. Mensah"
    }
  },
  "transactionProcessingMode": "NONE_AGGREGATION",
  "descriptionText": "<string>",
  "transactionModule": "REMITTANCE",
  "securityQuestion": "<string>",
  "securityAnswer": "<string>",
  "eligibleDocumentList": [
    {}
  ]
}
'

Transaction Only Flow

Initiates a new transaction where you provide the full KYC details for both the sender and the recipient within the transaction payload.

This endpoint is ideal for integrations where you manage your own customer data and do not wish to sync it beforehand using the User Management APIs.

Headers

platform · string · default: fincode · required

uuid · string · default: 200 · required

X-Auth-Token · string · required

password · string · required

ipAddress · string · required

X-Idempotency-Key · string · required

Body

application/json

amount · string · required

The receive amount (what the recipient gets).

Example:

"24.240"

sendAmount · string · required

The send amount (what the sender pays, excluding fees).

Example:

"7.000"

inclussive · boolean · required

Whether fees are included in the send amount.

Example:

true

receivingCurrency · string · default: NGN · required

ISO 4217 currency code for the receiving currency.

sendCurrency · string · default: GBP · required

ISO 4217 currency code for the sending currency.

type · enum<string> · default: ACCOUNTPAYMENT · required

Transaction type. Use ACCOUNTPAYMENT for direct bank account transfers, CASHPICKUP for cash collection at a designated pickup point, or MOBILE_MONEY for delivery to a mobile wallet.

Available options: ACCOUNTPAYMENT, CASHPICKUP, MOBILE_MONEY

creditParty · object[] · required

Key-value pairs describing the recipient's bank/account details.

Show child attributes

Example:

[
  {
    "key": "bankname",
    "value": "Anelik Bank CJSC"
  },
  {
    "key": "bankaccountno",
    "value": "87787786778"
  },
  { "key": "swiftbic", "value": "2345" },
  { "key": "bankcode", "value": "" },
  { "key": "branchcode", "value": null }
]

internationalTransferInformation · object · required

Regulatory and routing information for the international transfer.

Show child attributes

newSenderKyc · object · required

Full KYC profile for the sender.

Show child attributes

newRecipientKyc · object · required

Full KYC profile for the recipient.

Show child attributes

transactionProcessingMode · string · default: NONE_AGGREGATION

Aggregation mode for the transaction.

descriptionText · string

Optional free-text description or reference for the transaction.

transactionModule · string · default: REMITTANCE

Module under which the transaction is processed.

securityQuestion · string

Security question for cash pickup transactions. Leave empty for account payments.

securityAnswer · string

Answer to the security question. Leave empty for account payments.

eligibleDocumentList · object[]

List of eligible documents attached to this transaction. Pass an empty array if none.

Response

200

Transaction created