SFTP Payment Methods

Creating and updating payment methods via SFTP bulk operations.

The /payment-methods folder allows you to create or update payment methods in bulk via SFTP. This is useful for migrating existing payment data or onboarding large customer bases.

File Format

Upload CSV files to the /payment-methods folder. The CSV should use dot notation to match the Payment Method Creation API structure.

Required Fields

FieldDescriptionRequiredExample
customer_refCustomer reference IDYesCUST001
typePayment method typeYesCreditCard, ACH, Token
ownerNamePayment method owner nameYesJohn Doe
address.streetStreet addressNo123 Main St
address.cityCityNoSpringfield
address.stateState/provinceNoIL
address.zipZIP/postal codeNo62701
address.countryCountry codeNoUS

Type-Specific Fields

CreditCard

FieldDescriptionRequired
traits.cardNumberFull card numberYes
traits.expirationMonthExpiration month (1-12)Yes
traits.expirationYearExpiration year (YYYY)Yes
traits.cvvCVV codeNo

ACH

FieldDescriptionRequired
subTypeAccount typeYes
traits.routingNumberBank routing numberYes
traits.accountNumberBank account numberYes

Token

FieldDescriptionRequired
tokenToken identifierYes
originatingIdOriginal payment method IDNo
traits.tokenTypeType of underlying payment methodNo
traits.providerToken providerNo

Example CSV

customer_ref,type,ownerName,address.street,address.city,address.state,address.zip,address.country,traits.cardNumber,traits.expirationMonth,traits.expirationYear,traits.cvv
CUST001,CreditCard,John Doe,123 Main St,Springfield,IL,62701,US,4111111111111111,12,2028,123
CUST002,ACH,Jane Smith,456 Elm St,Metropolis,NY,10001,US,021000021,123456789,,
CUST003,Token,Alice Johnson,789 Oak Ave,Gotham,NJ,07001,US,tok_abc123,,,,

Processing

For each valid record:

  1. Customer lookup: Verify customer exists
  2. Payment method creation: Create payment method via API
  3. Token creation: Generate tokens if auto-tokenization enabled
  4. Permission setup: Establish proper permissions
  5. Status update: Mark record as processed

Error Codes

CodeDescriptionResolution
CUSTOMER_NOT_FOUNDCustomer reference not foundVerify customer exists
INVALID_CARD_NUMBERInvalid credit card numberCheck card number format
EXPIRED_CARDCard has expiredUpdate expiration date
INVALID_ROUTING_NUMBERInvalid ACH routing numberVerify routing number
DUPLICATE_PAYMENT_METHODPayment method already existsCheck for duplicates
INVALID_TOKENInvalid token formatVerify token format