Sign in
Alternative Payment Methods

View APM transaction async status

Gets information about the specified alternative payment method (APM) asynchronous transaction. Use this for tracking APM transactions submitted through the Run APM transaction or through any of the integration methods (for more information, see Run a sale transaction in the Alternative Payment Method section of Guides).

The Create APM one-time-use token endpoint returns the asyncTraceId in the response for you to use with the path parameter for this endpoint.

For the Multi Iframe (Express APM) and Individual Iframe (Button URLs) integration methods for one-time payments (non-dropin-style), the history object progresses through the following flow for a successful payment:<ul style='margin-top: -5px; margin-bottom: -5px'><li>getToken</li><li>iframe</li><li>popup</li><li>finale</li></ul>

For the Custom Redirect (Redirect URLs) integration method, the history object progresses through the following flow for a successful payment:<ul style='margin-top: -5px; margin-bottom: -5px'><li>getToken</li><li>popup</li><li>finale</li></ul>

For first transactions in a merchant-initiated recurring transaction, the history object progressess through the following flow for a successful payment:<ul style='margin-top: -5px; margin-bottom: -5px'><li>getToken</li><li>iframe</li><li>processFromApm</li></ul>

See also

<div style="display:none;">

Request parameters

  • asyncTraceId

Response parameters

  • gatewayResponse
  • gatewayResponse.refNumber
  • gatewayResponse.gatewayName
  • history.processFromApm
  • history.processFromApm.initiatedAt
  • history.processFromApm.updatedAt
  • history.processFromApm.state
  • history.getToken
  • history.getToken.initiatedAt
  • history.getToken.updatedAt
  • history.getToken.state
  • history.iframe
  • history.iframe.initiatedAt
  • history.iframe.updatedAt
  • history.iframe.state
  • history.popup
  • history.popup.initiatedAt
  • history.popup.updatedAt
  • history.popup.state
  • history.finale
  • history.finale.initiatedAt
  • history.finale.updatedAt
  • history.finale.state
  • updatedAt
  • initialTransactionStatus
  • createdAt
  • asyncTraceId
</div>
get/apm/v3/transactionAsyncStatus/{asyncTraceId}

Path parameters

asyncTraceIdstring required

The high-level ID of an unprocessed APM transaction for tracking progress and status. Get this value from the response from the Create APM one-time-use token endpoint. This is a path parameter.

Response

Success

updatedAtstring

The date and time at which the record of this asynchronous APM transaction was last modified.

createdAtCreatedAt — unresolved $ref
initialTransactionStatusstring

The APM transaction status at the time Nexio received the payment response. This value does not update if the status changes later (such as with a voided APM transaction). This parameter has a value of NULL until the payment response gets returned after APM payment validation.

asyncTraceIdAsyncTraceId — unresolved $ref

Changes

No recorded changes to this endpoint across all 1 revision of this API.