Withdrawal

Initiating a Withdrawal via Payment Method API

To initiate a withdrawal for a user, a POST request must be sent to the following endpoint. The request body should be JSON formatted with the following parameters:

Create Withdrawal

POST /api/v3/paymentmethod/withdrawal

Headers

Name
Value

Content-Type

application/json

x-api-key

<x-api-key>

Body

Name
Type
Description

username

string

The user's unique username. This should be dynamically generated or retrieved from your 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

Code for the payment method. For banks, use the SWIFT code; for cryptocurrency, use the currency symbol or identifier.

address

string

Account number, IBAN, or wallet address.

Response

{
    "id": 92,
    "username": "Cristal_Bogan93",
    "firstName": "Kyra",
    "lastName": "Halvorson",
    "amount": 100,
    "currency": "TRY",
    "reference": "fea12848-7c9e-4425-8133-8d81d8225e13",
    "paymentMethod": 3,
    "swifCode": "TGBATRIS",
    "address": "TR130092900005471012139617"
}

Instructions

  1. Gather the necessary user details and the desired withdrawal amount.

  2. Get the relevant swift code from swift code list.

  3. Create the JSON payload with the correct user and transaction details.

  4. Make the POST request to the designated endpoint with the JSON body.

  5. Upon receiving the response, direct the user to the paymentPageUrl to carry out the withdrawal operation.

Retrieve Swift Code Information

get

Retrieve the available swift codes.

Path parameters
paymentmethodstringRequired
Header parameters
x-api-keystringRequired

The API key for authentication.

Responses
200
A JSON array of available swift codes.
application/json
get
GET /api/v3/paymentmethod/swiftcode/{paymentmethod} HTTP/1.1
Host: testlink.paylayercore.com
x-api-key: text
Accept: */*
[
  {
    "name": "text",
    "swiftCode": "text"
  }
]

Withdrawal Request

post

Make a withdrawal request.

Header parameters
x-api-keystringRequired

The API key for authentication.

Body
usernamestring · min: 1Required
firstNamestring · min: 1Required
lastNamestring · min: 1Required
amountnumber · decimal · min: 1Required
currencystring · min: 1Required
referencestring | nullableOptional
paymentMethodinteger · int32Required
swiftCodestring · min: 1Required
addressstring · min: 1Required
Responses
200
Withdrawal successful.
application/json
post
POST /api/v3/paymentmethod/withdrawal HTTP/1.1
Host: testlink.paylayercore.com
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 158

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

Last updated