Create | Withdrawal Order - InstantTransfer

CURL Example | POST Withdrawal order

curl --request POST \
  --url https://example.com//api/v1/integration/butler/withdrawal-order \
  --header 'Authorization: Bearer Your Token' \
  --header 'Content-Type: application/json' \
  --data '{
  "externalId": "Merch-12345",
  "amount": 1000,
  "properties": [
    {
      "key": "cardNumber",
      "value": "1111123456781111"
    },
    {
      "key": "telecomOperator",
      "value": "vodafone-uk"
    }
  ]
}'

Changes

You have integration with ButlerWalet?

In case you have previously integrated with ButlerWallet processing, you need to change several integration settings:

Replace the integration URL: /api/v1/integration/merch-deposit-order -> /api/v1/integration/butler/withdrawal-order

Apply a new authorization token - please request an authorization token from the manager

Apply a new mapping of bankName and telecomOperator - please find bankName & telecomOperator list

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
  "amount": "1000",
  "externalId": "Merch-12345",
  "propertiess": [
    {
      "key": "CardNumber",
      "value": "123456789012"
    },
    {
      "key": "telecomOperator",
      "value": "vodafone-uk"
    }
  ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

The order was created in the paystar system - now you need to wait for a callback (if callbacks are configured) or query the status using the following method: GET /api/v1/integration/butler/withdrawal-order/{id}

Body

Example

{
    "amount": "1000",
    "status": "Created",
    "externalId": "Merch-1234567890",
    "pspDepositOrderID": "PayStar-9dc24b8a-0c32-4437-9645-8f53cd07e1e8"
}

🟠400Validation error

🟠401Unauthorized

🟠403Forbidden

🟠422Unprocessable Entity

🟠423Locked

🔴500Server Error

Create | Withdrawal Order

CURL Example | POST Withdrawal order#

Changes#

Request

Request Code Samples

Responses

CURL Example | POST Withdrawal order

Changes