Skip to main content

Look up a payment proxy address

POST 
/payment-proxy/lookup

This lookup API contacts the addressing server and verifies that the proxy address is valid as a destination.

In test mode, this always returns "success" except for MOBILE/+6511111111 and UEN/201912345NABC.

Request​

Body

    proxyType stringrequired

    Possible values: [MOBILE, UEN, VPA, NRIC]

    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.

    proxyValue stringrequired

    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 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.

Responses​

OK

Schema

    proxyType string

    Possible values: [MOBILE, UEN, VPA, NRIC]

    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.

    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 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.
    success boolean

    True if the lookup is successful.

    failureReason string

    Possible values: [PROXY_NOT_REGISTERED, PROXY_TYPE_NOT_VALID]

    If success is false, the failure reason.

Loading...