HomeDocumentationRecipesAPI ReferenceChangelog
Platform OverviewDemoContactImprintLog In
API Reference
Platform OverviewDemoContactImprint

Create a CustomerPaymentAccount

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

Create a new CustomerPaymentAccount for a specific debtor.

Query Params
string
enum

Optional query parameter action: - replaceFailedPaymentIntents: Replace failed payment intents of the debtor after the account has been persisted. Newly created payment intents reference this CustomerPaymentAccount. Actions are processed asynchronously. Unknown values are rejected with HTTP 400.

Allowed:
Body Params
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.

string | null

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

string
required
length between 1 and 100
^[a-zA-Z0-9_.~-]*$

Unique external reference to identify the Debtor.
Must not be null.
Size must be between 1 and 100.
Must match with the regular expression '^[a-zA-Z0-9_.~-]*$'.

string | null

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

string | null
^[a-zA-Z0-9_.~-]*$

Unique identifier of a customer payment account, autogenerated by Nitrobox if omitted.
Size must be between 1 and 100.
Must match with the regular expression '^[a-zA-Z0-9_.~-]*$'.

string
required
length between 1 and 100
^[a-zA-Z0-9_.~-]*$

Unique reference to identify the merchant payment gateway that is associated with this account.
Must not be null.
Size must be between 1 and 100.
Must match with the regular expression '^[a-zA-Z0-9_.~-]*$'.

string | null
deprecated

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

string | null

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

VISA
MASTERCARD
JCB
AMERICANEXPRESS
DINERSCLUB
OTHER
YANDEXBANKCARD
DISCOVERCARD
CARTE_BANCAIRE
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
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.

string
required
length between 1 and 255
^\S(.*\S)?$

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 1 and 255.
Must match with the regular expression '^\S(.*\S)?$'.

properties
array of objects | null

Additional properties of the customer payment account.

properties
Responses

Updated 4 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?