LogoLogo
NymCardAPI catalogContact usnFront catalog
  • NYMCARD DOCUMENTATION
  • Get Started
    • nCore API Quick Tutorial
    • API Core Principles
    • Program management
      • Manage documents by APIs
      • User KYB process
      • Necessary parameters per user type
      • User ID verification by SDK
      • User KYC process
    • Issuance
      • Users
      • Cards
    • Issuing Physical Cards
      • Individual card issuance
      • Bulk card issuance
      • Card fulfillment
      • Card PIN management
      • Card replacement
      • Proxy number usage
    • Issuing Virtual Cards
      • Migration of virtual to physical card
    • Funding and transfers
      • Funding
      • Internal funding source
      • External funding source
        • From card
        • From bank account
        • Lean API flow
        • DAPI direct API flow
      • Transfers
      • Western Union APIs
    • Product Management
      • Card product
      • Balance limits
      • Velocity limits
      • Fees
      • Charges
      • Multi-currency
      • Authorization controls
        • Enhancements for MCC list management
    • Transactions
      • Payment ecosystem
      • Transaction lifecycle
      • Transaction types
      • Transaction endpoints scenarios
      • Multi-clearing process
    • Webhooks
      • Introduction to webhooks
      • nCore webhook events
      • Steps to configure a webhook
      • Webhooks samples
      • Webhook changes for simulation
      • Webhooks management
    • Security
      • PCI widget
      • 3D Secure
      • OTP SMS templates
    • Release announcements
      • Embedded Lending Release Notes
      • Changes in the release on 13/07/2023
      • Changes in the release on 23/05/2023
      • Changes in the release on 04/04/2023
  • For developers
    • nCore API catalog
    • nFront API catalog
Powered by GitBook
On this page
  • Search for transactions
  • Retrieve a specific transaction

Was this helpful?

  1. Get Started
  2. Transactions

Transaction endpoints scenarios

PreviousTransaction typesNextMulti-clearing process

Last updated 9 months ago

Was this helpful?

You can use Transactions APIs for performing operations on individual transactions. In particular, Transactions APIs enables you to:

  • Retrieve a list of transactions initiated from a specific card by a specific cardholder at a specific merchants etc..

  • Get a specific transaction record using transaction ID

  • Filter or retrieve a sorted list of transactions related to a specific user, performed at a specific time, specific transaction type or amount etc.

Search for transactions

nCore platform stores all transactions, which were fulfilled earlier. You can search the transactions based on the filter parameters enabled at nCore platform.

Transaction search use cases

  1. If you are preparing some financial statistics specific to merchants, you can call the /transactions:search endpoint to filter all transactions related to a specific merchant identified by the merchant_name parameter.

  2. If you are developing some customer relationship management system, you may have requests to get the list of transactions, conducted by a specific card. In this case, you can call the /transactions:search endpoint and use the card id query parameter to get transactions for the specific card.

  3. If you are developing a mobile application, users may have a possibility to review their transaction history. In this case, you can call the /transactions:search endpoint and use the user_id query parameter to get transactions conducted by a specific user.

Send a POST request to /transactions:search endpoint as shown below to retrieve maximum ten transactions initiated with a specific card which are sorted by a transaction amount in ascending order.

{ "sort_by": "transaction_amount", "order_by": "asc", "limit": 10, "filters": [ { "field": "card_id", "operator": "any_of", "values": [ "z7a3a3f0-63b2-4619-a8d5-a3542188f5a6" ] } ] }

Retrieve a specific transaction

This API call will display to you the full details of any transaction by sending a GET request to /transactions/{id} endpoint, where id is the transaction ID.

Transaction status codes

Below you can find a file with the list of transaction status codes, which can occur:

Webhooks

You can receive information about transactions as they occur by configuring webhooks. Webhooks give a possibility to receive real-time notifications about API events, such as card status change, transactions etc.. Learn more about webhooks in the section.

POST /transactions:search
GET /transactions/{id}
Webhooks
64KB
Status codes.pdf
pdf