3 API Documentation – VR Payment Benutzerhandbuch

HOSTS

Service address

Environment	HTTPS request URL
Production environment	https://pay.vr-payment.de/processing-api/v1/payments
Test environment	https://asia.vrpy.de/processing-api/v1/payments

Security / Authentication

All requests must be sent over SSL (min. TLS 1.3)

All requests are authenticated against an Authorization Bearer header with an access token.

Versioning

The API version is indicated in the request URL e.g. /v1/ indicates version 1.

e.g. https://pay.vr-payment.de/processing-api/v1/payments

Encoding

The system should expect data to be sent encoded in UTF-8.

Merchant should use a header like: Content-Type: application/x-www-form-urlencoded; charset=UTF-8

HTTP Status Codes

For each request a merchant sends to our API the HTTP status code of the response must already tell the basic result.

200 - successful request

307 - temporary redirect

400 - bad request. This might either point to e.g. invalid parameters or values sent. It's also returned if the payment failed e.g. because the acquirer declined.

401 - invalid authorization header provided

403 - invalid access token provided

404 - requested resource or endpoint is not found or wrong IDs given

Testing

ALIPAY

Alipay können Sie mit den folgenden Testdaten testen.

Test wallet account: forex_1707308625041@alitest.com

Password : 111111

WeChat Pay

WeChat Pay können Sie nur in Live testen. Hierzu benutzen Sie bitten den folgenden Account. Bitte führen Sie zu Testzwecken immer nur Transaktionen mit geringen Cent-Bereich aus (z.B. 0,10 EUR) und schreiben den Betrag anschließend wieder über einen REFUND gut.

Um den Account zu nutzen, laden Sie sich bitte die WeChat Pay App herunter und richten sich den Account ein.

ToDo

API

BASICS

Parameter	Description	Format	Required
amount	Indicates the amount of the payment request. The dot is used as decimal separator.	N10.N2 [0-9]{1,10}(\.[0-9]{2})?	Required
currency	The currency code of the payment request's amount (ISO 4217). The following currencys are supported: · EUR	A3 [A-Z]{3}	Required
paymentBrand	The brand specifies the method of payment for the request. The following type are supported: · ALIPAY · WECHATPAY	AN32 [a-zA-Z0-9_] {1,32}	Required
paymentType	The payment type for the request. You can send payment requests with one of the following types: · DB, Debit: Debits the account of the end customer and credits the merchant account. RF, Refund: Credits the account of the end customer with a reference to a prior Debit (DB) transaction.	A2	Required
descriptor	Can be used for further transaction details	AN127 [\s\S]{1,127}	Optional
merchantTransactionId	Merchant-provided reference number, should be unique for your transactions	AN32 [\s\S]{1,32}	Required
shopperResultUrl	This URL will receive the result of an asynchronous payment. Must be sent URL encoded. Only if paymentType=DB	AN2048 [\s\S]{6,2048}	Conditional

AUTHENTICATION

To make REST API calls, include the access token in the Authorization header with the Bearer authentication scheme.

Parameter / Header

Description

Format

Required

Authorization Bearer <access-token>

Authorization header with Bearer authentication scheme.

e.g.

key: Authorization

value: Bearer diew3ucr3aweu5rlaelwxr=

Header