Skip to main content

Find a Transaction


Use this endpoint to retrieve details of a given transaction. This is a GET request.

Headers

    Content-Type String - (Required)
    application-json


    Accept String - (Required)
    application-json


    Authorization String - (Required)
    Bearer {ACCESS_TOKEN} (See Authentication)


Parameters

    transactionId String - (Required)
    ID of the transaction to void.


Returns

    transactionId String
    Your transaction ID.


    transactionType enum
    DEBIG or CREDIT


    customerId String
    Associated Customer ID


    amount object
    Value and currency of the transaction


    clientReferenceId String
    Merchant-generated payment-related ID


    transactionStatus enum
    CREATED or PENDING or AUTHORIZED or SCHEDULED or INITIATED or SUCCEEDED or RETRYABLE_FAILED or TERMINAL_FAILED


    accountDetails object
    Details of associated bank account


    descriptor String
    softDescriptor value passed to Initiate Payment API - appears in customer’s bank statement


    settlementDate Date
    Date when payment is expected to settle


    creationDate Date
    Date when transaction was initiated


    transactionFailureReason String
    If applicable - details why payment failed


Post Request

GET - /v1/transactions
GET Request
1curl --location --request GET '{API_BASE_URL}/v1/transactions/{TRANSACTION_ID}' \
2--header 'Content-Type: application/json' \
3--header 'Accept: application/json' \
4--header 'Authorization: Bearer {ACCESS_TOKEN}' 

Response Body

Response
1{ 
2	"transactionId": "{TRANSACTION_ID}", 
3	"transactionType": "string", 
4	"customerId": "string", 
5	"amount": { 
6		"value": 1, 
7		"currency": "string" 
8	}, 
9	"clientReferenceId": "string", 
10	"transactionStatus": "string", 
11	"accountDetails": { 
12		"financialInstitutionName": "string", "string", 
13		"accountLastFourDigits": "string", 
14		"accountType": "string", 
15		"preferred": boolean
16	}, 
17	"descriptor": "string", 
18	"settlementDate": "2022-05-27T19:27:57.971Z", 
19	"creationDate": "2022-05-27T19:27:57.971Z", 
20	"transactionFailureReason": { 
21		"code": "string", 
22		"description": "string" 
23	} 
24}