Accounts & UtilitiesPayment Proxy Address

Look up a payment proxy address

POST
/v1/payment-proxy/lookup

Authorization

authorization
AuthorizationBearer <token>

Set Your Secret API Key

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

proxyType*string

Type of the payment recipient's proxy (e.g. mobile phone number). This determines the value in proxyValue. E.g. if you specify UEN here, proxyValue should be a valid UEN. Proxy types supporting the DuitNow payment method: MOBILE, BUSINESS_REG, NRIC and PASSPORT.

Length1 <= length
proxyValue*string

Payment recipient's proxy (e.g. mobile phone number). The value here is determined by proxyType. E.g. if you specify UEN in proxyType, this should be a valid UEN.

For the PayNow payment method, proxyValue should follow these formats:

  • MOBILE proxy type: A mobile number including the country code (+65 for Singapore). E.g: +6592345678.
  • UEN proxy type: A valid Unique Entity Number (UEN) issued by ACRA. E.g: 202303536E.
  • NRIC proxy type: A valid NRIC or FIN. E.g: S0000001I.
  • VPA proxy type: A valid Virtual Payment Address (VPA) issued by a non-bank Financial Institution (e.g. digital wallets). The exact format is determined by the issuer. E.g: +6592345678#ACME.

For the DuitNow payment method, see the DuitNow variant of this request for the MOBILE, BUSINESS_REG, NRIC and PASSPORT formats.

Length1 <= length

Response Body

*/*

curl -X POST "https://example.com/v1/payment-proxy/lookup" \  -H "Content-Type: application/json" \  -d '{    "proxyType": "string",    "proxyValue": "string"  }'
{  "failureReason": "string",  "proxyType": "string",  "proxyValue": "string",  "success": true}