Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

+


Excerpt Include
txid - definition
txid - definition
nopaneltrue

sequencenumber

o


Excerpt Include
sequencenumber - definition
sequencenumber - definition
nopaneltrue

amount

+


Excerpt Include
amount capture - definition
amount capture - definition
nopaneltrue

currency

+


Excerpt Include
currency - definition
currency - definition
nopaneltrue

narrative_text

-


Excerpt Include
narrative_text - definition
narrative_text - definition
nopaneltrue

Parameter ( PAYONE Business )

transaction_param

-


Excerpt Include
transaction_param - definition
transaction_param - definition
nopaneltrue

settleaccount

-


Excerpt Include
settleaccount - definition
settleaccount - definition
nopaneltrue

booking_date

-


Excerpt Include
booking_date - definition
booking_date - definition
nopaneltrue

document_date

-


Excerpt Include
document_date - definition
document_date - definition
nopaneltrue

due_time

-


Excerpt Include
due_time - definition
due_time - definition
nopaneltrue

Parameter ( BillSAFE, Klarna, module Invoicing )

capturemode

-


Excerpt Include
capturemode - definition
capturemode - definition
nopaneltrue

invoiceid

-


Excerpt Include
invoiceid - definition
invoiceid - definition
nopaneltrue

invoice_deliverymode

-


Excerpt Include
invoice_deliverymode - definition
invoice_deliverymode - definition
nopaneltrue

invoice_deliverydate

-


Excerpt Include
invoice_deliverydate - definition
invoice_deliverydate - definition
nopaneltrue

invoice_deliveryenddate

-


Excerpt Include
invoice_deliveryenddate - definition
invoice_deliveryenddate - definition
nopaneltrue

invoiceappendix

-


Excerpt Include
invoiceappendix - definition
invoiceappendix - definition
nopaneltrue

it[n]

+


Excerpt Include
it[n] - definition
it[n] - definition
nopaneltrue

id[n]

+


Excerpt Include
id[n] - definition
id[n] - definition
nopaneltrue

pr[n]

+


Excerpt Include
pr[n] - definition
pr[n] - definition
nopaneltrue

no[n]

+


Excerpt Include
no[n] - definition
no[n] - definition
nopaneltrue

de[n]

+


Excerpt Include
de[n] - definition
de[n] - definition
nopaneltrue

va[n]

-


Excerpt Include
va[n] - definition
va[n] - definition
nopaneltrue

sd[n]

-


Excerpt Include
sd[n] - definition
sd[n] - definition
nopaneltrue

ed[n]

-


Excerpt Include
ed[n] - definition
ed[n] - definition
nopaneltrue


Response "capture"

Common Parameter

Required

FormatComment

status

+

Default

APPROVED / PENDING / ERROR

Parameter (APPROVED)

txid

+


Excerpt Include
txid - definition
txid - definition
nopaneltrue

settleaccount

o


Excerpt Include
settleaccount response - definition
settleaccount response - definition
nopaneltrue

Parameter (PENDING)

txid

+

Excerpt Include
txid - definition
txid - definition
nopaneltrue

userid

+


Excerpt Include
userid - definition
userid - definition
nopaneltrue

Parameter (ERROR)

errorcode

+


Excerpt Include
errorcode - definition
errorcode - definition
nopaneltrue

errormessage

+


Excerpt Include
errormessage - definition
errormessage - definition
nopaneltrue

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

Table of Contents
excludeContent