FlashFlow transaction

You can submit a FlashFlow transaction in these ways:

• Purchase (pay-in): Create a pay-by-bank transaction with apmProvider set to Flashflow and intent set to Purchase. Supply bankName (the bank code from the bank-list route) and bankAccountNumber. Render fundingData.payByBank.iframeSrc from the response in your own UI so the shopper can complete the pay-in.
• Payout (withdrawal), new bank account: Create a pay-by-bank transaction with intent set to Payout and supply all three of bankName, bankAccountNumber, and bankAccountHolderName. Don't also send gatewayTokenId. Capture fundingData.payByBank.gatewayTokenId from the response to reuse the destination later.
• Payout (withdrawal), stored bank account: Create a payout and supply gatewayTokenId from an earlier accepted payout, or from a completed FlashFlow pay-in webhook or query when vaulted, instead of resending bank details.

FlashFlow supports THB only. Purchase examples use Thai shopper details (countryCode TH). Treat merchant webhooks as the authoritative final outcome. Don't treat the shopper completing the iframeSrc surface as payment confirmation on its own. You can use the Get transaction details API later for reconciliation.

Note that FlashFlow doesn't support capture, void, or refund.

Call this before creating FlashFlow pay-ins or payouts that need a bank code. Use each bank's code value as fundingData.payByBank.bankName when you create a transaction. Don't send the bank's display name.

curl --request GET \
     --url 'https://api-services.pxp.io/api/v1/altp-flashflow-processor/MERCHANT-1/SITE-1/bank-list' \
     --header 'accept: application/json'

If your request is successful, you'll receive a 200 response with the cached bank list. On a provider failure, the gateway may return the last known good cached list when one is available. A 500 response is returned when the cache is empty and the provider call also fails.

{
  "banks": [
    {
      "code": "KTB",
      "name": "Krung Thai Bank"
    }
  ]
}

{
  "merchant": "MERCHANT-1",
  "site": "SITE-1",
  "merchantTransactionId": "FLASHFLOW-TXN-001",
  "merchantTransactionDate": "2026-09-21T10:00:00Z",
  "transactionMethod": {
    "intent": "Purchase",
    "entryType": "Ecom",
    "fundingType": "PayByBank"
  },
  "fundingData": {
    "payByBank": {
      "apmProvider": "Flashflow",
      "bankName": "KTB",
      "bankAccountNumber": "1234567890",
      "type": "QR",
      "transactionTimeout": 10
    }
  },
  "amounts": {
    "transaction": 100.00,
    "currencyCode": "THB"
  },
  "shopper": {
    "id": "Shopper_TH_01",
    "firstName": "Somchai",
    "lastName": "Jaidee",
    "phoneNumber": "+66812345678",
    "countryCode": "TH"
  }
}

{
  "state": "PendingOnProvider",
  "systemTransactionId": "1ed768bb-e88a-4636-91ae-67927ccbb02b",
  "merchantTransactionId": "FLASHFLOW-TXN-001",
  "merchantTransactionDate": "2026-09-21T10:00:00Z",
  "providerTransactionId": "flashflow-ref-001",
  "fundingData": {
    "payByBank": {
      "apmProvider": "Flashflow",
      "iframeSrc": "https://pay.example/flashflow/qr/...",
      "approvedAmount": 99.50
    }
  },
  "amounts": {
    "transaction": 100.00,
    "currencyCode": "THB"
  }
}

Treat merchant webhooks as the authoritative final outcome. For reconciliation or a later status check, get the transaction details. For FlashFlow, pass systemTransactionId, fundingType set to PayByBank, and apmProvider set to Flashflow. FlashFlow queries return the last persisted state and don't call FlashFlow live.

Treat FlashFlow merchant webhooks as the authoritative final outcome for purchases and payouts. Don't treat the transaction initiation response alone as settlement, and don't treat the shopper finishing the iframeSrc surface as confirmation on its own. You don't receive raw FlashFlow callback bodies.

Use transactionMethod.intent to tell purchases and payouts apart when they share the same event code. shopperReference, gatewayTokenId, and transactionUpdateDatetime are omitted when not stored on the transaction. Bank account numbers and holder names are never included. On FlashFlow webhooks, transactionMethod.fundingType is delivered as PayByBanks (plural).

The following event codes apply to FlashFlow:

{
  "eventDate": "2026-09-21T10:30:00.0000000Z",
  "eventCategory": "transaction",
  "eventOwner": {
    "merchantGroup": "merchant-group-1",
    "merchant": "MERCHANT-1",
    "site": "SITE-1"
  },
  "eventData": {
    "eventCode": "flashflow-transaction-executed",
    "state": "Authorised",
    "stateData": {
      "code": "APM001",
      "message": "Payment executed"
    },
    "amounts": {
      "transaction": 99.5,
      "currencyCode": "THB"
    },
    "merchant": "MERCHANT-1",
    "site": "SITE-1",
    "shopperReference": "Shopper_TH_01",
    "gatewayTokenId": "b6e2f1a4-c3d8-4f7a-b1e9-d2c3f4a5b6c7",
    "transactionUpdateDatetime": "2026-09-21T10:30:00Z",
    "transactionMethod": {
      "intent": "Purchase",
      "entryType": "Ecom",
      "fundingType": "PayByBanks"
    },
    "fundingData": {
      "payByBank": { … }
    },
    "providerResponse": {
      "provider": "Flashflow",
      "providerTransactionId": "flashflow-ref-001",
      "providerTransactionStatus": "completed",
      "providerResponseCode": "completed",
      "providerResponseMessage": "Payment executed"
    },
    "merchantTransactionId": "FLASHFLOW-TXN-001",
    "systemTransactionId": "1ed768bb-e88a-4636-91ae-67927ccbb02b"
  }
}

{
  "eventDate": "2026-09-21T11:00:00.0000000Z",
  "eventCategory": "transaction",
  "eventOwner": {
    "merchantGroup": "merchant-group-1",
    "merchant": "MERCHANT-1",
    "site": "SITE-1"
  },
  "eventData": {
    "eventCode": "flashflow-transaction-executed",
    "state": "Authorised",
    "stateData": {
      "code": "APM001",
      "message": "Payment executed"
    },
    "amounts": {
      "transaction": 100,
      "currencyCode": "THB"
    },
    "merchant": "MERCHANT-1",
    "site": "SITE-1",
    "gatewayTokenId": "b6e2f1a4-c3d8-4f7a-b1e9-d2c3f4a5b6c7",
    "transactionUpdateDatetime": "2026-09-21T11:00:00Z",
    "transactionMethod": {
      "intent": "Payout",
      "entryType": "Ecom",
      "fundingType": "PayByBanks"
    },
    "fundingData": {
      "payByBank": { … }
    },
    "providerResponse": {
      "provider": "Flashflow",
      "providerTransactionId": "flashflow-ref-002",
      "providerTransactionStatus": "completed",
      "providerResponseCode": "completed",
      "providerResponseMessage": "Payment executed"
    },
    "merchantTransactionId": "FLASHFLOW-PAYOUT-001",
    "systemTransactionId": "2fd879cc-f99b-4747-92bf-78038ddcc03c"
  }
}

In your sandbox environment, you can use test bank codes instead of real ones to trigger a specific, predictable status on demand — without connecting to a real bank, moving any real money, or sending anything to FlashFlow's real systems. This allows you to test how your integration handles the statuses you can see in your webhook notifications and status responses:

• For pay-ins, Authorised and Expired
• For payouts, Authorised, Error, and Refused

Use a test bank code exactly as you would use a real one: pass it as bankName in fundingData.payByBank when you create a payment or payout. No other part of your request changes.

You can also see all of the available test bank codes by calling Get FlashFlow supported banks API in a sandbox environment. They're automatically included in the list, so you can find them the same way you find a real bank. Some entries apply only to pay-ins, as described below.

The following table describes all of the test bank codes you can use and the corresponding outcome.

For pay-ins, use SIM-AUTHORISED, SIM-FLOATING, or SIM-KYC. Your response includes a normal iframeSrc redirect link, exactly like a real FlashFlow payment. Instead of FlashFlow's real hosted page, it opens a test page where you choose the outcome yourself.

The page shows two buttons: Authorised and Expired. Click whichever one you want to test. The payment stays PendingOnProvider until you click a button. There's no time limit and no auto-resolution.

Once you've clicked a button, your payment's status updates immediately to that same status, and your webhook notification fires with it. You can't change the status after that; create a new test payment to try a different one.

A payout has no page to open (a real FlashFlow payout doesn't return one either). Instead, about 10 seconds after you create it, your payout's status automatically updates to whichever status the bank code you chose maps to, and your webhook notification fires with that status.