Page tree
Skip to end of metadata
Go to start of metadata

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.

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

 

PAYONE Business          

With the "capture" request the request is now booked to the transaction account.


Request "capture"

Common Parameter

Required

FormatShort explanation

txid

+


The txid specifies the payment process within the PAYONE platform

Format

NUMERIC(9..12)

sequencenumber

o


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)

Format

NUMERIC(1..3)

Permitted values

0..127

amount

+


Specifies the total gross amount of a payment transaction.

Value is given in smallest currency unit, e.g. Cent of Euro; Pence of Pound sterling; Öre of Swedish krona.

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

Format

NUMERIC(1..10)

Permitted values

max. +/- 19 999 999 99

currency

+


Specifies currency for this transaction


Format

LIST 

Permitted values

 ISO 4217 (currencies) 3-letter-codes

Samples

EUR
USD
GBP

narrative_text

-


Dynamic text element on account statements

Format

CHAR(1..81)

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

Parameter ( PAYONE Business )

transaction_param

-


Optional parameter for merchant information (per payment request)

Format

CHAR(1..50)
Permitted Symbols
[0-9][A-Z][a-z][.-_/]

settleaccount

-


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.

Format

LIST 
ValueComment
yesSettlement of outstanding balances is carried out.
noDo not carry out settlement of outstanding balances, book request only.
autoThe system decides - depending on type of payment and balance - if a settlement of balances can be carried out or not. (default)

booking_date

-


Booking date (YYYYMMDD)

Format

DATE(8), YYYYMMDD

document_date

-


Document date (YYYYMMDD)

Format

DATE(8), YYYYMMDD

due_time

-


Due date (Unixtimestamp)

Format

Unixtimestamp

Parameter ( BillSAFE, Klarna, module Invoicing )

capturemode

-


Specifies whether this capture is the last one or whether there will be another one in future.

Format

LIST 
ValueComment
completed
  • Set with last capture; i.e.: Delivery completed.
  • No further capture is allowed.
notcompleted
  • Set with partial deliveries (last delivery with "completed")
  • Another capture is expected to complete the transaction.

Payment specific:

Payment typeComment

PDT

Parameter "capturemode" is mandatory.
KLS, KLVParameter "capturemode" is mandatory.

invoiceid

-


Merchant's invoice number

Format

CHAR(1..20)

invoice_deliverymode

-


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

Format

LIST 
ValueComments

M

Postal Mail

P

PDF (via email)

N

no delivery


invoice_deliverydate

-


Delivery date (YYYYMMDD)

Format

DATE(8), YYYYMMDD

invoice_deliveryenddate

-


Delivery end date (YYYYMMDD)

Format

DATE(8), YYYYMMDD

invoiceappendix

-


Dynamic text on the invoice

Format

CHAR(1..255)

it[n]

+


Parameter it[n] specifies the item type of a shopping cart item.

Format

LIST 

Array

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


it[n]

Comments


goodsGoods
shipment

Shipping charges


handling

Handling fee

  • Not to be used with PDT
voucherVoucher / discount
  • Not to be used with PDT

id[n]

+


Product number, SKU, etc. of this item

Format

CHAR(1..32)

Array

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

Permitted Symbols
[0-9][A-Z][a-z][()[]{} +-_#/:]

pr[n]

+


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

Format

NUMERIC(10) max. 19 999 999 99

Array

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

no[n]

+


Quantity of this item

Format

NUMERIC(6)

Array

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

de[n]

+


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

Format

CHAR(1..255)

Array

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

Example
de[1]=Product 1
de[2]=Product 2
de[3]=Product 3
...
de[400]=Product 400

va[n]

-


VAT rate (% or bp)

Format

NUMERIC(4)

Array

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

sd[n]

-


Delivery date (YYYYMMDD)

Format

DATE(8), YYYYMMDD

Array

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

ed[n]

-


Delivery period end date (YYYYMMDD)

Format

DATE(8), YYYYMMDD

Array

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


Response "capture"

Common Parameter

Required

FormatComment

status

+

Default

APPROVED / PENDING / ERROR

Parameter (APPROVED)

txid

+


The txid specifies the payment process within the PAYONE platform

Format

NUMERIC(9..12)

settleaccount

o


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

Format

LIST 
ValueComment
yesSettlement of outstanding balances has been carried out.
noSettlement of outstanding balances has not been carried out.

Parameter (PENDING)

txid

+

The txid specifies the payment process within the PAYONE platform

Format

NUMERIC(9..12)

userid

+


PAYONE User ID, defined by PAYONE

Format

NUMERIC(6..12)

Parameter (ERROR)

errorcode

+


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

Format

NUMERIC(1..6)

errormessage

+


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

Format

CHAR(1..1024)

Parameter ( invoice/cash on delivery )

clearing_bankaccountholder

+

AN..35

Recipient bank account holder

clearing_bankcountry

+

Default

Recipient account type/ country

(e.g. DE, AT, etc.)

clearing_bankaccount

+

AN..26

Recipient account number

clearing_bankcode

o

AN..11

Recipient sort code

clearing_bankiban

-

AN..35

Recipient IBAN

clearing_bankbic

-

AN..11

Recipient BIC

clearing_bankcity

-

AN..50

Recipient city or bank

clearing_bankname

-

AN..50

Recipient bank name

clearing_legalnote

o

AN..500

 

clearing_duedate

o

N..8

 

clearing_reference

o

AN..50

 

clearing_instructionnote

o

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.

Parameter ( direct debit )

mandate_identification

-

AN..35

used mandate_identification for debit payment

mandate_dateofsignature

-

N..8

date when mandate has been created (format YYYYMMDD)

creditor_identifier

-

AN..35

used CID for debit payment

creditor_name

-

AN..35

as recorded in PAYONE Platform

creditor_street

-

AN..35

as recorded in PAYONE Platform

creditor_zip

-

AN..10

as recorded in PAYONE Platform

creditor_city

-

AN..50

as recorded in PAYONE Platform

creditor_country

-

Default

Country (ISO 3166)

creditor_email

-

AN..254

as recorded in PAYONE Platform

clearing_date

-

N..8

only provided if due_time is not specified

clearing_amount

-

N..10

only provided if due_time is not specified



Content


  • No labels