Test mode values

Test mode lets you build your integration without touching a bank or moving money. Use your test API key: Acme checks each request, then simulates the bank. The values below make the simulated bank fail, wait or return a specific answer.

Each API reference page with test values links to its section here.

PaymentsCopy Anchor Link

Some banks behave differently in test mode. The steps, example payloads and a table by bank are in:

• Single payments: integrate and test
• Batch payments: integrate and test

Direct debit authorizationsCopy Anchor Link

SingaporeCopy Anchor Link

A successful authorization returns null for payerIdType and payerIdHash. To get mock payer identification instead:

{
  "billReferenceNumber": "S1234567D",
  "payerSwiftBic": "DBSSSGSGXXX",
  "payerSegment": "RETAIL",
  "payerName": "Richard Hendricks",
  "precheckMaxAmount": 100000,
  "precheckCurrency": "SGD",
  "endDate": "2042-04-24",
  "returnUrl": "https://example.com/return"
}

Hong Kong, your account at HSBCCopy Anchor Link

When your collection account is at HSBC Hong Kong, test authorizations go to a simulated HSBC that follows HSBC's own rules. No SMS is sent.

{
  "billReferenceNumber": "A0012334455",
  "payerName": "Wong Ka Ming",
  "payerIdType": "HKID",
  "payerIdNumber": "A1234563",
  "payerMobileNumber": "+85291231234",
  "payerBankCode": "004",
  "payerAccountNumber": "511123456888",
  "precheckMaxAmount": 1000000,
  "precheckCurrency": "HKD"
}

{ "otpId": "<otp.id from the response>", "otpCode": "123456" }

A payer at any other bank gets no OTP. The authorization is SUBMITTED, and becomes SUCCEEDED with the webhook about 90 seconds after you create it. ultimatePayerName Msg NORMAL004000001, HSBC's own test value, does the same.

Payer account numbers that failCopy Anchor Link

For a payer at HSBC (payerBankCode 004), put one of these in payerAccountNumber. The authorization is FAILED with this reason, and Acme sends direct-debit-authorizations.failed. 002039147001, 002027522001 and 999999999999 are HSBC's own test accounts, so they also work in HSBC's test environment.

OTP rulesCopy Anchor Link

An authorization whose OTP is never confirmed becomes FAILED with PAYER_AUTHORIZATION_TIMEOUT, and the direct-debit-authorizations.failed webhook, after 7 days, as HSBC deletes it.

Payer names that change the outcomeCopy Anchor Link

Put one of these in ultimatePayerName. Each FAILED below also sends direct-debit-authorizations.failed.

Hong Kong, your account at Standard CharteredCopy Anchor Link

When your collection account is at Standard Chartered Hong Kong:

Direct debit paymentsCopy Anchor Link

The values are exact and case-sensitive: fail and pending for a single collection, FAIL and FAIL-BATCH in a batch.

{
  "type": "FAST",
  "amount": 4200,
  "currency": "SGD",
  "directDebitAuthorizationId": "dda_0H3BQMGGRTFXT",
  "customerReference": "fail"
}

Hosted paymentsCopy Anchor Link

Send hostedPaymentMethodId with Create a Hosted Payment.

{
  "amount": 4242,
  "currency": "SGD",
  "channel": "WEB_BROWSER_DESKTOP",
  "method": "PAYLAH",
  "hostedPaymentMethodId": "hpm_TESTMODESUCCEEDED"
}

Tracked payment QR codesCopy Anchor Link

Create a tracked QR code always answers PENDING. The payment then moves on by these values, checked in this order:

Any other code stays PENDING until you call Perform a direct lookup of a tracked QR code, which marks it SUCCEEDED.

RefundsCopy Anchor Link

Send one of these as transactionId with Create a Refund.

Bank account verificationsCopy Anchor Link

Send one of these as accountNumber with Verify identity of bank account holder.

Payment proxy lookupCopy Anchor Link

With Look up a payment proxy address, every proxy is found except these, which answer PROXY_NOT_REGISTERED:

Foreign exchangeCopy Anchor Link

In test mode, Look Up Forex Rates and Create a Forex Booking use fixed sample rates, not live market rates. Do not use them to check your pricing.