Skip to Content

API References

For integration, use the following API endpoints based on your environment:

Transaction Status

The Transaction Status Inquiry service allows businesses to check the current status of a specific transaction. This service takes the transaction ID as input and returns detailed information about the transaction, including its status, amount, and currency.

  • API: Public
  • Authentication: Live or test Public Keys
  • Endpoint: /v1/transactions/:transactionId
  • Method: GET

Request Object

The request object for inquiring about a transaction status contains:

  • transactionId: “string” (Required: The Transaction ID)

Example: transaction/33cb972f-9fd7-4ec7-b94b-9a3584965fc8

Response Example (Success)

{ "process": { "id": "string", "createdAt": "2025-05-30T12:56:05.805Z", "updatedAt": "2025-05-30T12:56:05.805Z", "type": "string", "status": "limited", "categoryCode": "string", "categoryName": "string", "categoryImageLink": "string", "requestIdentifier": "string", "requestStatus": "pending", "internalSourceAmount": 0, "internalDestinationAmount": 0, "externalSourceAmount": 0, "externalDestinationAmount": 0, "externalProcessId": "string", "underInvestigation": true, "refundProcess": "string", "txIdToRefund": "string", "sourceCurrency": { "id": "string", "sn": "string", "code": "string", "symbol": "string", "type": "FIAT" }, "destinationCurrency": { "id": "string", "sn": "string", "code": "string", "symbol": "string", "type": "FIAT" } } }

Merchant Wallet Balance

Retrieve the current balance details for a merchant’s wallet.

  • API: Public
  • Authentication: Live or test Public Keys
  • Endpoint: /v1/coins
  • Method: GET

Response Example

{ "coins": [ { "serial": "527301835563", "name": "Test GBP coin", "amount": 10000.0000, "availableAmount": 10000.0000, "futureAmount": 0.0000, "heldAmount": 0.0000, "creditLimit": 0.0000, "currency": { "id": "01967113-89c9-76bc-b03a-e93980d2ce1a", "sn": "GBP", "code": "GBP", "symbol": "£", "type": "FIAT" }, "active": true, "type": "client", "main": true, "accounting": false, "smartCards": [] } ] }
Last updated on