Skip to main content
POST
/
payment-methods
/
{id}
/
document
cURL
curl -X POST \
 /payment-methods/{id}/document \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "id": "",
    "customer": "https:\/\/example.com\/",
    "gatewayName": "",
    "type": "",
    "referenceId": "",
    "customerReferenceId": "",
    "default": "",
    "status": "active",
    "source": "api",
    "enabled": "",
    "isInternal": "",
    "name": "",
    "data": [
        ""
    ],
    "creationDate": "",
    "expirationDate": "",
    "notifications": [
        "https:\/\/example.com\/"
    ],
    "webhookResults": [
        "https:\/\/example.com\/"
    ],
    "gateway": "",
    "internal": "",
    "expired": "",
    "verified": "",
    "gatewayData": [
        ""
    ],
    "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": "",
    "tenantId": ""
}'
{
  "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

​
Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

​
id
string
required

PaymentMethod identifier

Body

The new PaymentMethod resource

​
customer
string<iri-reference>
Example:

"https://example.com/"

​
gatewayName
enum<string>
Available options:
wallet,
sepa_debit,
stripe,
fake_provider,
paypal,
bank_transfer,
go_cardless,
testing
​
type
enum<string> | null
Available options:
sepa_debit,
card,
paypal,
bank_transfer,
wallet,
fake_provider
​
referenceId
string | null
​
customerReferenceId
string | null
​
default
boolean
​
status
enum<string>
default:active
Available options:
active,
action_required,
expired,
revoked,
gateway_unconfigured
Example:

"active"

​
source
enum<string>
default:api
Available options:
checkout,
customerfront,
api,
add_link
Example:

"api"

​
enabled
boolean
​
isInternal
boolean
​
name
string | null
​
data
string[]
​
expirationDate
string<date-time> | null
​
notifications
string<iri-reference>[]
​
webhookResults
string<iri-reference>[]
​
gatewayData
string[]

Response

PaymentMethod resource created

​
id
string
​
customer
string<iri-reference>
Example:

"https://example.com/"

​
gatewayName
enum<string>
Available options:
wallet,
sepa_debit,
stripe,
fake_provider,
paypal,
bank_transfer,
go_cardless,
testing
​
type
enum<string> | null
Available options:
sepa_debit,
card,
paypal,
bank_transfer,
wallet,
fake_provider
​
referenceId
string | null
​
default
boolean
​
status
enum<string>
default:active
Available options:
active,
action_required,
expired,
revoked,
gateway_unconfigured
Example:

"active"

​
source
enum<string>
default:api
Available options:
checkout,
customerfront,
api,
add_link
Example:

"api"

​
enabled
boolean
​
name
string | null
​
data
string[]
​
creationDate
string<date-time>
​
expirationDate
string<date-time> | null
​
sepaMandate
object | null

The sepa mandate of the payment method, if the gatewayName is "payment_sepa"

​
card
object

The card data of the payment method, if the type is "card"

​
sepaDebit
object

The sepa mandate data of the payment method, if the type is "sepa_debit"

​
paypal
object

The paypal data of the payment method, if the type is "paypal"

​
expirationInDays
integer | null
⌘I