📖
Inyo Developer Portal
  • API REFERENCES
    • Payments Gateway v2
      • Getting started
      • Background
        • System architecture
        • Gateway environment settings
      • Authentication Methods
      • Environments
      • Technical Resources
      • Mitigating Fraud
      • APIs
        • Tokenizing cards
        • Payment
          • Pull Transaction
            • Handling AVS / CVC
            • Handling 3D secure
          • Push Transaction
          • Pull and push in one step
          • Capture
          • Refund
          • Void
          • Get a payment
          • Get a list
        • Webhooks
        • Domain tables
          • Response Code
          • Payment Status
        • Test data
          • Cards
    • Remittances
      • Getting Started
      • Authentication
      • Data Population
        • Country
        • State
        • Banks
        • Payers
        • Settlement Rates
      • Sender
        • Sender Object
        • Register a Sender
        • User Agreement
        • Get Sender by ID
        • Sender Verification
          • ID Documents
            • Expired ID Documents
          • KYC Status
          • KYC Using Widget
          • KYC Using API
            • Get KYC fields
            • Update KYC Information
            • Initiate KYC
            • Get KYC Information
          • Sender Tier Upgrade
        • Sender ID Information
      • Funding Account
        • Add Funding Account
          • OAuth Integration
        • Funding Account Object
        • Get Funding Account
        • Delete Funding Account
      • Recipient
        • Recipient Object
        • Add a Recipient
        • Get Recipient Details
        • Update Recipient
        • Recipient Document
      • Recipient Account
        • Recipient Account Object
        • Add a Recipient Account
        • Get Recipient Account
        • Get Account Information
      • Transaction
        • Transaction Object
        • Get Transaction Limits
        • Create a Transaction
          • 3DS Verification
          • Bonus/Discount
        • Get Transaction Details
        • Cancel Transaction
        • Delivery Request
        • Self-Payout
        • Transaction Invoice
      • Webhooks
        • Subscriptions
          • Subscribe
          • List Subscriptions
          • Pause Subscriptions
          • Remove Subscription
        • Integration
        • Events
      • Widget
        • Widget v1.0
          • Widget v1.0 Types
        • Widget v2.0
      • SANDBOX
        • Test Values
          • Geo-Fencing
          • Sender Verification
          • Funding Account
          • Transaction
  • USE CASE
    • Remittance
Powered by GitBook
On this page
  • Get All Transactions of a Sender
  • Get Transaction by ID
  1. API REFERENCES
  2. Remittances
  3. Transaction

Get Transaction Details

Get All Transactions of a Sender

This API provides the list of all the transactions associated with a particular sender.

GET /v2/senders/{{senderId}}/transactions

ParametersRequest SampleResponse Sample

Field
Required
Type
Description

senderId

Yes

UUID

Sender ID.

curl -X GET {{url}}/v2/senders/{{senderId}}/transactions \
  -H 'Accept: application/json' \
  -H 'X-Client-Id: clientid' \
  -H 'X-Client-Secret: clientsecret'
{
  "results": [
    {
      "id": "string",
      "sender_amount": 0.11,
      "exchange_rate": 0.1111,
      "recipient_amount": 0.01,
      "fee_amount": 0,
      "bonus_amount": 0.00,
      "recipient_currency": "string",
      "funding_source": "BANK",
      "sender_id": "string",
      "sender_funding_account_id": "string",
      "recipient_id": "string",
      "payer_id": 1,
      "payout_method": "CASH_PICKUP",
      "note": "string",
      "remittance_purpose": "string",
      "ip_address": "string",
      "status": "string",
      "delivery_status": "string",
      "reference_number": "string",
      "payout_reference_number" : "string",
      "risk_score": 0
    },
    {
      "id": "string",
      "sender_amount": 0.11,
      "exchange_rate": 0.1111,
      "recipient_amount": 0.01,
      "fee_amount": 0,
      "bonus_amount": 0.00,
      "recipient_currency": "string",
      "funding_source": "CARD",
      "sender_id": "string",
      "sender_funding_account_id": "string",
      "recipient_id": "string",
      "recipient_account_id": "string",
      "payout_method": "BANK_DEPOSIT",
      "note": "string",
      "remittance_purpose": "string",
      "ip_address": "string",
      "status": "HOLD",
      "delivery_status": "HOLD",
      "reference_number": "string",
      "risk_score": 0,
      "three_ds": {
        "enabled": true,
        "status": "VERIFIED"
      },
      "hold_reasons": [
                        {
                          "code": "T002",
                          "message": "Service not supported in the location"
                        }
                      ]
    },
    {
      "id": "string",
      "sender_amount": 0.11,
      "exchange_rate": 0.1111,
      "recipient_amount": 0.01,
      "fee_amount": 0,
      "bonus_amount": 0.00,
      "recipient_currency": "string",
      "funding_source": "CARD",
      "sender_id": "string",
      "sender_funding_account_id": "string",
      "recipient_id": "string",
      "recipient_account_id": "string",
      "payout_method": "WALLET",
      "note": "string",
      "remittance_purpose": "string",
      "ip_address": "string",
      "status": "string",
      "delivery_status": "string",
      "reference_number": "string",
      "risk_score": 0,
      "three_ds": {
        "enabled": true,
        "status": "string"
      },
    },
    {
      "id": "string",
      "sender_amount": 0.11,
      "exchange_rate": 0.1111,
      "recipient_amount": 0.01,
      "fee_amount": 0,
      "bonus_amount": 0.00,
      "recipient_currency": "string",
      "funding_source": "BANK",
      "sender_id": "string",
      "sender_funding_account_id": "string",
      "recipient_id": "string",
      "payer_id": 2,
      "payout_method": "HOME_DELIVERY",
      "note": "string",
      "remittance_purpose": "string",
      "ip_address": "string",
      "status": "string",
      "delivery_status": "string",
      "reference_number": "string",
      "risk_score": 0
    }

  ]
}

Get Transaction by ID

This API can be used to fetch a particular transaction's information.

GET /v2/senders/{{senderId}}/transactions/{{transactionId}}

Field
Required
Type
Description

senderId

Yes

UUID

Sender ID.

transactionId

Yes

UUID

Transaction ID.

curl -X GET {{url}}/v2/senders/{{senderId}}/transactions/{{transactionId}} \
  -H 'Accept: application/json' \
  -H 'X-Client-Id: clientid' \
  -H 'X-Client-Secret: clientsecret'
{
  "id": "string",
  "sender_amount": 0.11,
  "exchange_rate": 0.1111,
  "recipient_amount": 0.01,
  "fee_amount": 0,
  "bonus_amount": 0.00,
  "recipient_currency": "string",
  "sender_id": "string",
  "sender_funding_account_id": "string",
  "funding_source": "string",
  "recipient_id": "string",
  "recipient_account_id": "string",
  "note": "string",
  "remittance_purpose": "string",
  "ip_address": "string",
  "status": "string",
  "delivery_status": "string",
  "reference_number": "string",
  "risk_score": 0,
  "receipt_number": "string",
  "payout_method": "BANK_DEPOSIT",
  "status_history":  [
  { 
  "changed_at": "2023-04-28 05:29:47",  
  "status": "INITIATED" 
  },
  { 
  "changed_at": "2023-04-28 05:31:03",
  "status": "PENDING" 
  },  
  { 
  "changed_at": "2023-04-28 05:31:34",  
  "status": "PROCESSED",  
  "comment": "Transaction completed processing successfully."  
  }
  ],  
  "authorization_code": "053134" 
}
PreviousBonus/DiscountNextCancel Transaction

Last updated 9 months ago