Guides

Getting Started

Suggest Edits

Getting Started with Transaction Data

Here's a straightforward guide to setting up your account and initiating transaction data sharing efficiently.

1. Account Creation

Contact us here to get setup with an account.

2. Authentication Setup

You'll receive your API credentials and accountId via email along with our Postman Collection. You can then follow our authentication page to understand how to authenticate with our service.

You can also find the Postman Collection here.

You may find the following guide produced by Postman helpful for setting up your credentials when using the collection: https://learning.postman.com/docs/sending-requests/authorization/oauth-20/.

3. Create your first subaccount

Now you'll need to create a subaccount for your customer or context to keep transactions organized. This helps in managing multiple customers or operational contexts under your account.

You can learn more about subaccounts and how they are used in our system here. 

POST https://api.astrada.co/subaccounts

{
    "name": "{{subaccount_name}}",
    "configurations": {
        "MASTERCARD": {
            "countries": ["USA","CAN","GBR"]
        },
        "VISA": {
            "countries": ["USA","CAN","GBR"]
        }
    }
}

4. Register to receive webhook notifications

In order to be informed of transactions occurring, you'll need to register a URL to receive notifications via webhooks. You'll want to subscribe for the transactionmessage.created event type at this stage by calling the Create Webhook endpoint:

POST https://api.astrada.co/webhooks

{
    "url": "{{webhookURL}}",
    "eventTypes": ["transactionmessage.created"],
    "subaccountId": "{{subaccountId}}",
    "enabled": true
}

5. Transaction Tracking: Card Enrollment

Enroll a payment card to begin transaction tracking.

  • Resources: Access developer resources for API and SDK integration.
  • Web SDK vs. API: Choose between using our Web SDK for frontend integrations or our API for backend integrations.
  • SDK Invocation:
  • API Integration:
    • Create your own card enrollment UI by integrating with our API endpoints. Find a step-by-step guide here.

6. Transaction Data Receival

Receive and manage transaction data.

  • Complete a Transaction: Initiate a transaction via our webstore.
  • Receive the Webhook: Get notifications for transaction message events.
  • Fetch Transactions Messages: You can always fetch any transaction messages using the transactionmessageId and the GET Transaction Message endpoint:
GET https://api.astrada.co/transaction-messages/{transactionMessageId}
  • User Correlation: Match incoming data with user’s CardId to track individual activities.

7. Transaction State Retrieval

Fetch the current state of a transaction by calling the List Transactions endpoint:

GET https://api.astrada.co/transactions

Summary

This guide provides a structured process to integrate your systems with our payment services, from account setup to handling real-time transaction data. Ensure each step is correctly implemented to maximize the efficiency of your payment solutions. For further assistance, refer to our detailed API documentation or contact our support team.

Updated 11 days ago