Skip to main content
Defined in: _vendor/api/resources/paymentMethods/client/Client.ts:16 The Payment Methods APIs enable you to create and manage payment methods for accounts. Payment methods represent ways to send and receive payments, such as ACH transfers and Fedwire transfers. These APIs allow you to create, list, and retrieve payment method details for use in payment transfers and transactions.

​
Methods

​
getPaymentMethod()

getPaymentMethod(request: GetPaymentMethodRequest, requestOptions?: RequestOptions): HttpResponsePromise<PaymentMethodsPaymentMethod>;
Defined in: _vendor/api/resources/paymentMethods/client/Client.ts:165 Get details of a specific payment method by its ID. Returns 404 if the payment method is not found or not owned by the requesting entity.

​
Parameters

request
GetPaymentMethodRequest
requestOptions?
RequestOptions Request-specific configuration.

​
Returns

HttpResponsePromise<PaymentMethodsPaymentMethod>

​
Example

await client.paymentMethods.getPaymentMethod({
    paymentMethodId: "paymentMethod_8e03978e-40d5-43e8-bc93-6894a57f9324"
})

​
listPaymentMethods()

listPaymentMethods(request?: ListPaymentMethodsRequest, requestOptions?: RequestOptions): HttpResponsePromise<ListPaymentMethodsResponse>;
Defined in: _vendor/api/resources/paymentMethods/client/Client.ts:56 List payment methods linked to your entity. Payment methods represent external financial instruments that can be used as a target for transfers. The list will not include disabled or deleted payment methods. Currently Supported Types:
  • fedwire: Domestic USD wire transfers
  • swift: International wire transfers
  • sepa: SEPA EUR transfers
Note: Payment methods are created and verified through your linked CDP entity. Currently, fetching payment methods is only supported for Prime investment vehicles linked to CDP.

​
Parameters

request?
ListPaymentMethodsRequest = {}
requestOptions?
RequestOptions Request-specific configuration.

​
Returns

HttpResponsePromise<ListPaymentMethodsResponse>

​
Example

await client.paymentMethods.listPaymentMethods({
    pageToken: "eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="
})