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

200

{
    "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"
}

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."
        ]
    }
}

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

Retrieve the available swift codes.

get

/api/v3/paymentmethod/swiftcode/{paymentmethod}

Path parameters

paymentmethodstringrequired

Header parameters

x-api-keystringrequired

The API key for authentication.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://testlink.paylayercore.com/api/v3/paymentmethod/swiftcode/{paymentmethod}' \
  --header 'x-api-key: text'

200

401

404

200

[
  {
    "name": "text",
    "swiftCode": "text"
  }
]

A JSON array of available swift codes.

Withdrawal Request

Make a withdrawal request.

post

/api/v3/paymentmethod/withdrawal

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 | nullable

paymentMethodinteger · int32required

swiftCodestring · min: 1required

addressstring · min: 1required

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://testlink.paylayercore.com/api/v3/paymentmethod/withdrawal' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "username": "text",
    "firstName": "text",
    "lastName": "text",
    "amount": 1,
    "currency": "text",
    "reference": "text",
    "paymentMethod": 1,
    "swiftCode": "text",
    "address": "text"
  }'

200

400

401

404

200

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

Withdrawal successful.