API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
- Settings
- Media
- Webhook
- Notification
Payment
- Payment Method
- Transaction
- SEPA XML
- Open Banking
- Bank Account Transaction
Customer
- Customer
- Customer Address
- Customer Email
- Customer Settings
- Customer Otp
Billing
- Invoice
- Invoice Position Item
- Billing Run
Dunning
- Dunning Document
- Dunning Rule
Subscription
- Subscription
- Subscription Item
- Subscription Measurement
- Billing Group
Offers
- Offer
- Offer Recipient
- Offer Template
Catalogue
- Unit
- Measurement
- Product
- Product Family
- Price Plan
- Coupon
Checkout
- Checkout Link
- Cart
Accounting
Payment Method
Create payment method
Create a customer’s payment method
Required permissions:payment-method:add
POST
/
payment-methods
curl -X POST \
/payment-methods \
--header "Content-Type: application/json" \
--header "Authorization: Bearer <token>" \
--data '{
"summary": "Create stripe setup intent",
"description": "The stripe setup intent clientSecret is required to add a stripe credit card payment method. The clientSecret is required to collect credit card data with stripe.js elements.",
"value": {
"gateway": "stripe",
"type": "card",
"customerId": "ad8f7a8d-8f7a-8d8f-7a8d8f7a8d8f",
"isDefault": true,
"futureUsageAllowed": true,
"stripe": {
"paymentMethodId": null,
"customerId": null
}
}
}'
{
"status": "action_required",
"actionRequired": {
"action": "client_site_action",
"details": {
"clientSecret": "test_1234567890",
"publishableKey": "pk_test_1234567890",
"accountId": "acct_1234567890"
}
},
"failReason": "<string>",
"paymentMethod": {
"id": "<string>",
"customer": "https://example.com/",
"gatewayName": "wallet",
"type": "sepa_debit",
"referenceId": "<string>",
"default": true,
"status": "active",
"source": "api",
"enabled": true,
"name": "<string>",
"data": [
"<string>"
],
"creationDate": "2023-11-07T05:31:56Z",
"expirationDate": "2023-11-07T05:31:56Z",
"sepaMandate": {
"id": "ad8f0b9c-0b1a-4e1a-8b0a-0b1a4e1a8b0a",
"status": "active",
"creditorIdentifier": "<string>",
"mandateReference": "MNDT-2021-0001",
"bankAccount": {
"id": "ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c",
"iban": "DE12500105170648489890",
"bic": "PBNKDEFFXXX",
"accountHolder": "Max Mustermann",
"bankName": "Commerzbank"
},
"sequenceType": "FRST",
"sepaType": "core"
},
"card": {
"brand": "Visa",
"last4": "4242",
"expMonth": 12,
"expYear": 2022,
"cardHolder": "Max Mustermann"
},
"sepaDebit": {
"iban": "DE8937*********3232",
"bic": "COBADEFFXXX",
"mandateReference": "MNDT-2021-123456",
"signingDate": "2021-01-01T00:00:00+00:00"
},
"paypal": {
"email": "max@mustermann.de",
"billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
},
"expirationInDays": 123
}
}
Authorizations
Value for the Authorization header parameter.
Body
The new PaymentMethod resource
Response
201
application/json
PaymentMethod resource created
Was this page helpful?
curl -X POST \
/payment-methods \
--header "Content-Type: application/json" \
--header "Authorization: Bearer <token>" \
--data '{
"summary": "Create stripe setup intent",
"description": "The stripe setup intent clientSecret is required to add a stripe credit card payment method. The clientSecret is required to collect credit card data with stripe.js elements.",
"value": {
"gateway": "stripe",
"type": "card",
"customerId": "ad8f7a8d-8f7a-8d8f-7a8d8f7a8d8f",
"isDefault": true,
"futureUsageAllowed": true,
"stripe": {
"paymentMethodId": null,
"customerId": null
}
}
}'
{
"status": "action_required",
"actionRequired": {
"action": "client_site_action",
"details": {
"clientSecret": "test_1234567890",
"publishableKey": "pk_test_1234567890",
"accountId": "acct_1234567890"
}
},
"failReason": "<string>",
"paymentMethod": {
"id": "<string>",
"customer": "https://example.com/",
"gatewayName": "wallet",
"type": "sepa_debit",
"referenceId": "<string>",
"default": true,
"status": "active",
"source": "api",
"enabled": true,
"name": "<string>",
"data": [
"<string>"
],
"creationDate": "2023-11-07T05:31:56Z",
"expirationDate": "2023-11-07T05:31:56Z",
"sepaMandate": {
"id": "ad8f0b9c-0b1a-4e1a-8b0a-0b1a4e1a8b0a",
"status": "active",
"creditorIdentifier": "<string>",
"mandateReference": "MNDT-2021-0001",
"bankAccount": {
"id": "ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c",
"iban": "DE12500105170648489890",
"bic": "PBNKDEFFXXX",
"accountHolder": "Max Mustermann",
"bankName": "Commerzbank"
},
"sequenceType": "FRST",
"sepaType": "core"
},
"card": {
"brand": "Visa",
"last4": "4242",
"expMonth": 12,
"expYear": 2022,
"cardHolder": "Max Mustermann"
},
"sepaDebit": {
"iban": "DE8937*********3232",
"bic": "COBADEFFXXX",
"mandateReference": "MNDT-2021-123456",
"signingDate": "2021-01-01T00:00:00+00:00"
},
"paypal": {
"email": "max@mustermann.de",
"billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
},
"expirationInDays": 123
}
}
Assistant
Responses are generated using AI and may contain mistakes.