Transactions — Tricsoft Pay Documentation

Overview

Collection and disbursement responses return a payment_id. Store this identifier and use it to retrieve the payment or request its latest transaction status.

Payment identifiers

The response from a collection or disbursement request includes payment_id. Store it with your own external_id so you can reconcile the payment later.

Use the TricsoftPay payment_id, not external_id, when requesting payment details or status.

List transactions

Use GET {{base_url}}/payments to retrieve transactions. Results are paginated and can be filtered by status.

Query parameters

Parameter	Type	Description
page	integer	The page to return. Defaults to 1.
page_size	integer	The number of transactions per page. Defaults to 25.
status	string	Optional. Use pending, successful, or failed.

const { data } = await paymentGateway.get("{{base_url}}/payments", {
  params: { page: 1, page_size: 25, status: "successful" },
});

endpoint, _ := url.Parse("{{base_url}}/payments")
query := endpoint.Query()
query.Set("page", "1")
query.Set("page_size", "25")
query.Set("status", "successful")
endpoint.RawQuery = query.Encode()

req, _ := http.NewRequest(http.MethodGet, endpoint.String(), nil)
req.Header.Set("Authorization", "ApiKey "+apiKeyID+":"+apiSecret)
resp, err := http.DefaultClient.Do(req)

let response = payment_gateway
    .get("{{base_url}}/payments")
    .query(&[
        ("page", "1"),
        ("page_size", "25"),
        ("status", "successful"),
    ])
    .send()
    .await?
    .error_for_status()?;

HttpRequest request = requestBuilder(
        "{{base_url}}/payments?page=1&page_size=25&status=successful")
    .GET()
    .build();
HttpResponse<String> response =
    paymentGateway.send(request, HttpResponse.BodyHandlers.ofString());

var response = await paymentGateway.GetAsync(
    "{{base_url}}/payments?page=1&page_size=25&status=successful"
);
response.EnsureSuccessStatusCode();
var transactions = await response.Content.ReadAsStringAsync();

Get payment details

Use GET {{base_url}}/payments/{payment_id} to retrieve one payment. Replace {payment_id} with the identifier returned when the payment was created.

const paymentId = "payment_id_from_creation_response";
const { data } = await paymentGateway.get(`{{base_url}}/payments/${paymentId}`);

paymentID := "payment_id_from_creation_response"
req, _ := http.NewRequest(
    http.MethodGet,
    "{{base_url}}/payments/"+url.PathEscape(paymentID),
    nil,
)
req.Header.Set("Authorization", "ApiKey "+apiKeyID+":"+apiSecret)
resp, err := http.DefaultClient.Do(req)

let payment_id = "payment_id_from_creation_response";
let response = payment_gateway
    .get(format!("{{base_url}}/payments/{payment_id}"))
    .send()
    .await?
    .error_for_status()?;

String paymentId = "payment_id_from_creation_response";
HttpRequest request = requestBuilder("{{base_url}}/payments/" + paymentId)
    .GET()
    .build();
HttpResponse<String> response =
    paymentGateway.send(request, HttpResponse.BodyHandlers.ofString());

var paymentId = "payment_id_from_creation_response";
var response = await paymentGateway.GetAsync($"{{base_url}}/payments/{paymentId}");
response.EnsureSuccessStatusCode();
var payment = await response.Content.ReadAsStringAsync();

Check transaction status

Use POST {{base_url}}/payments/status with payment_id to retrieve the latest state of a payment.

Request fields

Field	Type	Description
payment_id	string	The TricsoftPay payment identifier returned by the collection or disbursement request.

const paymentId = "payment_id_from_creation_response";
const { data } = await paymentGateway.post("{{base_url}}/payments/status", {
  payment_id: paymentId,
});

payload, _ := json.Marshal(map[string]string{
    "payment_id": "payment_id_from_creation_response",
})
req, _ := http.NewRequest(
    http.MethodPost,
    "{{base_url}}/payments/status",
    bytes.NewReader(payload),
)
req.Header.Set("Authorization", "ApiKey "+apiKeyID+":"+apiSecret)
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)

let response = payment_gateway
    .post("{{base_url}}/payments/status")
    .json(&serde_json::json!({
        "payment_id": "payment_id_from_creation_response"
    }))
    .send()
    .await?
    .error_for_status()?;

String body =
    "{\"payment_id\":\"payment_id_from_creation_response\"}";
HttpRequest request = requestBuilder("{{base_url}}/payments/status")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();
HttpResponse<String> response =
    paymentGateway.send(request, HttpResponse.BodyHandlers.ofString());

var response = await paymentGateway.PostAsJsonAsync(
    "{{base_url}}/payments/status",
    new { payment_id = "payment_id_from_creation_response" }
);
response.EnsureSuccessStatusCode();
var status = await response.Content.ReadAsStringAsync();