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": "max@mustermann.de",
        "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
    },
    "expirationInDays": "",
    "tenantId": ""
}'

import requests

url = "https://coreapi.io/payment-methods/{id}/document"

payload = {
    "customer": "ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a",
    "referenceId": "<string>",
    "customerReferenceId": "<string>",
    "default": True,
    "status": "active",
    "source": "api",
    "enabled": True,
    "isInternal": False,
    "name": "Visa (4242)",
    "data": ["<string>"],
    "expirationDate": "2026-12-31T23:59:59+00:00",
    "notifications": ["ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a"],
    "webhookResults": ["ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a"],
    "gatewayData": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer: 'ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a',
    referenceId: '<string>',
    customerReferenceId: '<string>',
    default: true,
    status: 'active',
    source: 'api',
    enabled: true,
    isInternal: false,
    name: 'Visa (4242)',
    data: ['<string>'],
    expirationDate: '2026-12-31T23:59:59+00:00',
    notifications: ['ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a'],
    webhookResults: ['ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a'],
    gatewayData: ['<string>']
  })
};

fetch('https://coreapi.io/payment-methods/{id}/document', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://coreapi.io/payment-methods/{id}/document",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customer' => 'ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a',
    'referenceId' => '<string>',
    'customerReferenceId' => '<string>',
    'default' => true,
    'status' => 'active',
    'source' => 'api',
    'enabled' => true,
    'isInternal' => false,
    'name' => 'Visa (4242)',
    'data' => [
        '<string>'
    ],
    'expirationDate' => '2026-12-31T23:59:59+00:00',
    'notifications' => [
        'ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a'
    ],
    'webhookResults' => [
        'ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a'
    ],
    'gatewayData' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b",
  "customer": "ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a",
  "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": "max@mustermann.de",
    "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
  },
  "expirationInDays": 365
}

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": ""
}'

import requests

url = "https://coreapi.io/payment-methods/{id}/document"

payload = {
    "customer": "ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a",
    "referenceId": "<string>",
    "customerReferenceId": "<string>",
    "default": True,
    "status": "active",
    "source": "api",
    "enabled": True,
    "isInternal": False,
    "name": "Visa (4242)",
    "data": ["<string>"],
    "expirationDate": "2026-12-31T23:59:59+00:00",
    "notifications": ["ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a"],
    "webhookResults": ["ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a"],
    "gatewayData": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer: 'ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a',
    referenceId: '<string>',
    customerReferenceId: '<string>',
    default: true,
    status: 'active',
    source: 'api',
    enabled: true,
    isInternal: false,
    name: 'Visa (4242)',
    data: ['<string>'],
    expirationDate: '2026-12-31T23:59:59+00:00',
    notifications: ['ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a'],
    webhookResults: ['ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a'],
    gatewayData: ['<string>']
  })
};

fetch('https://coreapi.io/payment-methods/{id}/document', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://coreapi.io/payment-methods/{id}/document",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customer' => 'ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a',
    'referenceId' => '<string>',
    'customerReferenceId' => '<string>',
    'default' => true,
    'status' => 'active',
    'source' => 'api',
    'enabled' => true,
    'isInternal' => false,
    'name' => 'Visa (4242)',
    'data' => [
        '<string>'
    ],
    'expirationDate' => '2026-12-31T23:59:59+00:00',
    'notifications' => [
        'ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a'
    ],
    'webhookResults' => [
        'ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a'
    ],
    'gatewayData' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b",
  "customer": "ad8f3b9e-1b1a-4b9a-9b9a-9b9a9b9a9b9a",
  "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": "max@mustermann.de",
    "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

string

erforderlich

PaymentMethod identifier

Body

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[]

write-only

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

Antwort

PaymentMethod resource created

Payment method details returned when reading a payment method.

string

read-only

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>

read-only

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 | null

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

Show child attributes

card

object

read-only

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

Show child attributes

sepaDebit

object

read-only

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

Show child attributes

paypal

object

read-only

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

Show child attributes

expirationInDays

integer | null

read-only

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

Beispiel:

365

Migrate stripe payment methods Get transactions

API documentation

User

Tenant

Customer

Catalogue

Subscription

Invoice

Payment

Dunning

Offer

Checkout

Feature & Entitlement

Analytics

Accounting

Settings

Upload a document for a payment method

Autorisierungen

Pfadparameter

Body

Antwort