Transaction Status

GET https://sandbox.temboplus.com/remittance/{partnerReference}/status

This endpoint allows you to check the current status of a remittance transaction using the partner reference provided in the original remittance request. The response includes comprehensive details about the transaction, including its current status, amounts, fees, and timestamps.

Path Parameters

Name	Type	Description
partnerReference*	string	The unique transaction identifier from the original remittance request

Headers

Name	Type	Description
x-request-id*	string	UUID that must be unique for each request. Used for idempotency and request tracing.
Authorization*	string	Bearer token for authentication. Format: Bearer <token>

Response Fields

Name	Type	Description
transactionId	string	Unique system-generated identifier for the transaction
paymentDate	string	Transaction initiation timestamp in ISO 8601 format
senderCurrency	string	ISO currency code of funds from the remitting partner
senderAmount	number	Amount debited from the remitting partner in sender's currency
receiverCurrency	string	ISO currency code for local disbursement
receiverAmount	number	Amount disbursed to the recipient in local currency
exchangeRate	number	Conversion rate applied between sender and receiver currencies
transactionFee	number	Fee charged for processing the transaction in receiver's currency
transactionAmount	number	Total amount including the principal and fee in receiver's currency
transactionDate	string	The timestamp when the transaction was processed by the receiving institution
receiverAccount	string	Account identifier for fund disbursement (mobile number or bank account)
receiverChannel	string	Disbursement channel type: MOBILE or BANK
institutionCode	string	Financial institution or mobile network operator code
partnerReference	string	Unique transaction identifier from the remitting partner
institutionReference	string	Reference number provided by the receiving financial institution
status	string	Current transaction status (e.g., COMPLETED, FAILED)
statusCode	string	Detailed status code (e.g., PAYMENT_SUCCESS)
statusMessage	string	Human-readable description of the current transaction status
receiptNumber	string	Receipt number for successful transactions
createdAt	string	Timestamp when the transaction was created in the system
updatedAt	string	Timestamp when the transaction was last updated
completedAt	string	Timestamp when the transaction reached a terminal state

200 Success

{
  "transactionId": "550e8400e29b41d4a716446655440000",
  "paymentDate": "2025-02-27T10:56:00Z",
  "senderCurrency": "USD",
  "senderAmount": 100.00,
  "receiverCurrency": "TZS",
  "receiverAmount": 250000.00,
  "exchangeRate": 2500.00,
  "transactionFee": 2500,
  "transactionAmount": 252500.00,
  "transactionDate": "2025-02-18T10:00:00Z",
  "receiverAccount": "255745908755",
  "receiverChannel": "MOBILE",
  "institutionCode": "VODACOM",
  "partnerReference": "HSC8474837-VS83",
  "institutionReference": "58577.55885.93993",
  "status": "COMPLETED",
  "statusCode": "PAYMENT_SUCCESS",
  "statusMessage": "Success",
  "receiptNumber": "RM48474558557",
  "createdAt": "2025-02-18T10:05:00Z",
  "updatedAt": "2025-02-18T10:05:00Z",
  "completedAt": "2025-02-18T10:05:00Z"
}

400 Bad Request

{
  "error": "VALIDATION_ERROR",
  "message": "Invalid request parameters",
  "details": [
    {
      "field": "partnerReference",
      "message": "Invalid format"
    }
  ]
}

403 Unauthorized

{
  "error": "UNAUTHORIZED",
  "message": "Invalid authorization token",
  "requestId": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}

404 Not Found

{
  "error": "NOT_FOUND",
  "message": "Remittance with provided partner reference could not be found",
  "requestId": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}

Curl

curl --request GET \
  --url https://sandbox.temboplus.com/remittance/HSC8474837-VS83/status \
  --header 'Authorization: Bearer YOUR_AUTH_TOKEN' \
  --header 'x-request-id: 550e8400-e29b-41d4-a716-446655440000'

Transaction Status Codes

The transaction status and statusCode fields in the response indicate the current state of the remittance:

Status	Status Code	Description
CREATED	CREATED	Transaction has been created in the system but not yet submitted to the provider
SUBMITTED	SUBMITTED	Transaction has been submitted to the provider for processing
WAITING_ACK	WAITING_ACK	Transaction is awaiting acknowledgment from the provider
COMPLETED	PAYMENT_SUCCESS	Transaction has been successfully processed
FAILED	PAYMENT_FAILED	Transaction failed to process (general failure)
FAILED	INSUFFICIENT_BALANCE	Transaction failed due to insufficient balance
FAILED	PROVIDER_FAILURE	Transaction failed due to an issue with the provider
FAILED	INVALID_ACCOUNT	Transaction failed because the provided receiverAccount is invalid or not found
REVERSED	REVERSED	Transaction was processed but later reversed
CANCELED	PAYMENT_CANCELED	Transaction was canceled before processing was completed