Get receiving method
Retrieves the summary structure for a receiving method by ID.
Authorizations
Path Parameters
End user token.
Query Parameters
Associated payment method ID.
Response
200 — OK. Payment method summary.
Scenarios for this response:
| Scenario | How to reproduce | Typical code / body |
|---|---|---|
| PM found | Valid subscriber + existing id query param. | RaaSPartnerPaymentMethod |
See also Full scenario matrix.
Partner API view of a payout / source-of-funding payment method.
Properties are optional at the type level so partners can receive sparse payloads; individual endpoints may still validate required subsets at runtime.
Stable identifier for the payment method when already persisted.
Cardholder or account display name.
When true, this method is the subscriber’s primary source of funding.
Bank account number (or equivalent account identifier for the rail).
Bank or entity routing / CLABE-style identifier, depending on corridor.
Rail / instrument type (e.g. BankAccount, DebitCard, CLABE, VNA).
Card or instrument expiration date.
Expiration month (string for leading zeros and channel consistency).
Expiration year (string for leading zeros and channel consistency).
Card product type label, e.g. Credit or Debit.
Primary account number or masked PAN as agreed for the integration.
Opaque tokenized payload for the payment network (never raw PAN in logs). This is a JSON string. Deprecated.
Card network / brand.
Examples: Visa, MasterCard, American Express, Discover, Diners Club, JCB, UnionPay, Maestro, Mir, Verve, Troy, UATP.
ISO 4217 currency code (e.g. USD, MXN).
ISO 3166-1 alpha-2 country code (e.g. US, MX).
Lifecycle / validation status string for the method.
Values align with PaymentMethodStatus (e.g. Created, Validated, Blocked).
Whether pull (debit) is allowed across borders for this card.
Whether pull (debit) is allowed domestically for this card.
Whether push (credit/load) is allowed across borders for this card.
Whether push (credit/load) is allowed domestically for this card.
Whether the network allows address review flows for this instrument.
VNA / corridor-specific method owner (e.g. BCP).
Partner or upstream system identifier for idempotent registration or correlation.
Whether the instrument is allowed to operate (network / policy gate).