Sign in

v1

latestOpenAPI 3.1.02026-07-2663312285.4 KB
Authorization Endpoints

Create a payment charge

Creates a payment charge.

post/v1/payment-charges

Headers

Merchant-Idstring required

The merchant identifier.

Request-Referencestring

Unique request reference to facilitate debugging.

Request-Idempotency-Keystring

Optional Idempotency Key for the request. Sending duplicate requests will result in 409 HTTP status code.

Request body

paymentMethodstring required

The payment method which should be used to process the payment.

amountType'MAX' | 'EXACT' | 'VARIABLE'

Defines if the provided 'amount' is a maximum value or an exact value. This field is relevant only for recurring payments.

startDatestring date-time

The start date of the agreement

endDatestring date-time

The end date of the agreement

labelsobject

Custom labels associated with the payment charge or agreement.

Example request

{
  "paymentMethod": "PAYPAL",
  "consumer": {
    "name": "John Smith",
    "email": "johnsmith@example.com",
    "phone": "+491521111111",
    "country": "DE",
    "locale": "de-DE",
    "taxIdentification": "0798154336790",
    "merchantConsumerReference": "5c019979-0751-469e-96e0-b67f1d95c577",
    "billingAddress": {
      "street": "123 Main St",
      "city": "Anytown",
      "region": "CA",
      "postalCode": "12345",
      "country": "US"
    },
    "client": {
      "ip": "11.22.22.33",
      "userAgent": "Mozilla/5.0 (X11; CrOS x86_64 8172.45.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.64 Safari/537.36"
    }
  },
  "amount": {
    "value": 1000,
    "currency": "EUR"
  },
  "initialPaymentCharge": {
    "paymentDescriptor": "PPRO - ORDER 1234",
    "amount": {
      "value": 1000,
      "currency": "EUR"
    },
    "autoCapture": true,
    "merchantPaymentChargeReference": "5c019979-0751-469e-96e0-b67f1d95c577"
  },
  "instrument": {
    "details": {
      "accountNumber": "007123456",
      "holderName": "John Doe",
      "iban": "DE75512108001245126199",
      "swiftCode": "DEUTDEFF123",
      "bankName": "My Bank",
      "bankCode": "12341234"
    }
  },
  "authenticationSettings": [
    {
      "settings": {
        "verificationCode": "777123"
      }
    }
  ],
  "startDate": "2023-03-26T20:24:27+00:00",
  "endDate": "2023-11-27T09:30:00+00:00",
  "frequency": {
    "type": "MONTHLY",
    "interval": 3
  }
}

Response

OK