Skip to end of metadata
Go to start of metadata

Introduction

Updating the master data and/or the payment data for an end customer.


Request "updateuser"

Common Parameter

RequiredFormatComment

userid

o


userid or merchant's customer ID must already exist and mode (test/live) must must match.

PAYONE User ID, defined by PAYONE

Format

NUMERIC(6..12)

customerid

o


Merchant's customer ID, defined by you / merchant to refer to the customer record

Format

CHAR(1..20)
Permitted Symbols
[0-9, a-z, A-Z, .,-,_,/]
  • "customerid" can be used to identify a customer record.
  • If "customerid" is used then stored customer data are loaded automatically.

salutation

-


The customer's salutation

Format

CHAR(1..10)

title

-


Title of the customer

Format

CHAR(1..20)

Samples

Dr
Prof.
Dr.-Ing.

firstname

-


First name of customer; optional if company is used, i.e.: you may use

  • "company"
  • or "lastname"
  • or "firstname" plus "lastname"

Format

CHAR(1..50)

lastname

-


Last name of customer; optional if company is used, i.e.: you may use

  • "company"
  • or "lastname"
  • or "firstname" plus "lastname"

Format

CHAR(2..50)

company

-


Company name of customer; The company name is optional if lastname is used, i.e.: you may use

  • "company"
  • or "lastname"
  • or "firstname" plus "lastname"

Format

CHAR(2..50)

street

-


Street number and name (required: at least one character)

Format

CHAR(1..50)

addressaddition

-


Specifies an additional address line for the invoice address of the customer.

Format

CHAR(1..50)

Samples

7th floor
c/o Maier

zip

-


Postcode

Format

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

city

-


City of customer

Format

CHAR(2..50)

country

-


Specifies country of address for the customer

Format

LIST 

Permitted values

ISO 3166 2-letter-codes

Samples

DE
GB
US

Some countries require additional information in parameter "state"

state

-


Specifies state / region of country for the customer.
"state" is required for these countries: US, CA, CN, JP, MX, BR, AR, ID, TH, IN and must not be used for all other countries.

Format

LIST

Permitted values


Samples US

AK
AL
AR

Samples CA

AB
BC

email

-


email-address of customer

Format

CHAR(5..254)
Permitted Symbols
RFC 5322

telephonenumber

-


Phone number of customer

Format

CHAR(1..30)

birthday

-


Date of birth of customer


Format

DATE(8), YYYYMMDD

Samples

20190101
19991231

language

-


Language indicator (ISO 639) to specify the language that should be presented to the customer (e.g. for error messages, frontend display).

If the language is not transferred, the browser language will be used. For a non-supported language English will be used.

Format

LIST 

Permitted values

ISO 639-1 (Language) 2-letter-codes

vatid

-


VAT identification number. Used for b2b transactions to indicate VAT number of customer.

Format

CHAR(1..50)

accessname

-


Customer's user name

Format

CHAR(1..32)

accesscode

-


Customer's password

Format

CHAR(1..32)

delete_carddata

-


Deleting data for payment method "credit card".

Format

LIST 

ValueComment

yes

Delete data

no

Do not delete data (default)

delete_bankaccountdata

-


Deleting data for payment method "direct debit".

Format

LIST 

ValueComment

yes

Delete data

no

Do not delete data (default)

Parameter ( delivery data )

shipping_firstname

-


First name of delivery address

Format

CHAR(1..50)

shipping_lastname

-


Surname of delivery address

Format

CHAR(1..50)

shipping_company

-


Company Name of the delivery address

Format

CHAR(2..50)

shipping_street

-


Street number and name of delivery address

Format

CHAR(2..50)

shipping_addressaddition

-


Specifies an additional address line for the delivery address of the customer, e.g. "7th floor", "c/o Maier".

Format

CHAR(1..50)

shipping_zip

-


Postcode of delivery address

Format

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

shipping_city

-


City of delivery address

Format

CHAR(2..50)

shipping_state

-


Specifies state of country of delivery address for the customer
"shipping_state" is required for these countries: US, CA, CN, JP, MX, BR, AR, ID, TH, IN (if shipping_country is given) and must not be used in all other countries.

Format

LIST

Permitted values


Samples US

AK
AL
AR

Samples CA

AB
BC

shipping_country

-


Specifies country of delivery address for the customer

Format

LIST 

Permitted values

ISO 3166 2-letter-codes

Samples

DE
GB
US

Some countries require additional information in parameter shipping_state

Parameter ( bank account )

iban

o


IBAN to be used for payment or to be checked

Format

CHAR(10..34)
Permitted Symbols
[0-9][A-Z]

bic

o


Bank Identifier Code to be used for payment or to be checked

Format

CHAR(8 or 11) Only capital letters and digits, no spaces
Permitted Symbols
[0-9][A-Z]

BIC is optional for all Bank transfers within SEPA. For Accounts from Banks outside of SEPA, BIC is still required. 

bankcountry

o


Account type/ country for use with BBAN (i.e. bankcode, bankaccount): DE

DE: Mandatory with bankcode, bankaccount, optional with IBAN

For other countries than DE please use IBAN or IBAN/BIC

Format

LIST 

bankaccount

o


Account number (BBAN)

  • DE: bankcountry, bankcode and bankaccount may be used. Then IBAN will be generated by PAYONE platform and used for SEPA transactions.
  • Not DE: Please use IBAN or IBAN / BIC.

Format

NUMERIC(1..10)

bankcode

o


Sort code (BBAN) (only in DE)

  • DE: bankcountry, bankcode and bankaccount may be used. Then IBAN will be generated by PAYONE platform and used for SEPA transactions.
  • Not DE: Please use IBAN or IBAN / BIC.

Format

NUMERIC(8)

bankaccountholder

o


Account holder


Format

CHAR(1..50)

Parameter ( credit card )

cardholder

-


Cardholder of credit card.


Format

CHAR(1..50)

cardpan

-


Primary account number of credit card

Format

NUMERIC(13..19)

  • if your system handles "cardpan" directly you can not be PCI DSS SAQ A compliant.
  • for simple PCI DSS SAQ A compliance please use PAYONE hosted iFrames together with pseudocardpan.

cardtype

-


Card type of credit card

Format

LIST 
valueCommentBIN-Range for automatic card type detection

V

Visa

4

M

MasterCard

51-55,2221-2720

A

American Express

34, 37
DDiners / Discover

300-305,3095,36,38,39

601, 64, 65

CDiscover

J

JCB

3528-3589

O

Maestro International

50, 56-58,602, 61, 620, 627, 63, 67
PChina Union Pay62212600-62299800,624-626, 6282-6288
UUATP / Airplus1220, 1920 -> coming soon; not available yet
Ggirocard68 *

*girocard is currently only viable for e-commerce-payments via Apple Pay.

cardexpiredate

-


Credit card expiry date YYMM


Format

NUMERIC(4), YYMM

cardissuenumber

-


Card issue number (only Maestro UK cards)

Format

NUMERIC(1..2)

pseudocardpan

-


Pseudo primary account number for a credit card.

Format

NUMERIC(16..19)

Response "updateuser"

 

 

Common Parameter

Required

Format

Comment

status

+

Default

OK / ERROR

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)

customermessage

-


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")

Format

CHAR(1..1024)


Content


  • No labels