---
title: "POST /api/customers/{id}/payment-methods"
method: POST
path: "/api/customers/{id}/payment-methods"
tags: ["api", "customer-payment-methods"]
---

# POST /api/customers/{id}/payment-methods

`POST /api/customers/{id}/payment-methods`

Create a customer payment method

## Path parameters

- `id` string, required

## Request body

- union
  - object
    - `data` object, required
      - `iban` unknown, required
      - `bic` unknown, required
      - `accountHolderName` string, required — The account holder name of the customer payment method.
    - `gatewayId` string, required — The ID of the payment gateway or additional payment method which the payment method belongs to
  - object
    - `data` object, required
      - `accountNumber` unknown, required
      - `routingNumber` unknown, required
      - `accountHolderName` string, required — The account holder name of the customer payment method.
    - `gatewayId` string, required — The ID of the payment gateway or additional payment method which the payment method belongs to
  - object
    - `data` object, required
      - `bankCode` unknown, required
      - `branchCode` unknown, required
      - `accountNumber` unknown, required
      - `accountHolderName` string, required — The account holder name of the customer payment method.
    - `gatewayId` string, required — The ID of the payment gateway or additional payment method which the payment method belongs to
  - object
    - `gatewayId` string, required — The ID of the payment gateway or additional payment method which the payment method belongs to
    - `data` object — The payment-method specific payload.

## Response `201`

Created

- CustomerPaymentMethodResource
  - `_id` string, required — The ID of the payment method
  - `status` 'ACTIVE' | 'DELETED' | 'EXPIRED', required — The status of the payment method
  - `sellerId` string, required — The ID of the seller this payment method
  - `data` object — Whether the payment method is primary
  - `paymentDetails` object — Whether the payment method is primary
  - `primary` boolean, required — Whether the payment method is primary
  - `active` boolean, required — Whether the payment method is primary
  - `gatewayType` 'stripe' | 'paypal' | 'adyen' | 'custom' | 'cardconnect' | 'worldline' | 'shift4' | 'authorizenet' | 'wallee' | 'square' | 'payfast' | 'touchnet' | 'transact' | 'unzer' | 'monext' | 'vivenuPayments' | 'ebanx' | 'rapyd' | 'momentusPayments' | 'additional-payment-method' — The type of the payment gateway associated to this method
  - `gatewayId` string, required — The ID of the attached payment gateway or additional payment method
  - `channels` union[] — The type of the customer payment method
    - union
      - boolean
      - number
      - object
      - string
      - boolean
      - number
      - object
      - string
  - `createdAt` string, date-time — The created ISO timestamp
  - `updatedAt` string, date-time — The last updated ISO timestamp

## Other responses

- `400` — Bad Request
- `401` — Unauthorized

---

[API](https://skmtc.net/vivenu/apis/vivenu-api.md) · [All operations](https://skmtc.net/vivenu/apis/vivenu-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vivenu/vivenu-api/revisions/36be0dca14e7/schema)