Transactions

Here we have the APIs which will help us with the management of transactions.

Get By Reference

This endpoint provides the capability to get transactions by our system-generated transaction reference.

URL

{baseUrl}/developer/loadtransactionbytxref?txRef=

REQUEST

curl --location --request GET 
'{baseUrl}/developer/loadtransactionbytxref?txRef=SSP638486096826968883093D' \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer_token'

SUCCESS RESPONSE

{
    "ResponseCode": "00",
    "ResponseMessage": "Successful",
    "Data": [
        {
            "Id": 13393,
            "TxRef": "SSP638486096826968883093D",
            "Amount": 6500.0000,
            "Fee": 6.0000,
            "SourceCurrency": "USD",
            "TargetCurrency": "USD",
            "ChargedAmount": 6506.0000,
            "Rate": 1.0000,
            "Status": "Pending",
            "DateCreated": "2024-04-13T12:57:44",
            "DateUpdated": "2024-04-13T12:57:44",
            "RecipientId": -1,
            "OwnerId": 1,
            "SecurityQuestion": "",
            "SecurityAnswer": "",
            "ChargeRoute": "FullCard",
            "BatchId": null,
            "TransactionType": null,
            "Spread": 0.0000
        }
    ]
}

FAILED RESPONSE

{
    "ResponseCode": "03",
    "ResponseMessage": "No data available",
    "Data": null
}

Get By User Reference

This endpoint provides the capability to get transactions by user-generated transaction reference.

URL

{baseUrl}/developer/loadtransactionbyuserreference?userReference=

REQUEST

curl --location --request GET 
'{baseUrl}/developer/loadtransactionbyuserreference?userReference=ORD-5023-4E89' \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer_token'

SUCCESS RESPONSE

{
    "ResponseCode": "00",
    "ResponseMessage": "Successful",
    "Data": [
        {
            "Id": 13393,
            "TxRef": "SSP638486096826968883093D",
            "Amount": 6500.0000,
            "Fee": 6.0000,
            "SourceCurrency": "USD",
            "TargetCurrency": "USD",
            "ChargedAmount": 6506.0000,
            "Rate": 1.0000,
            "Status": "Pending",
            "DateCreated": "2024-04-13T12:57:44",
            "DateUpdated": "2024-04-13T12:57:44",
            "RecipientId": -1,
            "OwnerId": 1,
            "SecurityQuestion": "",
            "SecurityAnswer": "",
            "ChargeRoute": "FullCard",
            "BatchId": null,
            "TransactionType": null,
            "Spread": 0.0000
        }
    ]
}

FAILED RESPONSE

{
    "ResponseCode": "03",
    "ResponseMessage": "No data available",
    "Data": null
}

Get User Transactions

This endpoint provides the capability to get all user transactions

URL

{baseUrl}/developer/loadusertransactions

REQUEST

curl --location --request GET 
'{baseUrl}/developer/loadusertransactions' \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer_token'

SUCCESS RESPONSE

{
    "ResponseCode": "00",
    "ResponseMessage": "Successful",
    "Data": [
        {
            "Id": 99,
            "TxRef": "SSP637544564180150664",
            "Amount": 100.0000,
            "Fee": 5.0000,
            "SourceCurrency": "USD",
            "TargetCurrency": "USD",
            "ChargedAmount": 105.0000,
            "Rate": 1.0000,
            "Status": "Disbursed",
            "DateCreated": "2021-04-19T19:13:38",
            "DateUpdated": "2021-04-19T19:13:38",
            "RecipientId": 32,
            "OwnerId": 1,
            "SecurityQuestion": null,
            "SecurityAnswer": null,
            "ChargeRoute": null,
            "BatchId": null,
            "TransactionType": null,
            "Spread": null,
            "RecipientName": "Test  Barter",
            "PaymentType": "vdom",
            "IsRecurring": 0
        },
        {
            "Id": 100,
            "TxRef": "SSP637544567218779238",
            "Amount": 52.0814,
            "Fee": 5.0000,
            "SourceCurrency": "USD",
            "TargetCurrency": "GHS",
            "ChargedAmount": 57.0814,
            "Rate": 5.3344,
            "Status": "Charged",
            "DateCreated": "2021-04-19T19:18:42",
            "DateUpdated": "2021-04-19T19:18:42",
            "RecipientId": 35,
            "OwnerId": 1,
            "SecurityQuestion": null,
            "SecurityAnswer": null,
            "ChargeRoute": null,
            "BatchId": null,
            "TransactionType": null,
            "Spread": null,
            "RecipientName": "Test  Mobile Ghana",
            "PaymentType": "mobile",
            "IsRecurring": 0
        },
        {
            "Id": 101,
            "TxRef": "SSP637544578665876461",
            "Amount": 62.4977,
            "Fee": 5.0000,
            "SourceCurrency": "USD",
            "TargetCurrency": "GHS",
            "ChargedAmount": 69.0131,
            "Rate": 5.3344,
            "Status": "Charged",
            "DateCreated": "2021-04-19T19:37:46",
            "DateUpdated": "2021-04-19T19:37:46",
            "RecipientId": 35,
            "OwnerId": 1,
            "SecurityQuestion": null,
            "SecurityAnswer": null,
            "ChargeRoute": null,
            "BatchId": null,
            "TransactionType": null,
            "Spread": null,
            "RecipientName": "Test  Mobile Ghana",
            "PaymentType": "mobile",
            "IsRecurring": 0
        }
    ]
}

FAILED RESPONSE

{
    "ResponseCode": "03",
    "ResponseMessage": "No data available",
    "Data": null
}