Retrieving a Payout

This page provides a way to retrieve the payout details, with each example illustrating different possible values and structures for payout transactions, including successful, pending, and failed transactions, as well as the available enum values for transaction status, payment methods, and flow types.

API Endpoint

GET https://${host}/api/v1/payouts/apm/info/{id}

{id} path parameter: The transactionId of the payout whose details you want to retrieve.

Payout Success Response Example

The response structure for this endpoint mirrors the data sent. It will include fields
such as:

Field	Description
`transactionId`	Unique identifier for the transaction (maps to `txId` in the class).
`requestId`	Unique identifier for the request.
`accountId`	Account identifier is a long number.
`transactionStatus`	Status of the transaction (maps to `status` in the class).
`declineCode`	Code indicating the reason for decline (null if not declined).
`declineSubReason`	Additional information about the reason.
`apmRequestPayload`	Object containing payment request details (method, type, account info, amount, etc.).
`apmResponseData`	Object containing payment response details (method, type, provider transaction ID, status, etc.).
`callbackUrl`	URL to be called with transaction updates (webhook callback).
`billingDetails`	Billing information for the transaction (maps to `billingData` in the class).
`order`	Order information related to the payout.
`createdAt`	Timestamp when the transaction was created (ISO 8601 format).

Basic JSON Example

The basic example below shows a successful payout transaction. This includes details like transaction and request IDs, account information, status, and both the request payload and response data for the payout:

{
  "transactionId": "tx-123456789",
  "requestId": "req-987654321",
  "accountId": 12345678,
  "transactionStatus": "SUCCEED",
  "declineCode": null,
  "declineSubReason": null,
  "apmRequestPayload": {
    "paymentMethod": "NAGINI_PAYOUT",
    "paymentType": "BANK_TRANSFER",
    "accountNumber": "1234567890",
    "accountHolderName": "John Doe",
    "bankCode": "ABCDEF",
    "bankName": "Example Bank",
    "amount": 100.50,
    "currency": "USD",
    "description": "Payout for services"
  },
  "apmResponseData": {
    "paymentMethod": "NAGINI_PAYOUT",
    "paymentType": "BANK_TRANSFER",
    "redirectUrl": null,
    "iframeUrl": null,
    "providerTransactionId": "provider-tx-123456",
    "status": "COMPLETED",
    "statusDescription": "Payout processed successfully",
    "processingTime": "2025-08-06T09:28:00Z"
  },
  "callbackUrl": "https://example.com/callbacks/payouts",
  "billingDetails": {
    "externalUserId": "user-123456",
    "firstName": "John",
    "lastName": "Doe",
    "address1": "123 Main St",
    "city": "New York",
    "state": "NY",
    "country": "US",
    "postalCode": "10001",
    "phone": "+12125551234",
    "email": "[email protected]",
    "dateOfBirth": "1980-01-01",
    "ssn": "123-45-6789",
    "identityCode": "ID12345"
  },
  "order": {
    "date": "2025-08-06T09:28:00Z",
    "orderId": "order-123456",
    "title": "Monthly Payout",
    "siteId": "site-789",
    "name": "August Payout",
    "domainName": "payouts.example.com"
  },
  "createdAt": "2025-08-06T09:28:00Z"
}

Enum Values

There are several enums associated with the payout transaction info. Below are the possible values for each relevant enum:

TxStatus

[
  "NEW",
  "PENDING",
  "FAILED",
  "REFUNDED",
  "CUSTOMER_VERIFICATION",
  "SUCCEED",
  "BLOCKED",
  "PROCESSING",
  "CHARGEBACK"
]

ApmMethod

[
  "PAYPAL",
  "IDEAL",
  "GOOGLE_PAY",
  "APPLE_PAY",
  "EXTERNAL_HPP_GOOGLE_PAY",
  "EXTERNAL_HPP_APPLE_PAY",
  "NAGINI",
  "NAGINI_PAYOUT",
  "PAPARA",
  "TK_PAY",
  "TK_PAY_PAYOUT",
  "TK_PAY_QR",
  "PAYYD",
  "PAYYD_PAYOUT",
  "SMART_E_WALLET",
  "SMART_MOBILE_WALLET",
  "SMART_BANK_TRANSFER",
  "SMART_VOUCHER",
  "SMART_QR",
  "SMART_BNPL",
  "SMART_CARRIER_BILLING",
  "SMART_APM",
  "SMART_BANK_TRANSFER_PAYOUT"
]

ApmFlowType

[
  "BANK_TRANSFER",
  "CARD_PAYMENT",
  "E_WALLET",
  "MOBILE_WALLET",
  "CASH",
  "VOUCHER",
  "CARRIER_BILLING",
  "BNPL"
]

Additional Examples

Below are additional JSON examples demonstrating different transaction statuses and scenarios:

Example with PENDING Status

This example represents a payout transaction that is still in progress (pending). Notice that the transactionStatus is PENDING, and the apmResponseData.status is IN_PROGRESS, indicating the payout is being processed. A redirectUrl is provided in this case for checking the status:

{
  "transactionId": "tx-987654321",
  "requestId": "req-123456789",
  "accountId": 87654321,
  "transactionStatus": "PENDING",
  "declineCode": null,
  "declineSubReason": null,
  "apmRequestPayload": {
    "paymentMethod": "SMART_BANK_TRANSFER_PAYOUT",
    "paymentType": "BANK_TRANSFER",
    "accountNumber": "9876543210",
    "accountHolderName": "Jane Smith",
    "bankCode": "XYZABC",
    "bankName": "Smart Bank",
    "amount": 250.75,
    "currency": "EUR",
    "description": "Vendor payment"
  },
  "apmResponseData": {
    "paymentMethod": "SMART_BANK_TRANSFER_PAYOUT",
    "paymentType": "BANK_TRANSFER",
    "redirectUrl": "https://smartbank.example.com/status",
    "iframeUrl": null,
    "providerTransactionId": "smart-tx-789012",
    "status": "IN_PROGRESS",
    "statusDescription": "Payment is being processed",
    "processingTime": "2025-08-06T09:30:00Z"
  },
  "callbackUrl": "https://example.com/callbacks/smart-payouts",
  "billingDetails": {
    "externalUserId": "vendor-789012",
    "firstName": "Jane",
    "lastName": "Smith",
    "address1": "456 Business Ave",
    "city": "London",
    "state": null,
    "country": "GB",
    "postalCode": "EC1A 1BB",
    "phone": "+442071234567",
    "email": "[email protected]",
    "dateOfBirth": "1985-05-15",
    "ssn": null,
    "identityCode": "GB98765432"
  },
  "order": {
    "date": "2025-08-06T09:29:00Z",
    "orderId": "order-789012",
    "title": "Vendor Payment",
    "siteId": "site-456",
    "name": "August Vendor Payment",
    "domainName": "vendors.example.com"
  },
  "createdAt": "2025-08-06T09:29:30Z"
}

Example with FAILED Status

This example represents a payout transaction that failed. Here, transactionStatus is FAILED, and there are non-null values for declineCode and declineSubReasonProviding information about why the transaction failed. In the apmResponseData, the status is FAILED with a description explaining the failure reason:

{
  "transactionId": "tx-456789123",
  "requestId": "req-654321987",
  "accountId": 45678912,
  "transactionStatus": "FAILED",
  "declineCode": 1005,
  "declineSubReason": "INSUFFICIENT_FUNDS",
  "apmRequestPayload": {
    "paymentMethod": "PAYYD_PAYOUT",
    "paymentType": "BANK_TRANSFER",
    "accountNumber": "5678901234",
    "accountHolderName": "Alex Johnson",
    "bankCode": "PAYYD123",
    "bankName": "PayYD Bank",
    "amount": 500.00,
    "currency": "USD",
    "description": "Affiliate payout"
  },
  "apmResponseData": {
    "paymentMethod": "PAYYD_PAYOUT",
    "paymentType": "BANK_TRANSFER",
    "redirectUrl": null,
    "iframeUrl": null,
    "providerTransactionId": "payyd-tx-345678",
    "status": "FAILED",
    "statusDescription": "Insufficient funds in merchant account",
    "processingTime": "2025-08-06T09:31:00Z"
  },
  "callbackUrl": "https://example.com/callbacks/affiliate-payouts",
  "billingDetails": {
    "externalUserId": "affiliate-345678",
    "firstName": "Alex",
    "lastName": "Johnson",
    "address1": "789 Partner St",
    "city": "Berlin",
    "state": null,
    "country": "DE",
    "postalCode": "10115",
    "phone": "+4930123456789",
    "email": "[email protected]",
    "dateOfBirth": "1990-10-20",
    "ssn": null,
    "identityCode": "DE87654321"
  },
  "order": {
    "date": "2025-08-06T09:30:30Z",
    "orderId": "order-345678",
    "title": "Affiliate Payout",
    "siteId": "site-123",
    "name": "August Affiliate Payout",
    "domainName": "affiliates.example.com"
  },
  "createdAt": "2025-08-06T09:30:45Z"
}

Notes

The mid field is not included in the JSON output, as it is derived from accountId.toString() in the class.
Different payment methods may have different fields in their apmRequestPayload and apmResponseData objects (the examples above cover common fields).
All date/time fields use ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).
Optional fields can be null if not applicable or not provided.

Complete JSON Examples

For completeness, below are some comprehensive JSON representations that include all parts of the ApmPayoutTxInfoDto and the related enum values:

Example JSON (including themid field for reference):

{
  "transactionId": "tx-123456789",
  "requestId": "req-987654321",
  "accountId": 12345678,
  "transactionStatus": "SUCCEED",
  "declineCode": null,
  "declineSubReason": null,
  "apmRequestPayload": {
    "paymentMethod": "NAGINI_PAYOUT",
    "paymentType": "BANK_TRANSFER",
    "accountNumber": "1234567890",
    "accountHolderName": "John Doe",
    "bankCode": "ABCDEF",
    "bankName": "Example Bank",
    "amount": 100.50,
    "currency": "USD",
    "description": "Payout for services"
  },
  "apmResponseData": {
    "paymentMethod": "NAGINI_PAYOUT",
    "paymentType": "BANK_TRANSFER",
    "redirectUrl": null,
    "iframeUrl": null,
    "providerTransactionId": "provider-tx-123456",
    "status": "COMPLETED",
    "statusDescription": "Payout processed successfully",
    "processingTime": "2025-08-06T09:28:00Z"
  },
  "callbackUrl": "https://example.com/callbacks/payouts",
  "billingDetails": {
    "externalUserId": "user-123456",
    "firstName": "John",
    "lastName": "Doe",
    "address1": "123 Main St",
    "city": "New York",
    "state": "NY",
    "country": "US",
    "postalCode": "10001",
    "phone": "+12125551234",
    "email": "[email protected]",
    "dateOfBirth": "1980-01-01",
    "ssn": "123-45-6789",
    "identityCode": "ID12345"
  },
  "order": {
    "date": "2025-08-06T09:28:00Z",
    "orderId": "order-123456",
    "title": "Monthly Payout",
    "siteId": "site-789",
    "name": "August Payout",
    "domainName": "payouts.example.com"
  },
  "createdAt": "2025-08-06T09:28:00Z",
  "mid": "12345678"
}

Combined JSON example with multiple scenarios and enum lists: (comments added for clarity within JSON)

{
  "// Main example for ApmPayoutTxInfoDto": "This is a comprehensive example of the ApmPayoutTxInfoDto class with all fields",
  "// Example 1: NAGINI_PAYOUT with BANK_TRANSFER": {
    "transactionId": "tx-123456789",
    "requestId": "req-987654321",
    "accountId": 12345678,
    "transactionStatus": "SUCCEED",
    "declineCode": null,
    "declineSubReason": null,
    "apmRequestPayload": {
      "paymentMethod": "NAGINI_PAYOUT",
      "paymentType": "BANK_TRANSFER",
      "accountNumber": "1234567890",
      "accountHolderName": "John Doe",
      "bankCode": "ABCDEF",
      "bankName": "Example Bank",
      "amount": 100.50,
      "currency": "USD",
      "description": "Payout for services"
    },
    "apmResponseData": {
      "paymentMethod": "NAGINI_PAYOUT",
      "paymentType": "BANK_TRANSFER",
      "redirectUrl": null,
      "iframeUrl": null,
      "providerTransactionId": "provider-tx-123456",
      "status": "COMPLETED",
      "statusDescription": "Payout processed successfully",
      "processingTime": "2025-08-06T09:28:00Z"
    },
    "callbackUrl": "https://example.com/callbacks/payouts",
    "billingDetails": {
      "externalUserId": "user-123456",
      "firstName": "John",
      "lastName": "Doe",
      "address1": "123 Main St",
      "city": "New York",
      "state": "NY",
      "country": "US",
      "postalCode": "10001",
      "phone": "+12125551234",
      "email": "[email protected]",
      "dateOfBirth": "1980-01-01",
      "ssn": "123-45-6789",
      "identityCode": "ID12345"
    },
    "order": {
      "date": "2025-08-06T09:28:00Z",
      "orderId": "order-123456",
      "title": "Monthly Payout",
      "siteId": "site-789",
      "name": "August Payout",
      "domainName": "payouts.example.com"
    },
    "createdAt": "2025-08-06T09:28:00Z"
  },

  "// Example 2: SMART_BANK_TRANSFER_PAYOUT with BANK_TRANSFER": {
    "transactionId": "tx-987654321",
    "requestId": "req-123456789",
    "accountId": 87654321,
    "transactionStatus": "PENDING",
    "declineCode": null,
    "declineSubReason": null,
    "apmRequestPayload": {
      "paymentMethod": "SMART_BANK_TRANSFER_PAYOUT",
      "paymentType": "BANK_TRANSFER",
      "accountNumber": "9876543210",
      "accountHolderName": "Jane Smith",
      "bankCode": "XYZABC",
      "bankName": "Smart Bank",
      "amount": 250.75,
      "currency": "EUR",
      "description": "Vendor payment"
    },
    "apmResponseData": {
      "paymentMethod": "SMART_BANK_TRANSFER_PAYOUT",
      "paymentType": "BANK_TRANSFER",
      "redirectUrl": "https://smartbank.example.com/status",
      "iframeUrl": null,
      "providerTransactionId": "smart-tx-789012",
      "status": "IN_PROGRESS",
      "statusDescription": "Payment is being processed",
      "processingTime": "2025-08-06T09:30:00Z"
    },
    "callbackUrl": "https://example.com/callbacks/smart-payouts",
    "billingDetails": {
      "externalUserId": "vendor-789012",
      "firstName": "Jane",
      "lastName": "Smith",
      "address1": "456 Business Ave",
      "city": "London",
      "state": null,
      "country": "GB",
      "postalCode": "EC1A 1BB",
      "phone": "+442071234567",
      "email": "[email protected]",
      "dateOfBirth": "1985-05-15",
      "ssn": null,
      "identityCode": "GB98765432"
    },
    "order": {
      "date": "2025-08-06T09:29:00Z",
      "orderId": "order-789012",
      "title": "Vendor Payment",
      "siteId": "site-456",
      "name": "August Vendor Payment",
      "domainName": "vendors.example.com"
    },
    "createdAt": "2025-08-06T09:29:30Z"
  },

  "// Example 3: PAYYD_PAYOUT with failed status": {
    "transactionId": "tx-456789123",
    "requestId": "req-654321987",
    "accountId": 45678912,
    "transactionStatus": "FAILED",
    "declineCode": 1005,
    "declineSubReason": "INSUFFICIENT_FUNDS",
    "apmRequestPayload": {
      "paymentMethod": "PAYYD_PAYOUT",
      "paymentType": "BANK_TRANSFER",
      "accountNumber": "5678901234",
      "accountHolderName": "Alex Johnson",
      "bankCode": "PAYYD123",
      "bankName": "PayYD Bank",
      "amount": 500.00,
      "currency": "USD",
      "description": "Affiliate payout"
    },
    "apmResponseData": {
      "paymentMethod": "PAYYD_PAYOUT",
      "paymentType": "BANK_TRANSFER",
      "redirectUrl": null,
      "iframeUrl": null,
      "providerTransactionId": "payyd-tx-345678",
      "status": "FAILED",
      "statusDescription": "Insufficient funds in merchant account",
      "processingTime": "2025-08-06T09:31:00Z"
    },
    "callbackUrl": "https://example.com/callbacks/affiliate-payouts",
    "billingDetails": {
      "externalUserId": "affiliate-345678",
      "firstName": "Alex",
      "lastName": "Johnson",
      "address1": "789 Partner St",
      "city": "Berlin",
      "state": null,
      "country": "DE",
      "postalCode": "10115",
      "phone": "+4930123456789",
      "email": "[email protected]",
      "dateOfBirth": "1990-10-20",
      "ssn": null,
      "identityCode": "DE87654321"
    },
    "order": {
      "date": "2025-08-06T09:30:30Z",
      "orderId": "order-345678",
      "title": "Affiliate Payout",
      "siteId": "site-123",
      "name": "August Affiliate Payout",
      "domainName": "affiliates.example.com"
    },
    "createdAt": "2025-08-06T09:30:45Z"
  },

  "// Enum Values": {
    "TxStatus": [
      "NEW",
      "PENDING",
      "FAILED",
      "REFUNDED",
      "CUSTOMER_VERIFICATION",
      "SUCCEED",
      "BLOCKED",
      "PROCESSING",
      "CHARGEBACK"
    ],
    "ApmMethod": [
      "PAYPAL",
      "IDEAL",
      "GOOGLE_PAY",
      "APPLE_PAY",
      "EXTERNAL_HPP_GOOGLE_PAY",
      "EXTERNAL_HPP_APPLE_PAY",
      "NAGINI",
      "NAGINI_PAYOUT",
      "PAPARA",
      "TK_PAY",
      "TK_PAY_PAYOUT",
      "TK_PAY_QR",
      "PAYYD",
      "PAYYD_PAYOUT",
      "SMART_E_WALLET",
      "SMART_MOBILE_WALLET",
      "SMART_BANK_TRANSFER",
      "SMART_VOUCHER",
      "SMART_QR",
      "SMART_BNPL",
      "SMART_CARRIER_BILLING",
      "SMART_APM",
      "SMART_BANK_TRANSFER_PAYOUT"
    ],
    "ApmFlowType": [
      "BANK_TRANSFER",
      "CARD_PAYMENT",
      "E_WALLET",
      "MOBILE_WALLET",
      "CASH",
      "VOUCHER",
      "CARRIER_BILLING",
      "BNPL"
    ]
  }
}

Enum values represented with descriptions: (alternative JSON format showing each enum as an object with a description and the list of values)

{
  "TxStatus": {
    "description": "Transaction status enum values",
    "values": [
      "NEW",
      "PENDING",
      "FAILED",
      "REFUNDED",
      "CUSTOMER_VERIFICATION",
      "SUCCEED",
      "BLOCKED",
      "PROCESSING",
      "CHARGEBACK"
    ]
  },
  "ApmMethod": {
    "description": "Payment method enum values",
    "values": [
      "PAYPAL",
      "IDEAL",
      "GOOGLE_PAY",
      "APPLE_PAY",
      "EXTERNAL_HPP_GOOGLE_PAY",
      "EXTERNAL_HPP_APPLE_PAY",
      "NAGINI",
      "NAGINI_PAYOUT",
      "PAPARA",
      "TK_PAY",
      "TK_PAY_PAYOUT",
      "TK_PAY_QR",
      "PAYYD",
      "PAYYD_PAYOUT",
      "SMART_E_WALLET",
      "SMART_MOBILE_WALLET",
      "SMART_BANK_TRANSFER",
      "SMART_VOUCHER",
      "SMART_QR",
      "SMART_BNPL",
      "SMART_CARRIER_BILLING",
      "SMART_APM",
      "SMART_BANK_TRANSFER_PAYOUT"
    ]
  },
  "ApmFlowType": {
    "description": "Payment flow type enum values",
    "values": [
      "BANK_TRANSFER",
      "CARD_PAYMENT",
      "E_WALLET",
      "MOBILE_WALLET",
      "CASH",
      "VOUCHER",
      "CARRIER_BILLING",
      "BNPL"
    ]
  }
}