Skip to main content
POST
/
v1
/
payment-means
Create a new payment means
curl --request POST \
  --url https://api.wellapp.ai/v1/payment-means \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "payment_means",
  "attributes": {
    "type": "account_details",
    "scheme": "ACH",
    "status": "active",
    "account_details": {
      "account_number": "1234567890",
      "routing_number": "021000021",
      "account_type": "checking",
      "currency": "USD"
    },
    "bank_details": {
      "bank_name": "JPMorgan Chase Bank, N.A.",
      "bank_code": "CHASUS33",
      "branch_name": "New York Main Branch",
      "branch_code": "NY001"
    },
    "compliance": {
      "kyc_status": "verified",
      "aml_status": "cleared"
    },
    "nickname": "US Operating Account",
    "description": "Primary USD account for US operations",
    "tags": [
      "usd",
      "operating",
      "us",
      "primary"
    ]
  },
  "relationships": {
    "holder": {
      "data": {
        "type": "company",
        "id": "holder-company-1"
      }
    },
    "account_location": {
      "data": {
        "type": "location",
        "id": "bank-location-1"
      }
    },
    "holder_location": {
      "data": {
        "type": "location",
        "id": "holder-location-1"
      }
    },
    "bank": {
      "data": {
        "type": "company",
        "id": "bank-company-1"
      }
    },
    "intermediary_banks": {
      "data": [
        {
          "type": "company",
          "id": "intermediary-bank-1"
        }
      ]
    },
    "ultimate_beneficiary": {
      "data": {
        "type": "people",
        "id": "beneficiary-person-1"
      }
    },
    "created_by": {
      "data": {
        "type": "people",
        "id": "creator-person-1"
      }
    },
    "documents": {
      "data": [
        {
          "type": "document",
          "id": "bank-statement-1"
        },
        {
          "type": "document",
          "id": "verification-letter-1"
        }
      ]
    },
    "transactions": {
      "data": [
        {
          "type": "transaction",
          "id": "recent-transaction-1"
        }
      ]
    },
    "linked_payment_means": {
      "data": [
        {
          "type": "payment_means",
          "id": "corporate-card-1"
        }
      ]
    }
  },
  "included": [
    {
      "type": "company",
      "id": "holder-company-1",
      "attributes": {
        "name": "ACME Corporation",
        "description": "Technology solutions provider",
        "registration": {
          "registered_name": "ACME Corporation Inc.",
          "trade_name": "ACME"
        },
        "tax_id": {
          "value": "12-3456789",
          "type": "EIN"
        }
      }
    },
    {
      "type": "location",
      "id": "bank-location-1",
      "attributes": {
        "street": "270 Park Avenue",
        "city": "New York",
        "state": "NY",
        "postal_code": "10017",
        "country": "US",
        "is_primary": true
      }
    },
    {
      "type": "location",
      "id": "holder-location-1",
      "attributes": {
        "street": "123 Business Avenue",
        "city": "New York",
        "state": "NY",
        "postal_code": "10001",
        "country": "US",
        "is_primary": true
      }
    },
    {
      "type": "company",
      "id": "bank-company-1",
      "attributes": {
        "name": "JPMorgan Chase Bank",
        "description": "Major US financial institution",
        "registration": {
          "registered_name": "JPMorgan Chase Bank, N.A."
        },
        "tax_id": {
          "value": "13-2624428",
          "type": "EIN"
        }
      }
    },
    {
      "type": "company",
      "id": "intermediary-bank-1",
      "attributes": {
        "name": "Wells Fargo Bank",
        "description": "Intermediary bank for routing",
        "registration": {
          "registered_name": "Wells Fargo Bank, N.A."
        }
      }
    },
    {
      "type": "people",
      "id": "beneficiary-person-1",
      "attributes": {
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "date_of_birth": "1980-05-15"
      }
    },
    {
      "type": "people",
      "id": "creator-person-1",
      "attributes": {
        "first_name": "John",
        "last_name": "Smith",
        "full_name": "John Smith"
      }
    },
    {
      "type": "document",
      "id": "bank-statement-1",
      "attributes": {
        "name": "Bank Statement January 2025.pdf",
        "file_size": 245678,
        "content_type": "application/pdf"
      }
    },
    {
      "type": "document",
      "id": "verification-letter-1",
      "attributes": {
        "name": "Account Verification Letter.pdf",
        "file_size": 123456,
        "content_type": "application/pdf"
      }
    },
    {
      "type": "transaction",
      "id": "recent-transaction-1",
      "attributes": {
        "amount": {
          "value": 5000,
          "currency": "USD"
        },
        "description": "Monthly supplier payment",
        "transaction_date": "2025-01-15T00:00:00.000Z",
        "status": "completed"
      }
    },
    {
      "type": "payment_means",
      "id": "corporate-card-1",
      "attributes": {
        "type": "card",
        "nickname": "Corporate Visa Card",
        "scheme": "visa",
        "status": "active",
        "card_details": {
          "last_four": "1234",
          "expiry_month": 12,
          "expiry_year": 2026,
          "cardholder_name": "ACME CORPORATION"
        }
      }
    }
  ]
}'
{
  "data": {
    "type": "payment_means",
    "id": "pm-550e8400-e29b-41d4-a716-446655440099",
    "attributes": {
      "type": "account_details",
      "scheme": "ACH",
      "status": "active",
      "account_details": {
        "account_number": "1234567890",
        "routing_number": "021000021",
        "account_type": "checking",
        "currency": "USD"
      },
      "bank_details": {
        "bank_name": "JPMorgan Chase Bank, N.A.",
        "bank_code": "CHASUS33",
        "branch_name": "New York Main Branch",
        "branch_code": "NY001"
      },
      "compliance": {
        "kyc_status": "verified",
        "aml_status": "cleared",
        "sanctions_check": "passed",
        "last_compliance_check": "2025-01-15T10:00:00.000Z"
      },
      "metadata": {
        "source": "api",
        "external_id": null,
        "last_used_at": null,
        "usage_count": 0
      },
      "nickname": "US Operating Account",
      "description": "Primary USD account for US operations",
      "tags": [
        "usd",
        "operating",
        "us",
        "primary"
      ],
      "is_primary": true,
      "is_verified": true,
      "created_at": "2025-01-15T10:00:00.000Z",
      "updated_at": "2025-01-15T10:00:00.000Z"
    },
    "relationships": {
      "holder": {
        "data": {
          "type": "company",
          "id": "550e8400-e29b-41d4-a716-446655440001"
        }
      },
      "account_location": {
        "data": {
          "type": "location",
          "id": "550e8400-e29b-41d4-a716-446655440101"
        }
      },
      "holder_location": {
        "data": {
          "type": "location",
          "id": "550e8400-e29b-41d4-a716-446655440102"
        }
      },
      "bank": {
        "data": {
          "type": "company",
          "id": "550e8400-e29b-41d4-a716-446655440103"
        }
      },
      "intermediary_banks": {
        "data": [
          {
            "type": "company",
            "id": "550e8400-e29b-41d4-a716-446655440104"
          }
        ]
      },
      "ultimate_beneficiary": {
        "data": {
          "type": "people",
          "id": "550e8400-e29b-41d4-a716-446655440201"
        }
      },
      "created_by": {
        "data": {
          "type": "people",
          "id": "550e8400-e29b-41d4-a716-446655440202"
        }
      },
      "documents": {
        "data": [
          {
            "type": "document",
            "id": "550e8400-e29b-41d4-a716-446655440301"
          },
          {
            "type": "document",
            "id": "550e8400-e29b-41d4-a716-446655440302"
          }
        ]
      },
      "transactions": {
        "data": [
          {
            "type": "transaction",
            "id": "550e8400-e29b-41d4-a716-446655440401"
          }
        ]
      },
      "linked_payment_means": {
        "data": [
          {
            "type": "payment_means",
            "id": "550e8400-e29b-41d4-a716-446655440501"
          }
        ]
      }
    },
    "included": [
      {
        "type": "company",
        "id": "550e8400-e29b-41d4-a716-446655440001",
        "attributes": {
          "name": "ACME Corporation",
          "description": "Technology solutions provider",
          "registration": {
            "registered_name": "ACME Corporation Inc.",
            "trade_name": "ACME"
          },
          "tax_id": {
            "value": "12-3456789",
            "type": "EIN"
          },
          "created_at": "2024-01-01T00:00:00.000Z",
          "updated_at": "2025-01-15T10:00:00.000Z"
        }
      },
      {
        "type": "location",
        "id": "550e8400-e29b-41d4-a716-446655440101",
        "attributes": {
          "street": "270 Park Avenue",
          "city": "New York",
          "state": "NY",
          "postal_code": "10017",
          "country": "US",
          "is_primary": true,
          "created_at": "2024-01-01T00:00:00.000Z",
          "updated_at": "2025-01-15T10:00:00.000Z"
        }
      },
      {
        "type": "location",
        "id": "550e8400-e29b-41d4-a716-446655440102",
        "attributes": {
          "street": "123 Business Avenue",
          "city": "New York",
          "state": "NY",
          "postal_code": "10001",
          "country": "US",
          "is_primary": true,
          "created_at": "2024-01-01T00:00:00.000Z",
          "updated_at": "2025-01-15T10:00:00.000Z"
        }
      },
      {
        "type": "company",
        "id": "550e8400-e29b-41d4-a716-446655440103",
        "attributes": {
          "name": "JPMorgan Chase Bank",
          "description": "Major US financial institution",
          "registration": {
            "registered_name": "JPMorgan Chase Bank, N.A."
          },
          "tax_id": {
            "value": "13-2624428",
            "type": "EIN"
          },
          "created_at": "2024-01-01T00:00:00.000Z",
          "updated_at": "2025-01-15T10:00:00.000Z"
        }
      },
      {
        "type": "company",
        "id": "550e8400-e29b-41d4-a716-446655440104",
        "attributes": {
          "name": "Wells Fargo Bank",
          "description": "Intermediary bank for routing",
          "registration": {
            "registered_name": "Wells Fargo Bank, N.A."
          },
          "created_at": "2024-01-01T00:00:00.000Z",
          "updated_at": "2025-01-15T10:00:00.000Z"
        }
      },
      {
        "type": "people",
        "id": "550e8400-e29b-41d4-a716-446655440201",
        "attributes": {
          "first_name": "Jane",
          "last_name": "Doe",
          "full_name": "Jane Doe",
          "date_of_birth": "1980-05-15",
          "created_at": "2024-01-01T00:00:00.000Z",
          "updated_at": "2025-01-15T10:00:00.000Z"
        }
      },
      {
        "type": "people",
        "id": "550e8400-e29b-41d4-a716-446655440202",
        "attributes": {
          "first_name": "John",
          "last_name": "Smith",
          "full_name": "John Smith",
          "created_at": "2024-01-01T00:00:00.000Z",
          "updated_at": "2025-01-15T10:00:00.000Z"
        }
      },
      {
        "type": "document",
        "id": "550e8400-e29b-41d4-a716-446655440301",
        "attributes": {
          "name": "Bank Statement January 2025.pdf",
          "file_size": 245678,
          "content_type": "application/pdf",
          "created_at": "2025-01-15T09:00:00.000Z",
          "updated_at": "2025-01-15T09:00:00.000Z"
        }
      },
      {
        "type": "document",
        "id": "550e8400-e29b-41d4-a716-446655440302",
        "attributes": {
          "name": "Account Verification Letter.pdf",
          "file_size": 123456,
          "content_type": "application/pdf",
          "created_at": "2025-01-15T09:30:00.000Z",
          "updated_at": "2025-01-15T09:30:00.000Z"
        }
      },
      {
        "type": "transaction",
        "id": "550e8400-e29b-41d4-a716-446655440401",
        "attributes": {
          "amount": {
            "value": 5000,
            "currency": "USD"
          },
          "description": "Monthly supplier payment",
          "transaction_date": "2025-01-15T00:00:00.000Z",
          "status": "completed",
          "created_at": "2025-01-15T08:00:00.000Z",
          "updated_at": "2025-01-15T08:30:00.000Z"
        }
      },
      {
        "type": "payment_means",
        "id": "550e8400-e29b-41d4-a716-446655440501",
        "attributes": {
          "type": "card",
          "scheme": "visa",
          "status": "active",
          "card_details": {
            "last_four": "1234",
            "expiry_month": 12,
            "expiry_year": 2026,
            "cardholder_name": "ACME CORPORATION",
            "nickname": "Corporate Visa Card",
            "is_primary": false,
            "created_at": "2024-06-01T00:00:00.000Z",
            "updated_at": "2025-01-15T10:00:00.000Z"
          }
        }
      }
    ]
  }
}

Headers

Authorization
string
required

Bearer token for authentication

Body

application/json
data
object
required

Response

Payment means created successfully

data
object
I