Deposit

Initiating a Deposit via Payment Method API

To initiate a deposit for a user, you need to send a POST request to the following endpoint. The request body must be in JSON format and include the following parameters:

Create Deposit

POST /api/v4/paymentmethod/deposit

Headers

Name	Value
Content-Type	application/json
x-api-key	<x-api-key>

Body

Name	Type	Description
username	string	The user's unique username. It should be dynamically generated or retrieved from your user database.
firstName	string	The user's first name. If the user has a middle name, include it in the firstName field (e.g., Mehmet Ali).
lastName	string	The user's last name.
amount	decimal	The deposit amount in the smallest currency unit (e.g., cents, pence).
currency	string	The currency of the deposit amount (e.g., TRY, USD, EUR, GBP).
reference	string	A unique identifier for the transaction, typically a UUID or your unique transaction Id.
paymentMethod	integer	The identifier number for the selected payment method.
swiftCode	string	Required for paymentMethod values such as BankTransfer or CryptoCurrency. Represents the SWIFT code of the destination account (if applicable).
returnUrl	string	Optional. Required only when a payment page is used. This is the URL the user will be redirected to after completing the deposit process.

Response

200

{
    "id": 1299949,
    "username": "Name.McGlynn",
    "firstName": "Patience",
    "lastName": "Lebsack",
    "amount": 1000,
    "currency": "TRY",
    "reference": "cf718258-8bf5-4fb4-82a8-3b02d0304558",
    "paymentMethod": 2,
    "swiftCode": "FAST",
    "timestamp": 1753696287935,
    "uniqueKey": "275724c8ff2a43709e8b6e24a4328a60",
    "paymentPageUrl": "https://testpayment.paylayerpro.com/transaction/275724c8ff2a43709e8b6e24a4328a60",
    "account": {
        "fullName": "John Doe",
        "accountType": "FAST",
        "address": "TR290011100000000111222233"
    }
}

400

{
    "errors": {
        "transaction": [
            "There is a pending transaction for the specified user. Please try again after the pending transaction is completed."
        ]
    }
}

401

{
    "errors": {
        "x-api-key": [
            "Invalid API Key",
            "API Key is required"
        ]
    }
}

404

{
    "errors": {
        "paymentMethod": [
            "Payment method not found."
        ]
    }
}

Deposit Request

post

Make a deposit request.

Header parameters

x-api-keystringRequired

The API key for authentication.

Body

application/json

usernamestring · min: 1Required

firstNamestring · min: 1Required

lastNamestring · min: 1Required

amountnumber · double · min: 0.01Required

currencystring · min: 1Required

referencestring | nullableOptional

paymentMethodinteger · int32Required

Enum - PaymentMethod

swiftCodestring | nullableOptional

returnUrlstring | nullableOptional

Responses

200

Deposit successful.

application/json

400

Bad request.

application/json

401

API key is missing or invalid.

application/json

404

Not Found.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v4/paymentmethod/deposit HTTP/1.1
Host: testlink.paylayercore.com
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "username": "text",
  "firstName": "text",
  "lastName": "text",
  "amount": 1,
  "currency": "text",
  "reference": "text",
  "paymentMethod": 1,
  "swiftCode": "text",
  "returnUrl": "text"
}

{
  "id": 1,
  "username": "text",
  "firstName": "text",
  "lastName": "text",
  "amount": 1,
  "currency": "text",
  "reference": "text",
  "paymentMethod": 1,
  "swiftCode": "text",
  "timestamp": 1,
  "uniqueKey": "text",
  "paymentPageUrl": "text",
  "account": {
    "fullName": "text",
    "accountType": "text",
    "address": "text"
  }
}