Skip to main content
GET
/
user
/
funding
/
source
/
get-receiving-methods
/
{userToken}
Get receiving methods
curl --request GET \
  --url https://raas-partner-cv.nomas.cash/v1/user/funding/source/get-receiving-methods/{userToken} \
  --header 'api_key: <api-key>'
[
  {
    "id": "6af8e158-be29-422a-8d69-703d6c343c3c",
    "name": "VISA-1234",
    "type": "CreditCard",
    "isPrimary": true,
    "number": "TOK_SANDBOX_9PNaaaqpqwertnD1jYkdw1_1234"
  }
]

Authorizations

​
api_key
string
header
required

Path Parameters

​
userToken
string
required

User token.

Query Parameters

​
sourceCountry
string

Source country code. ISO 3166-1 alpha-2. Example: US for United States, MX for Mexico.

​
destinationCountry
string

Destination country code. ISO 3166-1 alpha-2. Example: MX for Mexico, US for United States.

Response

200 — OK. Receiving methods for RequestFunds.

Scenarios for this response:

ScenarioHow to reproduceTypical code / body
SOF listValid tenant + user + query params.SourceOfFunding[]

See also Full scenario matrix.

​
id
string

Stable identifier for the payment method when already persisted.

​
name
string

Cardholder or account display name.

​
isPrimary
boolean

When true, this method is the subscriber’s primary source of funding.

​
accountNumber
string

Bank account number (or equivalent account identifier for the rail).

​
bankEntityNumber
string

Bank or entity routing / CLABE-style identifier, depending on corridor.

​
type
string

Rail / instrument type (e.g. BankAccount, DebitCard, CLABE, VNA).

​
expirationDate
string

Card or instrument expiration date.

​
expirationMonth
string

Expiration month (string for leading zeros and channel consistency).

​
expirationYear
string

Expiration year (string for leading zeros and channel consistency).

​
cardType
string

Card product type label, e.g. Credit or Debit.

​
number
string

Primary account number or masked PAN as agreed for the integration.

​
tokenData
string

Opaque tokenized payload for the payment network (never raw PAN in logs). This is a JSON string. Deprecated.

​
cardNetwork
string

Card network / brand.

Examples: Visa, MasterCard, American Express, Discover, Diners Club, JCB, UnionPay, Maestro, Mir, Verve, Troy, UATP.

​
currency
string

ISO 4217 currency code (e.g. USD, MXN).

​
country
string

ISO 3166-1 alpha-2 country code (e.g. US, MX).

​
status
string

Lifecycle / validation status string for the method.

Values align with PaymentMethodStatus (e.g. Created, Validated, Blocked).

​
allowPullCrossBorder
boolean

Whether pull (debit) is allowed across borders for this card.

​
allowPullDomestic
boolean

Whether pull (debit) is allowed domestically for this card.

​
allowPushCrossBorder
boolean

Whether push (credit/load) is allowed across borders for this card.

​
allowPushDomestic
boolean

Whether push (credit/load) is allowed domestically for this card.

​
allowReviewAddress
boolean

Whether the network allows address review flows for this instrument.

​
paymentMethodOwner
string

VNA / corridor-specific method owner (e.g. BCP).

​
externalId
string

Partner or upstream system identifier for idempotent registration or correlation.

​
canOperate
boolean

Whether the instrument is allowed to operate (network / policy gate).