Create a bank account

External bank accounts are financial accounts associated with a Paypercut platform’s accounts for the purpose of transferring funds to or from the account’s Paypercut balance.

Path Parameters
  • account_id
    Type: string
    required

    The identifier of the account.

Body·
required
application/json

External bank accounts are financial accounts associated with a Paypercut platform’s accounts for the purpose of transferring funds to or from the account’s Paypercut balance.

  • default_for_currency
    Type: boolean

    When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.

  • metadata

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    • propertyName
      Type: string
  • external_account
    • object
      Discriminator
      enum
      const:  
      bank_account
      required
      values
      • bank_account
    • country
      Type: string
      min length:  
      2
      max length:  
      2
      required
    • currency
      Type: string | null

      Optional merchant-declared currency hint captured at attach time.

    • bank_name
      Type: string | null
    • holder_name
      Type: string
      required
    • holder_type
      Type: string enum
      required
      values
      • individual
      • company
    • numbers
      required
Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/v1/accounts/{account_id}/external_accounts
curl 'https://api.paypercut.io/v1/accounts/{account_id}/external_accounts' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "default_for_currency": true,
  "metadata": {
    "additionalProperty": ""
  },
  "external_account": {
    "object": "bank_account",
    "country": "DE",
    "currency": "EUR",
    "bank_name": "Example Bank",
    "holder_name": "Acme GmbH",
    "holder_type": "individual",
    "numbers": {
      "scheme": "iban",
      "iban": "DE89370400440532013000",
      "bic": "COBADEFFXXX"
    }
  }
}'
{
  "default_for_currency": true,
  "metadata": {
    "additionalProperty": "string"
  },
  "external_account": {
    "id": "ba_123",
    "object": "bank_account",
    "country": "DE",
    "currency": "EUR",
    "bank_name": "Example Bank",
    "holder_name": "Acme GmbH",
    "holder_type": "individual",
    "account_number": "**** 5678",
    "routing_number": "BNBGBGSF",
    "last4": "5678"
  }
}