Skip to main content
GET
/
receiver
/
external-account
/
{accountId}
Resolve same-currency receiver readiness by external account ID.
curl --request GET \
  --url https://{publicHost}/receiver/external-account/{accountId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "lookupId": "lookup_ext_123",
  "supportedCurrencies": [
    {
      "currencyCode": "SGD",
      "minAmountMinor": "135",
      "maxAmountMinor": "135000000"
    }
  ],
  "requiredPayerDataFields": [
    {
      "name": "FULL_NAME"
    }
  ],
  "status": "OK"
}

Authorizations

​
Authorization
string
header
required

Integration-key Basic Auth (clientId:clientSecret) as documented in docs/public/AUTHENTICATION.md.

Path Parameters

​
accountId
string
required

Bound external-account identifier for the receiver being resolved for same-currency funding or payout.

Query Parameters

​
currencyCode
string

Optional same-currency filter for the intended funding or payout corridor.

​
amountMinor
string

Optional transfer amount hint in minor units carried for same-currency route-readiness context.

​
customerId
string

Optional customer UUID hint for the owning customer when multiple receiver records may be present in the current platform context.

Response

Same-currency receiver-readiness lookup returned.

​
lookupId
string
required

Lookup-context handle returned by receiver resolution and reused by downstream same-currency follow-on steps.

​
supportedCurrencies
object[]
required

Supported same-currency rails available for this resolved receiver.

​
requiredPayerDataFields
object[]
required

Required payer-data field names for the downstream same-currency transfer.

​
status
enum<string>
required

Receiver lookup readiness status for same-currency follow-on steps.

Available options:
OK