Create Payments

Create payment

post
/api/v1/payments

Payment request, used for DEPOSITS, WITHDRAWALS and REFUNDS

Authorizations
AuthorizationstringRequired

The client sends HTTP requests with the Authorization header that contains the word Bearer followed by a space and the Shop Api Key.

Body
referenceIdstring · max: 256Optional

Reference assigned by Merchant. Will not go outside the system. Will be sent unchanged in the PaymentResponse.

Example: payment_id=123;custom_ref=456
paymentTypestring · enumRequired

Payment Type

Example: DEPOSITPossible values:
paymentMethodstring · enumOptional

Payment Method

Example: BASIC_CARDPossible values:
amountnumber · min: 0.00001 · max: 1000000000Optional

Payment amount

Example: 11.12
currencystring · ISO 4217 code for FIAT currencies or cryptocurrency symbolRequired

Payment currency

Example: EUR
parentPaymentIdstring · max: 32Optional

Id of initial deposit for refunds, Id of initial recurring payment for subsequent payments

Example: 91d27876e87f4b22b3ecd53924bf973d
descriptionstring · max: 512Optional

Description of the transaction shown to the Customer. Can be sent outside the system.

Example: Deposit 123 via TEST shop
returnUrlstring · max: 512Optional

URL to redirect Customer after processing

Example: https://mywebsite.com/{id}/{referenceId}/{state}/{type}
webhookUrlstring · max: 512Optional

Url to receive payment status notifications

Example: https://mywebsite.com/webhooks
startRecurringbooleanOptional

Send 'true' if you want this payment to initiate recurring chain. Default is 'false'.

preAuthbooleanOptional

Send 'true' if you want to request a Pre-Authorization charge (initiate a 2-phase deposit).

recurringTokenstringOptional

To continue recurring chain, send a token from a previously initiated recurring payment.

Responses
200

Payment response

application/json
post
/api/v1/payments
PreviousError CodesNextGet Payments

Last updated