MCPcopy Create free account
hub / github.com/circlefin/circle-nodejs-sdk / PIXApiFactory

Function PIXApiFactory

src/generated/apis/pixapi.ts:375–441  ·  view source on GitHub ↗
(
  configuration?: Configuration,
  basePath?: string,
  axios?: AxiosInstance
)

Source from the content-addressed store, hash-verified

373 * @export
374 */
375export const PIXApiFactory = function (
376 configuration?: Configuration,
377 basePath?: string,
378 axios?: AxiosInstance
379) {
380 const localVarFp = PIXApiFp(configuration);
381 return {
382 /**
383 *
384 * @summary Create a PIX bank account
385 * @param {PixFiatAccountCreationRequest} [pixFiatAccountCreationRequest]
386 * @param {*} [options] Override http request option.
387 * @throws {RequiredError}
388 */
389 createBusinessPixAccount(
390 pixFiatAccountCreationRequest?: PixFiatAccountCreationRequest,
391 options?: any
392 ): AxiosPromise<CreateBusinessPixAccountResponse> {
393 return localVarFp
394 .createBusinessPixAccount(pixFiatAccountCreationRequest, options)
395 .then((request) => request(axios, basePath));
396 },
397 /**
398 *
399 * @summary Get a PIX bank account
400 * @param {string} id Universally unique identifier (UUID v4) of a resource.
401 * @param {*} [options] Override http request option.
402 * @throws {RequiredError}
403 */
404 getBusinessPixAccount(
405 id: string,
406 options?: any
407 ): AxiosPromise<GetBusinessPixAccountResponse> {
408 return localVarFp
409 .getBusinessPixAccount(id, options)
410 .then((request) => request(axios, basePath));
411 },
412 /**
413 * Get the PIX transfer instructions into the Circle bank account given your bank account id.
414 * @summary Get PIX instructions
415 * @param {string} id Universally unique identifier (UUID v4) of a resource.
416 * @param {*} [options] Override http request option.
417 * @throws {RequiredError}
418 */
419 getBusinessPixAccountInstructions(
420 id: string,
421 options?: any
422 ): AxiosPromise<BusinessPixAccountInstructionsResponse> {
423 return localVarFp
424 .getBusinessPixAccountInstructions(id, options)
425 .then((request) => request(axios, basePath));
426 },
427 /**
428 *
429 * @summary List all PIX bank accounts.
430 * @param {*} [options] Override http request option.
431 * @throws {RequiredError}
432 */

Callers

nothing calls this directly

Calls 1

PIXApiFpFunction · 0.85

Tested by

no test coverage detected