SchemaFundingFunding Recipients

Create funding account

Create a new funding account, and add it to the funding recipient.

Path parameters

recipientIdintegerRequired

Unique identifier of the funding recipient.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Idempotency-KeystringRequired

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Request

This endpoint expects an object.
typeenumRequired

Type of funding account.

Allowed values:
useenumRequired

Indicates if we send funds or withdraw funds from the account.

  • credit - Send funds to the account.
  • debit - Withdraw funds from the account.
  • creditAndDebit - Send funds and withdraw funds from the account.
Allowed values:
nameOnAccountstringRequired

Name of the account holder.

paymentMethodslist of objectsRequired

Array of paymentMethod objects.

fundingAccountIdintegerOptional

Unique identifier of the funding account.

createdDatestringOptionalformat: "date-time"

Date and time that we received your request to create the funding account in our system.

lastModifiedDatestringOptionalformat: "date-time"

Date and time that the funding account was last modified.

statusenumOptional

Status of the funding account. The value is one of the following:

  • approved - We approved the funding account.
  • rejected - We rejected the funding account.
  • pending - We have not yet approved the funding account.
  • hold - Our Risk team have temporarily placed a hold on the funding account.
Allowed values:
metadatamap from strings to stringsOptional

Metadata object you can use to include custom data with your request.

Response

Successful request. We created the funding account and added it to the funding recipient.

typeenum

Type of funding account.

Allowed values:
useenum

Indicates if we send funds or withdraw funds from the account.

  • credit - Send funds to the account.
  • debit - Withdraw funds from the account.
  • creditAndDebit - Send funds and withdraw funds from the account.
Allowed values:
nameOnAccountstring

Name of the account holder.

paymentMethodslist of objects

Array of paymentMethod objects.

fundingAccountIdintegerOptional

Unique identifier of the funding account.

createdDatestringOptionalformat: "date-time"

Date and time that we received your request to create the funding account in our system.

lastModifiedDatestringOptionalformat: "date-time"

Date and time that the funding account was last modified.

statusenumOptional

Status of the funding account. The value is one of the following:

  • approved - We approved the funding account.
  • rejected - We rejected the funding account.
  • pending - We have not yet approved the funding account.
  • hold - Our Risk team have temporarily placed a hold on the funding account.
Allowed values:
metadatamap from strings to stringsOptional

Metadata object you can use to include custom data with your request.