Transactions

Transaction management

Get all transactions

get

/api/v1/

/transactions

Retrieve a list of all money transfer transactions across all statuses. Each transaction includes sender, beneficiary, quote, corridor, payout method details, current status, and transaction details.

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for tenant authentication

Responses

200

Successfully retrieved list of transactions with sender, beneficiary, and status details

application/json

get

/transactions

HTTPcURLJavaScriptPython

GET /api/v1/transactions HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

200

Successfully retrieved list of transactions with sender, beneficiary, and status details

[
  {
    "transaction_id": "t1a2b3c4-d5e6-4f7a-8b9c-0d1e2f3a4b5c",
    "sender_id": "s1a2b3c4-d5e6-4f7a-8b9c-0d1e2f3a4b5c",
    "beneficiary_id": "b1a2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "quote_id": "q1a2b3c4-d5e6-4f7a-8b9c-0d1e2f3a4b5c",
    "corridor_id": "c1a2b3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "payout_method_id": "pm1a2b3c-d4e5-4f6a-7b8c-9d0e1f2a3b4c",
    "status": "completed",
    "dst_amount": 185500,
    "created_at": "2025-11-15T09:00:00.000Z",
    "updated_at": "2025-11-15T09:45:00.000Z"
  },
  {
    "transaction_id": "t2b3c4d5-e6f7-4a8b-9c0d-1e2f3a4b5c6d",
    "sender_id": "s2b3c4d5-e6f7-4a8b-9c0d-1e2f3a4b5c6d",
    "beneficiary_id": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
    "quote_id": "q2b3c4d5-e6f7-4a8b-9c0d-1e2f3a4b5c6d",
    "corridor_id": "c2b3c4d5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
    "payout_method_id": "pm2b3c4d-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "status": "processing",
    "dst_amount": 2695,
    "created_at": "2025-11-16T14:20:00.000Z",
    "updated_at": "2025-11-16T14:25:00.000Z"
  }
]

Create transaction

post

/api/v1/

/transactions

Create a new money transfer transaction. Validates that sender, beneficiary, and quote exist. The quote must belong to the specified sender. Transaction details array must include all required fields for the selected payout method (e.g., account_number, bank_code for bank transfers; mobile_network, mobile_number for mobile money). Required fields are determined by payout method requirements and rules based on the destination amount. Initial status is set, and the transaction must be committed separately.

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for tenant authentication

Body

application/json

sender_idstring · min: 1Required

Unique identifier of the sender initiating the transfer

beneficiary_idstring · min: 1Required

Unique identifier of the beneficiary receiving the transfer

quote_idstring · min: 1Required

Unique identifier of the quote. Must belong to the specified sender and not be expired

corridor_idstring · min: 1Required

Unique identifier of the corridor (source to destination country path)

payout_method_idstring · min: 1Required

Unique identifier of the payout method (e.g., bank transfer, mobile money)

dst_amountnumberRequired

Amount to be received in destination currency

Responses

201

Transaction created successfully

application/json

400

Bad request - Invalid input data or transaction details

application/json

401

Unauthorized - Invalid or missing API key

404

Not found - Sender, beneficiary, or quote does not exist

application/json

500

Internal server error

post

/transactions

HTTPcURLJavaScriptPython

POST /api/v1/transactions HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 456

{
  "sender_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "beneficiary_id": "f1e2d3c4-b5a6-4978-8c9d-0e1f2a3b4c5d",
  "quote_id": "c3d4e5f6-a7b8-4c9d-0e1f-2a3b4c5d6e7f",
  "corridor_id": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b",
  "payout_method_id": "b8c9d0e1-f2a3-4b4c-5d6e-7f8a9b0c1d2e",
  "dst_amount": 185500,
  "details": [
    {
      "field_name": "account_number",
      "value": "1234567890"
    },
    {
      "field_name": "bank_code",
      "value": "DFCU"
    },
    {
      "field_name": "account_name",
      "value": "Amina Nakato Musoke"
    }
  ]
}

South Africa to Uganda Bank TransferUganda to South Africa Transfer

{
  "transaction_id": "text",
  "status": "text",
  "created_at": "2025-12-12T09:29:27.291Z",
  "updated_at": null,
  "sender_id": "text",
  "beneficiary_id": "text",
  "quote_id": "text",
  "corridor_id": "text",
  "payout_method_id": "text",
  "details": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Get transaction details

get

/api/v1/

/transactions/{transactionId}

Retrieve transaction details by ID

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for tenant authentication

Path parameters

transactionIdstringRequired

Responses

200

Successfully retrieved transaction details with complete sender, beneficiary, quote, and status information

application/json

404

Not found - Transaction does not exist

application/json

get

/transactions/{transactionId}

HTTPcURLJavaScriptPython

GET /api/v1/transactions/{transactionId} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{
  "transaction_id": "t1a2b3c4-d5e6-4f7a-8b9c-0d1e2f3a4b5c",
  "sender_id": "s1a2b3c4-d5e6-4f7a-8b9c-0d1e2f3a4b5c",
  "beneficiary_id": "b1a2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "quote_id": "q1a2b3c4-d5e6-4f7a-8b9c-0d1e2f3a4b5c",
  "corridor_id": "c1a2b3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "payout_method_id": "pm1a2b3c-d4e5-4f6a-7b8c-9d0e1f2a3b4c",
  "status": "completed",
  "dst_amount": 185500,
  "created_at": "2025-11-15T09:00:00.000Z",
  "updated_at": "2025-11-15T09:45:00.000Z",
  "details": [
    {
      "field_name": "account_number",
      "value": "1234567890"
    },
    {
      "field_name": "bank_code",
      "value": "DFCU"
    },
    {
      "field_name": "account_name",
      "value": "Amina Nakato Musoke"
    }
  ]
}

Get transaction status

get

/api/v1/

/transactions/{transactionId}/status

Retrieve transaction status by ID

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for tenant authentication

Path parameters

transactionIdstringRequired

Responses

200

Successfully retrieved current transaction status and processing details

application/json

404

Not found - Transaction does not exist

application/json

get

/transactions/{transactionId}/status

HTTPcURLJavaScriptPython

GET /api/v1/transactions/{transactionId}/status HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{
  "transaction_id": "t1a2b3c4-d5e6-4f7a-8b9c-0d1e2f3a4b5c",
  "status": "completed",
  "status_message": "Transaction successfully completed",
  "updated_at": "2025-11-15T09:45:00.000Z"
}

Commit transaction

post

/api/v1/

/transactions/{transactionId}/commit

Commit a transaction to process it for actual money transfer. This triggers the transaction to be submitted to the payment provider. Once committed, the transaction status will be updated and webhooks will be triggered as the status changes. Returns the current transaction status.

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for tenant authentication

Path parameters

transactionIdstringRequired

Body

application/json

objectOptional

Responses

200

Transaction committed successfully

application/json

400

Bad request - Transaction cannot be committed or invalid data

401

Unauthorized - Invalid or missing API key

404

Not found - Transaction does not exist

application/json

500

Internal server error

post

/transactions/{transactionId}/commit

HTTPcURLJavaScriptPython

POST /api/v1/transactions/{transactionId}/commit HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "transaction_id": "text",
  "status": "text",
  "updated_at": null
}