Create a CustomerPaymentAccount

post

https://api.instellix.io/v2/customer-payment-accounts

Create a new CustomerPaymentAccount for a specific debtor

Body Params

A CustomerPaymentAccount with payment details that is assigned to a specific debtorIdent.

accountCreationDate

date-time | null

Date when the payment account was created at the payment provider. Required e.g. for some external mandate managements in the SEPA environment.

accountHolderName

string | null

Account holder name used for the charging. Size must be between 0 and 255.

debtorIdent

string

required

length between 1 and 100

Unique external reference to identify the Debtor. Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

displayName

string | null

Name for the customer payment account displayed on invoices. Do not send full payment data like credit card no, IBAN, etc. (e.g. "**** **** *** *234"). Size must be between 0 and 255.

ident

string | null

Unique identifier of a customer payment account, autogenerated by Nitrobox if omitted. Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

merchantPaymentGatewayIdent

string

required

length between 1 and 100

Unique reference to identify the merchant payment gateway that is associated with this account. Must not be null. Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

name

string | null

deprecated

DEPRECATED. Name of the customer payment account. Size must be between 0 and 255.

paymentCardType

string | null

The vendor of the credit card. Must be one of:


VISA
MASTERCARD
JCB
AMERICANEXPRESS
DINERSCLUB
OTHER
YANDEXBANKCARD
DISCOVERCARD
CARTE_BANCAIRE

paymentMethod

string | null

Payment method associated with the customerPaymentAccount via the paymentProviderReference. The specification is only for further explanation and has no effect on the actual selection of the payment method. This is determined entirely by specifying the paymentProviderReference or additionally by the paymentMethodReference. Must be one of:


DIRECT_DEBIT
CREDIT_CARD
PAY_PAL

paymentMethodReference

string | null

External reference to identify the authorization or mandate of the payment method at the payment provider. This is optional because some payment providers require a general customer reference (paymentProviderReference) and a payment method reference (paymentMethodReference) in order to process a payment. Size must be between 0 and 255.

paymentProviderReference

string

required

length ≤ 255

External reference to identify the account at the payment provider. For example the IBAN when using DIRECT_DEBIT as PaymentProviderType. Must not be null. Size must be between 0 and 255.

Responses

201The request has been fulfilled, resulting in the creation of a new resource.

4XXerror response for all http error codes in range 4XX

5XXerror response for all http error codes in range 5XX