Retrieving Payment Status

In addition to callbacks, you have the option to retrieve the status and details of a particular payment transaction on demand. This is useful if, for example, a callback was not received (due to network issues) or if you want to fetch the latest status at a later time. The endpoint to retrieve payment information is:

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

Here, {id} should be replaced with the transactionId of the transaction you are inquiring about.

Parameter

Parameter	Type	Required	Description
`id`	Long	Yes	The transaction ID of the payment you want to look up.

Response: If the transaction is found and accessible, the API will return a JSON object containing the payment details in the same format as the callback data (an ApmPaymentTxInfoDto object with all the fields described in the callback section). If the transaction does not exist or is not available to your account, an error (such as HTTP 404 Not Found) will be returned.

For example, a successful response from this endpoint will look very similar to the Example Callback Data shown below (with the final status, amounts, etc.). Use this endpoint to verify a transaction’s state if needed.

Response Body Example

{
  "transactionId": "123456789",
  "requestId": "req-987654321",
  "accountId": 123456789,
  "transactionStatus": "SUCCEED",
  "declineCode": null,
  "declineSubReason": null,
  "orderCurrency": "USD",
  "processedCurrency": "EUR",
  "orderAmount": 100.0,
  "processedAmount": 92.5,
  "conversionRate": 0.925,
  "apmRequestPayload": {
    "paymentMethod": "PAYPAL", //All the payment methods are defined in the section below
    "paymentType": "E_WALLET" //All the payment types are defined in the section below
  },
  "apmResponseData": {
    "paymentMethod": "PAYPAL",
    "paymentType": "E_WALLET",
    "redirectUrl": "https://example.com/redirect",
    "iframeUrl": null,
    "providerTransactionId": "provider-tx-123"
  },
  "callbackUrl": "https://merchant.com/callback",
  "billingDetails": {
    "externalUserId": "user-001",
    "firstName": "John",
    "lastName": "Doe",
    "address1": "123 Main Street",
    "city": "New York",
    "state": "NY",
    "country": "US",
    "postalCode": "10001",
    "phone": "+1234567890",
    "email": "[email protected]",
    "dateOfBirth": "1980-01-01",
    "ssn": "123-45-6789",
    "identityCode": "ID123456"
  },
  "order": {
    "date": "2025-07-31",
    "orderId": "order-001",
    "title": "Product Title",
    "siteId": "site-123",
    "name": "Merchant Site",
    "domainName": "merchant.com"
  },
  "createdAt": "2025-07-31T12:00:00Z"
}

Note: The paymentMethod and paymentType in apmRequestPayload, apmResponseData specify the APM (ExPay e-wallet in this case).