Introduction

The request "capture" includes the booking that was previously set up using the "preauthorization" request. According to the type of payment, specific functions are carried out.

This request is only available in the "Shop" version.

Overview

Credit card

The card is now charged using the reserved amount
Debit payment Debit is carried out immediately
Online transfer

No additional financial action

if necessary, the overpaid amount can be refunded

e-wallet Customer's e-wallet account is now being charged
Prepayment

No additional financial action

if necessary, the overpaid amount can be refunded

Invoice

No additional financial action

Cash on delivery

No additional financial action

POST Request - Capture
Account Parameters
request
required
Fixed Value: capture
mid
required
your merchant ID, 5-digit numeric
aid
required
your subaccount ID, 5-digit numeric
portalId
required
your Portal ID, 7-digit numeric
key
required
your key value, alpha-numeric

---end

common Parameters
txid
optional
Format NUMERIC(9..12) 

The txid specifies the payment process within the PAYONE platform.

sequencenumber
optional
Format NUMERIC(9..12)
Permitted values 0..127

Sequence number for this transaction within the payment process (1..n), e.g. PreAuthorization: 0, 1. Capture: 1, 2. Capture: 2

Required for multi partial capture (starting with the 2nd capture)

amount
optional
Format NUMERIC(1..10)
Permitted values max. +/- 19 999 999 99

Specifies the total gross amount of a payment transaction.

Value is given in smallest currency unit, e.g. Cent of Euro.

The amount must be less than or equal to the amount of the corresponding booking.

currency
optional
Format LIST
Permitted values ISO 4217 (currencies) 3-letter-codes
Samples: EUR / USD /GBP
narrative_text
optional
Format CHAR(1..81)

Dynamic text element on account statements.

(3 lines with 27 characters each) and credit card statements.

---end

Parameters (PAYONE Business)
transaction_param
optional
Format CHAR(1..50)
Permitted Symbols [0-9, a-z, A-Z, .,-,_,/]

Optional parameter for merchant information (per payment request)

settleaccount
optional
Format LIST
Value Comment
yes Settlement of outstanding balances is carried out.
no Do not carry out settlement of outstanding balances, book request only.
auto The system decides - depending on type of payment and balance - if a settlement of balances can be carried out or not. (default)

Carry out settlement of outstanding balances. The request is booked and the resulting balance is settled by means of a collection, e.g. a refund.

booking_date
optional
Format DATE(8), YYYYMMDD

Booking date (YYYYMMDD)

document_date
optional
Format DATE(8), YYYYMMDD

Document date (YYYYMMDD)

due_time
optional
Format Unixtimestamp

Due date (Unixtimestamp)

---end

Parameter (Invoicing)
capturemode
optional
Format CHAR(1..50)

First name of delivery address

invoiceid
optional
Format CHAR(1..20)

Merchant's invoice number

invoice_deliverymode
optional
Format LIST
Value Comment
M Postal Mail
P PDF (via email)
N no delivery

Parameter defines how documents like invoice, credit notes and reminders should be sent to the customer.

invoice_deliverydate
optional
Format DATE(8), YYYYMMDD

Delivery date (YYYYMMDD)

invoice_deliveryenddate
optional
Format DATE(8), YYYYMMDD

Delivery end date (YYYYMMDD)

invoiceappendix
optional
Format CHAR(1..255)

Dynamic text on the invoice

it[n]
optional
Format LIST
it[n] Comments
goods Goods
shipment Shipping Charges
handling Handling fee
voucher Voucher / discount
id[n]
optional
Format CHAR(1..32)
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted Symbols [0-9][a-z][A-Z], .,-,_,/
International Article Number (EAN bzw. GTIN)

Product number, SKU, etc. of this item.

pr[n]
optional
Format NUMERIC(10) max. 19 999 999 99
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted

Unit gross price of the item in smallest unit! e.g. cent.

no[n]
optional
Format NUMERIC(6)
Array Array elements [n] starting with [1]; serially numbered; max [400]Permitted

Quantity of this item.

de[n]
optional
Format CHAR(1..255)
Array Array elements [n] starting with [1]; serially numbered; max [400]

Description of this item. Will be printed on documents to customer.

va[n]
optional
Format NUMERIC(4)
Array elements [n] starting with [1]; serially numbered; max [400]

VAT rate (% or bp)

Array elements [n] starting with [1]; serially numbered; max [400]

sd[n]
optional
Format DATE(8), YYYYMMDD
Array elements [n] starting with [1]; serially numbered; max [400]

Delivery date (YYYYMMDD)

ed[n]
optional
Format DATE(8), YYYYMMDD
Array elements [n] starting with [1]; serially numbered; max [400]

Delivery period end date (YYYYMMDD)

---end

Response Parameters
Permitted Values
APPROVED
PENDING
ERROR
Response Parameter (approved)
txid
Format NUMERIC(9..12)

The txid specifies the payment process within the PAYONE platform

settleaccount
Format LIST
Value Comment
yes Settlement of outstanding balances is carried out.
no Do not carry out settlement of outstanding balances, book request only.

Provides information about whether a settlement of balances has been carried out.

Response Parameter (approved) - invoice/cash on delivery
 clearing_bankaccountholder
Format AN..35

Recipient bank account holder

 clearing_bankcountry
Format LIST
Permitted values ISO 3166 2-letter-codes
Samples
DE
GB
US

Recipient account type/ country

 clearing_bankaccount
Format AN..26

Recipient account number

 clearing_bankcode
Format AN..11

Recipient sort code

 clearing_bankiban
Format AN..35

Recipient IBAN

 clearing_bankbic
Format AN..11

Recipient BIC

 clearing_bankcity
Format AN..50

Recipient city or bank

 clearing_bankname
Format AN..50

Recipient bank name

 clearing_legalnote
Format AN..500
 clearing_duedate
Format N..8
 clearing_reference
Format AN..50
 clearing_instructionnote
Format AN..200

For KLV, KLS: A URL pointing to a PDF of the invoice (If invoice by post or by e-mail isn’t activated). The URL is valid for 30 days.

Response Parameter (approved) - direct debit
 mandate_identification
Format AN..35

Used mandate_identification for debit payment

 mandate_dateofsignature
Format N..8

Date when mandate has been created (format YYYYMMDD)

 creditor_identifier
Format AN..35

Used CID for debit payment

 creditor_name
Format AN..35

As recorded in PAYONE Platform

 creditor_street
Format AN..35

As recorded in PAYONE Platform

 creditor_zip
Format AN..10

As recorded in PAYONE Platform

 creditor_city
Format AN..50

As recorded in PAYONE Platform

 creditor_country
Format LIST

Country (ISO 3166)

 creditor_email
Format AN..254

As recorded in PAYONE Platform

 clearing_date
Format N..8

Only provided if due_time is not specified

 clearing_amount
Format N..10

Only provided if due_time is not specified

Response Parameter (Pending)
txid
Format NUMERIC(9..12)

The txid specifies the payment process within the PAYONE platform

Format NUMERIC(6..12)

PAYONE User ID, defined by PAYONE

Response Parameter (Error)
Format NUMERIC(1..6)

In case of error the PAYONE Platform returns an error code for your internal usage.

Format CHAR(1..1024)

In case of error the PAYONE Platform returns an error message for your internal usage.

Format CHAR(1..1024)

The customermessage is returned to your system in order to be displayed to the customer.

(Language selection is based on the end customer's language, parameter "language")

---end

Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload               
https://api.pay1.de/post-gateway/
amount=12000
capturemode=completed
currency=EUR
de[1]=Hauptartikel mit Kennzeichnung Versandkostenfrei und Hervorhebung
de[2]=Hauptartikel mit Grundpreisberechnung
de[3]=Standard Versand
encoding=UTF-8
id[1]=SW10006
id[2]=SW10010
id[3]=Standard Versand
it[1]=goods
it[2]=goods
it[3]=shipment
key=17031f73e2c6f9755788bddfff04169b
mid=14648
mode=test
no[1]=3
no[2]=15
no[3]=1
portalid=2040559
pr[1]=1500
pr[2]=500
pr[3]=0
request=capture
sequencenumber=1
settleaccount=auto
txid=917985802
va[1]=1900
va[2]=1900
va[3]=0
RESPONSE
                        
status=APPROVED
txid=917985802
workorderid=PP2ABD8L6FLVEEJG
settleaccount=yes