Upload a document for a payment method

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": "[email protected]",
        "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": "[email protected]",
    "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
  },
  "expirationInDays": 123
}

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": "[email protected]",
        "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": "[email protected]",
    "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
  },
  "expirationInDays": 123
}

Authorizations

Authorization

string

header

required

Value for the Authorization header parameter.

Path Parameters

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

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

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

Show child attributes

sepaMandate.id

string

Example:

"ad8f0b9c-0b1a-4e1a-8b0a-0b1a4e1a8b0a"

sepaMandate.status

enum<string>

The status of the mandate

Possible values:

active: The mandate is active and can be used for payments
revoked: The customer has revoked the mandate or a payment was rejected by the bank. The mandate can not be used for payments anymore

Available options:

active,

revoked

Example:

"active"

sepaMandate.creditorIdentifier

string

sepaMandate.mandateReference

string

The reference of the mandate

Example:

"MNDT-2021-0001"

sepaMandate.bankAccount

object

The bank account of the mandate

Show child attributes

sepaMandate.bankAccount.id

string

Example:

"ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c"

sepaMandate.bankAccount.iban

string

Example:

"DE12500105170648489890"

sepaMandate.bankAccount.bic

string

Example:

"PBNKDEFFXXX"

sepaMandate.bankAccount.accountHolder

string

Example:

"Max Mustermann"

sepaMandate.bankAccount.bankName

string

Example:

"Commerzbank"

sepaMandate.sequenceType

enum<string>

The sequence type of the mandate

Possible values:

FRST: The sepa mandate is used for the first time for a recurring payment
RCUR: The sepa mandate was already used the first time and is now used for recurring payments
FNAL: The sepa mandate is used for the last time for a recurring payment
OOFF: The sepa mandate is only allowed to be used for one payment

Available options:

FRST,

RCUR,

FNAL,

OOFF

Example:

"FRST"

sepaMandate.sepaType

enum<string>

The type of the mandate

Possible values:

CORE: The core scheme is used for payments between consumers and companies
B2B: The B2B scheme is used for payments between companies. No refund is possible
COR1: The COR1 scheme is used for payments between consumers and companies. The payment is processed faster than with the core scheme

Available options:

CORE,

B2B,

COR1

Example:

"core"

card

object

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

Show child attributes

card.brand

string

The brand of the card

Example:

"Visa"

card.last4

string

The last 4 digits of the card

Example:

"4242"

card.expMonth

integer

The expiration month of the card

Example:

12

card.expYear

integer

The expiration year of the card

Example:

2022

card.cardHolder

string

The card holder name

Example:

"Max Mustermann"

sepaDebit

object

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

Show child attributes

sepaDebit.iban

string

The iban of the sepa mandate

Example:

"DE8937*********3232"

sepaDebit.bic

string

The bic of the sepa mandate

Example:

"COBADEFFXXX"

sepaDebit.mandateReference

string

The mandate reference of the sepa mandate

Example:

"MNDT-2021-123456"

sepaDebit.signingDate

string

The signing date of the sepa mandate

Example:

"2021-01-01T00:00:00+00:00"

paypal

object

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

Show child attributes

paypal.email

string

The email of the paypal account

Example:

"[email protected]"

paypal.billingAgreementId

string

The billing agreement id of the paypal account

Example:

"I-1J5gqz2eZvKYlo2C2X2X2X2X"

expirationInDays

integer | null

Migrate stripe payment methods Create payment method link

⌘I

API documentation

User

Tenant

Feature

Entitlement

User & permissions

Settings

Payment

Analytics

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Upload a document for a payment method

Authorizations

Path Parameters

Body

Response