Payment Methods

GET 
https://api.sandbox.noah.com/v1/payment-methods

Retrieves a list of payment methods for a specific customer.

Request

Query Parameters

CustomerID CustomerIDrequired

Possible values: non-empty and <= 36 characters

PageSize integer
Possible values: >= 1 and <= 100
Default value: 20
Example: 10
PageToken string

Header Parameters

Api-Signature string

Digitally signed JWT.

Responses

200

List of fiat payment methods

application/json

Schema

Schema

Items object[]required
Array [
IDstringrequired
CustomerIDCustomerID (string)
A unique ID which identifies the customer in the Business' internal system and in NOAH.
Possible values: non-empty and <= 36 characters
Example: 550e8400-e29b-41d4-a716-446655440000
CountryCountryCode (string)required
ISO 3166-1 alpha-2 country code.
Example: US
PaymentMethodCategoryPaymentMethodCategory (string)required
Categorizes one or more PaymentMethodTypes into broader groups. Useful for listing channels, displaying payment methods:
• Bank
• Card
• Identifier
Example: Bank
DisplayDetails objectrequired
Contains information to display each payment method, with fields tailored to the specific type (e.g., last four digits or account number) to help identify the payment method.
Typerequired
Contains information to display each payment method, with fields tailored to the specific type (e.g., last four digits or account number) to help identify the payment method.
Possible values: [FiatPaymentMethodBankDisplay, FiatPaymentMethodCardDisplay, FiatPaymentMethodIdentifierDisplay]
FiatPaymentMethodBankDisplay
AccountNumberstring
BankCodestring
FiatPaymentMethodCardDisplay
Last4stringrequired
SchemeFiatPaymentCardScheme (string)required
The card scheme:
• Mastercard
• Visa
Example: Visa
FiatPaymentMethodIdentifierDisplay
IdentifierTypePaymentMethodIdentifierType (string)required
Identifier type:
• PhoneNumber
• Email
• TaxID
Example: PhoneNumber
Identifierstringrequired
]
PageTokenstring

Example (auto)

{
  "Items": [
    {
      "ID": "string",
      "CustomerID": "550e8400-e29b-41d4-a716-446655440000",
      "Country": "US",
      "PaymentMethodCategory": "Bank",
      "DisplayDetails": {
        "Type": "FiatPaymentMethodBankDisplay",
        "AccountNumber": "string",
        "BankCode": "string"
      }
    }
  ],
  "PageToken": "string"
}

400

Bad request

application/json

Schema

Schema

TypeErrorType (string)
Type of error:
• InvalidMessage
• Unexpected
• ResourceNotFound
• Unauthorized
• Forbidden
• InsufficientBalance
Example: InvalidMessage
Instancestring
A unique reference that identifies the specific occurrence of the problem
Actionstring
Action taking place which resulted in error.
Detailstring
Details about the error.
Extensions object
Additional information about the error.
Requestobject
Details about invalid request properties.
Features object
Details about the disabled feature flags
property name* string[]
List of reasons
Array [
string
Type of reason:
• BetaAccess
• GloballyDisabled
• Maintenance
• RestrictedRegion
• Kyc
• Suspended
]

Example (auto)

{
  "Type": "InvalidMessage",
  "Instance": "string",
  "Action": "string",
  "Detail": "string",
  "Extensions": {
    "Request": {},
    "Features": {}
  }
}

401

Client is not authorized to perform this action

application/json

Schema

Schema

TypeErrorType (string)
Type of error:
• InvalidMessage
• Unexpected
• ResourceNotFound
• Unauthorized
• Forbidden
• InsufficientBalance
Example: InvalidMessage
Instancestring
A unique reference that identifies the specific occurrence of the problem
Actionstring
Action taking place which resulted in error.
Detailstring
Details about the error.
Extensions object
Additional information about the error.
Requestobject
Details about invalid request properties.
Features object
Details about the disabled feature flags
property name* string[]
List of reasons
Array [
string
Type of reason:
• BetaAccess
• GloballyDisabled
• Maintenance
• RestrictedRegion
• Kyc
• Suspended
]

Example (auto)

{
  "Type": "InvalidMessage",
  "Instance": "string",
  "Action": "string",
  "Detail": "string",
  "Extensions": {
    "Request": {},
    "Features": {}
  }
}

500

Internal server error

application/json

Schema

Schema

TypeErrorType (string)
Type of error:
• InvalidMessage
• Unexpected
• ResourceNotFound
• Unauthorized
• Forbidden
• InsufficientBalance
Example: InvalidMessage
Instancestring
A unique reference that identifies the specific occurrence of the problem
Actionstring
Action taking place which resulted in error.
Detailstring
Details about the error.
Extensions object
Additional information about the error.
Requestobject
Details about invalid request properties.
Features object
Details about the disabled feature flags
property name* string[]
List of reasons
Array [
string
Type of reason:
• BetaAccess
• GloballyDisabled
• Maintenance
• RestrictedRegion
• Kyc
• Suspended
]

Example (auto)

{
  "Type": "InvalidMessage",
  "Instance": "string",
  "Action": "string",
  "Detail": "string",
  "Extensions": {
    "Request": {},
    "Features": {}
  }
}

Authorization: X-Api-Key

name: X-Api-Keytype: apiKeydescription: This security scheme requires an API Key to successfully authenticate.in: header

• curl
• go
• nodejs
• python
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://api.sandbox.noah.com/v1/payment-methods' \
-H 'Accept: application/json' \
-H 'X-Api-Key: <X-Api-Key>'

Request Collapse all

Base URL

https://api.sandbox.noah.com/v1

Auth

ApiKey

Parameters

CustomerID — queryrequired

PageSize — query

PageToken — query

Api-Signature — header

ResponseClear

Click the Send API Request button above and see the response here!