Skip to main content
This endpoint is used to inspect the current state of a payout or quote conversion. It returns the original quote details, recipient information, state transitions, and timestamps to support reconciliation.

​
Endpoint

GET {{baseURL}}/v1/transaction/{transactionId}

​
Request headers

HeaderDescriptionRequiredExample
x-api-keyWorkspace API key for authentication.✅ YesYOUR_API_KEY
Content-TypeMedia type of the request.✅ Yesapplication/json

​
Request examples

curl --request GET '{{baseURL}}/v1/transaction/8c684c17-ef91-4133-a624-xxxxxxxxxxxxx' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json'

​
Successful response

copy
{
  "message": "transaction fetched successfully",
  "status": "success",
  "data": {
    "id": "8c684c17-ef91-4133-a624-xxxxxxxxxxxxx",
    "remark": "Tested",
    "reason": "Gift",
    "referenceNumber": "W1TDB6RWSQMKF",
    "type": "SEND",
    "state": "COMPLETED",
    "quote": {
      "id": "b39b64b9-3ca0-4566-b66b-xxxxxxxxxxxxx",
      "source": {
        "currency": "NGN",
        "country": "NG",
        "amount": 15000
      },
      "target": {
        "currency": "USD",
        "country": "US",
        "amount": 100
      },
      "rate": 1500,
      "fee": {
        "amount": 100
      }
    },
    "recipient": {
      "name": "John Doe",
      "firstName": "John",
      "lastName": "Doe",
      "relationship": "SELF",
      "type": "BANK",
      "account": {
        "sortCode": "058",
        "accountNumber": "86123435XXXXX",
        "branchCode": "",
        "mobileProvider": ""
      },
      "paymentChannel": "BANK_TRANSFER",
      "currency": "NGN",
      "country": "NG"
    },
    "created": "2024-02-27T14:17:48.038Z",
    "processed": "2024-02-27T14:20:49.712Z"
  }
}

​
Field reference

FieldTypeDescription
data.idStringUnique transaction identifier.
data.stateStringCurrent processing state (e.g. PENDING, COMPLETED, FAILED).
data.referenceNumberStringmeCash-generated reference for reconciliation.
data.quoteObjectQuote snapshot used to execute the payout.
data.recipientObjectBeneficiary information used during disbursement.
data.createdStringTimestamp (ISO 8601) when the transaction was created.
data.processedStringTimestamp for the latest state change.

​
Error responses

StatusMeaningExample messageNext steps
400Transaction not found or invalid ID.Transaction does not existConfirm the identifier and ensure the payout was created successfully.
401Authentication failed.Invalid API keyVerify the x-api-key header.
403IP not whitelisted.Access denied: IP address not whitelistedAdd your server IP under Developers → IP Whitelisting.
422Invalid parameter.Invalid parameterCheck that the transactionId is a valid UUID.
429Too many requests.Too many requestsAdd exponential backoff before retrying.
500Server error.Internal server errorRetry later or contact support if persistent.

​
Usage tips

  • Call this endpoint after receiving payout webhooks to verify the final state and amounts.
  • Persist transaction responses for audit trails; they include the original quote snapshot.
  • If the transaction remains PROCESSING for longer than expected, reach out to support with the referenceNumber for investigation.