Upload a document for a payment method

Upload a document for a payment method, e.g. a signed sepa mandate

^{Required permissions: payment-method:write}

POST /payment-methods/{id}/document

cURL

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": "[e-mail]",
        "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
    },
    "expirationInDays": "",
    "tenantId": ""
}'

201

{
  "id": "c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b",
  "customer": "ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a",
  "gatewayName": "wallet",
  "type": "sepa_debit",
  "referenceId": "<string>",
  "default": true,
  "status": "active",
  "source": "api",
  "enabled": true,
  "name": "Visa (4242)",
  "data": [
    "<string>"
  ],
  "creationDate": "2024-01-15T10:30:00+00:00",
  "expirationDate": "2026-12-31T23:59:59+00:00",
  "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": "[e-mail]",
    "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
  },
  "expirationInDays": 365
}

Autorisierungen

Authorization · string · header · erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Pfadparameter

id · string · erforderlich

PaymentMethod identifier

Body

application/jsontext/html

The new PaymentMethod resource

Represents a payment method attached to a customer, such as a credit card, SEPA direct debit, PayPal, or bank transfer.

customer · string<uuid>

The ID of the customer that owns this payment method

Beispiel:

"ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a"

gatewayName · enum<string>

The payment gateway used to process the payment method

Verfügbare Optionen: wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing

type · enum<string> | null

The type of the payment method

Verfügbare Optionen: sepa_debit, card, paypal, bank_transfer, wallet, fake_provider, null

referenceId · string | null

The reference ID of the payment method at the payment gateway

customerReferenceId · string | null

The customer reference ID at the payment gateway

default · boolean

Whether this is the default payment method for the customer

Beispiel:

true

status · enum<string> · Standard: active

The current status of the payment method

Verfügbare Optionen: active, action_required, expired, revoked, gateway_unconfigured

Beispiel:

"active"

source · enum<string> · Standard: api

The source where the payment method was created

Verfügbare Optionen: checkout, customerfront, api, add_link

Beispiel:

"api"

enabled · boolean

Whether the payment method is enabled for use

Beispiel:

true

isInternal · boolean

Whether this is an internal payment method (e.g. wallet)

Beispiel:

false

name · string | null

Display name of the payment method

Beispiel:

"Visa (4242)"

data · string[]

Additional data associated with the payment method

expirationDate · string<date-time> | null

The expiration date of the payment method, if applicable

Beispiel:

"2026-12-31T23:59:59+00:00"

notifications · string<uuid>[]

List of notification IDs associated with this payment method

webhookResults · string<uuid>[]

List of webhook result IDs triggered by this payment method

gatewayData · string[]

Gateway-specific data for the payment method (write-only)

Antwort

201

application/json

PaymentMethod resource created

Payment method details returned when reading a payment method.

id · string

Unique identifier of the payment method

Beispiel:

"c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b"

customer · string<uuid>

The ID of the customer that owns this payment method

Beispiel:

"ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a"

gatewayName · enum<string>

The payment gateway used to process the payment method

Verfügbare Optionen: wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing

type · enum<string> | null

The type of the payment method

Verfügbare Optionen: sepa_debit, card, paypal, bank_transfer, wallet, fake_provider, null

referenceId · string | null

The reference ID of the payment method at the payment gateway

default · boolean

Whether this is the default payment method for the customer

Beispiel:

true

status · enum<string> · Standard: active

The current status of the payment method

Verfügbare Optionen: active, action_required, expired, revoked, gateway_unconfigured

Beispiel:

"active"

source · enum<string> · Standard: api

The source where the payment method was created

Verfügbare Optionen: checkout, customerfront, api, add_link

Beispiel:

"api"

enabled · boolean

Whether the payment method is enabled for use

Beispiel:

true

name · string | null

Display name of the payment method

Beispiel:

"Visa (4242)"

data · string[]

Additional data associated with the payment method

creationDate · string<date-time>

The date when the payment method was created

Beispiel:

"2024-01-15T10:30:00+00:00"

expirationDate · string<date-time> | null

The expiration date of the payment method, if applicable

Beispiel:

"2026-12-31T23:59:59+00:00"

sepaMandate · object

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

Show child attributes

card · object

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

Show child attributes

sepaDebit · object

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

Show child attributes

paypal · object

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

Show child attributes

expirationInDays · integer | null

Number of days until the payment method expires. Null if no expiration.

Beispiel:

365