client.getTransaction()

Use this method to fetch a single transaction by its ID, including its stage breakdown. Call it after a payment flow completes (for example, when client.setupApplePay(), client.setupGooglePay(), or client.setupBuy() emits complete) to poll for the final transaction status. For bank-transfer payments (SEPA), this endpoint also returns the deposit details your app renders so the customer can pay. See Bank-transfer deposit details. For request and response details, see the Get a transaction API.

Get a transaction

import { createClient } from "@moonpay/platform-sdk-web";

const client = createClient({ sessionToken: "c3N0XzAwMQ==" });

const result = await client.getTransaction("tr_abc123");

if (!result.ok) {
  // Handle error
  console.error(result.error.code, result.error.message);
  return;
}

console.log(result.value.data);

Parameters

client.getTransaction() takes a single positional argument.

Argument	Type	Required	Description
`id`	`string`	✅	The MoonPay ID of the transaction.

This method does not require a separate auth token. The client uses stored credentials from an active connection.

Result

client.getTransaction() returns a Result<{ data: TransactionWithStages }, GetTransactionsError>.

Result envelope

Result<{ data: TransactionWithStages }, GetTransactionsError>

Field	Type	Required	Description
`ok`	`boolean`	✅	Whether the operation succeeded.
`value`	`{ data:` `TransactionWithStages` `}`		Present when `ok` is `true`.
`error`	`GetTransactionsError`		Present when `ok` is `false`.

`TransactionWithStages`

A transaction with its stage breakdown. See the Transaction object for every field, and the Get a transaction API for the response shape.

Field	Type	Required	Description
`id`	`string`	✅	The MoonPay ID of the transaction.
`status`	`TransactionStatus`	✅	The current transaction status. See the Transaction object for the full list of statuses.
`source`	`object`	✅	The source amount and asset (fiat currency).
`destination`	`object`	✅	The destination amount and asset (cryptocurrency).
`createdAt`	`string`	✅	An ISO 8601 timestamp of when the transaction was created.
`stages`	`Stage[]`	✅	The transaction’s pipeline stages, each with a `kind` and `status`.
`bankTransferDepositInfo`	`object`		The bank account details the customer sends funds to. Present only on bank-transfer transactions (SEPA). See Bank-transfer deposit details.

Bank-transfer deposit details

Bank-transfer payments (SEPA) settle when the customer sends funds to a MoonPay bank account. For these transactions, the response includes a bankTransferDepositInfo object with the account details and the payment reference. The transaction’s source.amount (with source.asset.code) is the exact fiat amount the customer must send; render it alongside the deposit details. Bank transfers are a floating payment method: the crypto amount is only final at settlement. While the transaction is pending, its destination.amount is a floating estimate, the same estimate the quote returns, so you don’t need to retain the original quote. Render destination.amount with a tilde, making clear it’s an estimate until the transfer lands. At settlement it becomes the final amount delivered. See Exchange rate type. Your app renders these details natively so the customer can complete the transfer from their banking app. MoonPay does not render the deposit UI. Read the fields from bankTransferDepositInfo and display them in your own screen, then keep polling client.getTransaction() to track the transaction to a terminal status.

The customer must include the payment reference with their bank transfer. Transfers sent without the reference are rejected. Surface this prominently in your own UI, for example, “Always include your payment reference or your transfer will be rejected.”

Field	Type	Required	Description
`reference`	`string`	✅	The payment reference the customer must include with the transfer.
`recipientName`	`string`	✅	The name of the recipient that receives the funds.
`recipientAddress`	`string`	✅	The address of the recipient.
`iban`	`string`		The IBAN. Present for SEPA (EUR).
`bic`	`string`		The BIC / SWIFT code. Present for SEPA (EUR).
`bankName`	`string`		The name of the receiving bank.
`bankAddress`	`string`		The address of the receiving bank.

Show the customer the exact reference value. MoonPay uses it to match the incoming transfer to this transaction. A missing or altered reference means the transfer is rejected.

`GetTransactionsError`

GetTransactionsError is the standard MoonPay Platform API error shape, DevPlatformApiError.

Field	Type	Required	Description
`code`	`DevPlatformApiErrorCode`	✅	A machine-readable error code (for example, `"not_found"`, `"unauthorized"`). See the error reference for the full list.
`message`	`string`	✅	A developer-friendly message.
`errors`	`DevPlatformApiErrorDetail[]`		Optional list of field-level errors.

Example: poll until terminal status

After a payment flow emits complete, poll client.getTransaction() until the transaction reaches a terminal status. The set of terminal statuses depends on the flow — check the Transaction object reference for the values that apply.

Poll for final status

const TERMINAL_STATUSES = new Set(["completed", "failed"]);

async function pollTransaction(transactionId: string) {
  while (true) {
    const result = await client.getTransaction(transactionId);

    if (!result.ok) {
      throw new Error(result.error.message);
    }

    const transaction = result.value.data;

    if (TERMINAL_STATUSES.has(transaction.status)) {
      return transaction;
    }

    await new Promise((resolve) => setTimeout(resolve, 3000));
  }
}

Poll this endpoint to track status, or use the existing transaction-updated webhook if you already consume MoonPay webhooks. Bank-transfer transactions stay pending from creation until they settle. When the customer’s deposit arrives, the status is still pending, so check the stages array: when the waiting_payment stage’s status is "success", the deposit has arrived.

Overview

Customers

Payments

Integration essentials

SDK Reference

Frames

Parameters

Result

Result envelope

`TransactionWithStages`

Bank-transfer deposit details

`GetTransactionsError`

Example: poll until terminal status

​Parameters

​Result

​Result envelope

​TransactionWithStages

​Bank-transfer deposit details

​GetTransactionsError

​Example: poll until terminal status

Parameters

Result

Result envelope

`TransactionWithStages`

Bank-transfer deposit details

`GetTransactionsError`

Example: poll until terminal status