---
title: "Add new payment details for user"
method: POST
path: "/api/v2/organizations/{orgSlug}/payment-details"
tags: ["Payment Details"]
---

# Add new payment details for user

`POST /api/v2/organizations/{orgSlug}/payment-details`

## Request

- Base URL: `https://app.officernd.com`
- URL: `https://app.officernd.com/api/v2/organizations/{orgSlug}/payment-details`
- Auth: OAuth 2
  - Authorization code: `https://identity.officernd.com/auth/authorize`
  - Client credentials
  - Token URL: `https://identity.officernd.com/auth/token` scopes: `flex.billing.paymentDetails.create`

Add payment details object. When recording payment details for             a company, said company must have at least one billing person in order for the card to be recorded. 

 Required scopes: `flex.billing.paymentDetails.create`

## Path parameters

- `orgSlug` string, required

## Request body

- AddPaymentDetailsDto
  - `type` 'stripe', required: The payment provider type. Currently only Stripe is supported.
  - `method` 'card', required: The method of the payment details.
  - `data` string, required: The token of the card that will be recorded. This can be procured by using Stripe's /tokens API.
  - `isPersonal` boolean, required: Determines whether the card is recorded for the member themselves or for their company.
  - `member` string: The member for which the card is recorded.
  - `company` string: The company for which the card is recorded.

## Response `201`

- PaymentDetailsResultDto
  - `_id` string: The _id of the payment details.
  - `details` union: An object containing the payment method details (card or ACH bank account).
    - StripeDetailsResultDto
      - `id` string: The id of the card in Stripe.
      - `name` string: The name of the card's owner.
      - `brand` string: The name of the card's owner.
      - `funding` string: The type of card, e.g. a credit card.
      - `expirationMonth` number: The expiration month of the card.
      - `expirationYear` number: The expiration year of the card.
      - `country` string: The country with which the card is associated.
      - `cvcCheck` string: The result of the CVC check. It should always be set to 'pass', if the card is created.
      - `last4` string: The last 4 digits of the card.
    - AchDetailsResultDto
      - `id` string: The id of the bank account in Stripe.
      - `name` string: The name of the account holder.
      - `last4` string: The last 4 digits of the bank account.
      - `bankName` string: Name of the bank.
      - `accountHolderType` string: Type of account holder (individual or company).
      - `accountType` string: Type of account (checking or savings).
      - `status` string: Status of the bank account.
  - `authorization` PaymentDetailsAuthorizationResultDto
    - `authProvider` string: The id of the auth provider
    - `status` string: The status of the auth
  - `type` 'stripe': The payment provider type. Currently only Stripe is supported.
  - `method` 'card' | 'ach': The payment method type. Used to calculate any method-specific processing fees in the summary.
  - `paymentCustomer` string: The _id of the card in Stripe. Same as the _id in the "card" object.
  - `paymentSource` string: The _id of the card in Stripe. Same as the _id in the "card" object.
  - `locations` string: An array containing the list of locations for which the payment details are valid.
  - `createdAt` string, date-time: The time when the payment details were created
  - `createdBy` string: The _id user that created the payment details

---

[API](https://skmtc.dev/officernd/apis/billing-product-api.md) - [All operations](https://skmtc.dev/officernd/apis/billing-product-api/llms.txt) - [OpenAPI document](https://skmtc.dev/officernd/apis/billing-product-api/revisions/78f9c9851fb0?raw)