---
title: "Set payment details"
method: POST
path: "/billing/paymentmethods/setforcustomer/"
tags: ["Payments (PaymentMethods)"]
---

# Set payment details

`POST /billing/paymentmethods/setforcustomer/`

To generate a SingleUseToken use payments.js - https://help.sumit.co.il/he/articles/5893615

## Headers

- `Content-Language` unknown

## Request body

- OfficeGuyAppsBillingMVCAPIPaymentMethodsControllerPaymentMethodsSetForCustomerRequest
  - `Credentials` CoreAPICredentials, required
    - `CompanyID` integer, required — Company identifier
    - `APIKey` string, required — API key secret
  - `Customer` AccountingTypedCustomer, required
    - `ID` integer, nullable — SUMIT identifier Leave empty to create a new entity or search by other fields when applicable
    - `Folder` string, nullable — Folder identifier. Can be either application folder name, or FolderID.
    - `Properties` object, nullable — Entity fields
    - `Name` string, nullable — Customer full name (or company name) Required for creating new customer (Leave empty to search by other fields)
    - `Phone` string, nullable — Customer phone number (Optional field)
    - `EmailAddress` string, nullable — Customer email address (Optional field)
    - `City` string, nullable — Customer city (Optional field)
    - `Address` string, nullable — Customer address (Optional field)
    - `ZipCode` string, nullable — Customer ZipCode (Optional field)
    - `CompanyNumber` string, nullable — Customer registered company number (VAT number) (Optional field)
    - `ExternalIdentifier` string, nullable — Customer external identifier. External identifier from calling application. Optional field
    - `NoVAT` boolean, nullable — NoVAT indication Set to true for VAT exempt customers Defaults to False
    - `SearchMode` 'Automatic (0)' | 'None (1)' | 'ExternalIdentifier (2)' | 'Name (3)' | 'CompanyNumber (4)' | 'Phone (5)' | 'EmailAddress (6)' — Customer searching mode
  - `PaymentMethod` OfficeGuyAppsBillingMVCAPITypedPaymentMethod
    - `ID` integer, nullable
    - `CustomerID` integer, nullable
    - `CreditCard_Number` string, nullable — Credit card full number Required for credit card
    - `CreditCard_LastDigits` string, nullable — Credit card last 4 digits Shouldn't be input by API caller
    - `CreditCard_ExpirationMonth` integer, nullable — Credit card expiration month (1-2 digits) Required for credit card
    - `CreditCard_ExpirationYear` integer, nullable — Credit card expiration year (4 digits) Required for credit card
    - `CreditCard_CVV` string, nullable — Credit card CVV/CVV2 Required when CVV is required by credit company
    - `CreditCard_Track2` string, nullable — Credit card Track2
    - `CreditCard_CitizenID` string, nullable — Credit card owner Israel Citizen ID / Passport Number Required when Citizen ID is required by credit company
    - `CreditCard_CardMask` string, nullable — Credit card mask Shouldn't be input by API caller
    - `CreditCard_Token` string, nullable — Credit card token
    - `DirectDebit_Bank` integer, nullable — Direct debit bank number For instance, 12 indicates Bank Hapoalim.
    - `DirectDebit_Branch` integer, nullable — Direct debit bank branch number
    - `DirectDebit_Account` integer, nullable — Direct debit bank account number
    - `DirectDebit_ExpirationDate` string, date-time, nullable — Direct debit expiration date
    - `DirectDebit_MaximumAmount` integer, nullable — Direct debit maximum charge amount
    - `Type` 'Other (0)' | 'CreditCard (1)' | 'DirectDebit (2)'
  - `SingleUseToken` string, nullable — Single use token, for all payment details (CardNumber, Expiration, CVV, CitizenID). Used primarily by the Payments JavaScript API.

## Response `200`

OK

- ResponseOfficeGuyAppsBillingMVCAPIPaymentMethodsControllerPaymentMethodsSetForCustomerResponse
  - `Status` 'Success (0)' | 'BusinessError (1)' | 'TechnicalError (2)'
  - `UserErrorMessage` string, nullable — Error message, in a user readable format
  - `TechnicalErrorDetails` string, nullable — Technical error details, let us know if you received this.
  - `Data` OfficeGuyAppsBillingMVCAPIPaymentMethodsControllerPaymentMethodsSetForCustomerResponse
    - `CustomerID` integer — Customer ID
    - `PaymentMethod` OfficeGuyAppsBillingMVCAPITypedPaymentMethod
      - `ID` integer, nullable
      - `CustomerID` integer, nullable
      - `CreditCard_Number` string, nullable — Credit card full number Required for credit card
      - `CreditCard_LastDigits` string, nullable — Credit card last 4 digits Shouldn't be input by API caller
      - `CreditCard_ExpirationMonth` integer, nullable — Credit card expiration month (1-2 digits) Required for credit card
      - `CreditCard_ExpirationYear` integer, nullable — Credit card expiration year (4 digits) Required for credit card
      - `CreditCard_CVV` string, nullable — Credit card CVV/CVV2 Required when CVV is required by credit company
      - `CreditCard_Track2` string, nullable — Credit card Track2
      - `CreditCard_CitizenID` string, nullable — Credit card owner Israel Citizen ID / Passport Number Required when Citizen ID is required by credit company
      - `CreditCard_CardMask` string, nullable — Credit card mask Shouldn't be input by API caller
      - `CreditCard_Token` string, nullable — Credit card token
      - `DirectDebit_Bank` integer, nullable — Direct debit bank number For instance, 12 indicates Bank Hapoalim.
      - `DirectDebit_Branch` integer, nullable — Direct debit bank branch number
      - `DirectDebit_Account` integer, nullable — Direct debit bank account number
      - `DirectDebit_ExpirationDate` string, date-time, nullable — Direct debit expiration date
      - `DirectDebit_MaximumAmount` integer, nullable — Direct debit maximum charge amount
      - `Type` 'Other (0)' | 'CreditCard (1)' | 'DirectDebit (2)'

---

[API](https://skmtc.net/myofficeguy/apis/sumit-api-full.md) · [All operations](https://skmtc.net/myofficeguy/apis/sumit-api-full/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/myofficeguy/sumit-api-full/versions/2691e6cffa0c/schema)