API Reference

/api/v1/payments

post
https://engine-sandbox.pay.tech/api/v1/payments

Payment request, used for DEPOSITS, WITHDRAWALS and REFUNDS

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Payment Request - Request to initiate a payment

string
length ≤ 256

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

string
enum
required

Payment Type

Allowed:
string
enum

Payment Method

number
1e-18 to 999999.99

Payment amount

string
required

Payment currency

string
length ≤ 32

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

string
length ≤ 512

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

card
object

You must be PCI DSS compliant to collect card data on your side. If you are not certified, do not add this field to your request and we will collect the data on our page.

customer
object
billingAddress
object

Customer's billing address

string
length ≤ 256

URL to redirect Customer after processing

string

Url to receive payment status notifications

boolean

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

boolean

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

string

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

subscription
object

Subscription to bill customers at regular intervals. Used only with 'startRecurring=true'.

additionalParameters
object

Additional parameters required by some payment providers. Contact support for more information.

Responses

Updated over 2 years ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago