Withdraw

Withdraw funds from a Rapyd Wallet.

The Point-of-Sale location uses this method when the customer removes money from the customer’s own wallet.

After you use this method, you must call the Close Session method to complete the process.

The wallet is specified in the phone_number field of the header. The currency_code determines which wallet account the funds are taken from. If there is not enough money in that account, the withdrawal fails.

Note

The base URL for the POS production environment is https://pos.rapyd.net. It requires its own access key, which is different from the access key for the Payment API. To obtain an access key for the POS production environment and to set up a sandbox environment for the POS API, contact Rapyd Client Support.

Parameters

Request Path Parameters

- account
- ID of the account that has the currency the user wants to withdraw. UUID.
- sum
- Amount of withdrawal. Decimal.

Request Header Parameters

Response Parameters

- transaction_id
- ID of the withdrawal transaction. UUID.

/v1/pos/withdraw/{account}/{sum}

Withdraw

curl -X post
https://sandboxpos.rapyd.net/v1/pos/withdraw/4f436024-c3be-11e7-9273-0ef1982c1e4a/10.99
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'idempotency: your-idempotency-parameter-here'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'

{
    "status": {
        "error_code": "0",
        "status": "SUCCESS",
        "message": "",
        "operation_id": "941f2764-2892-4cfc-badb-7a80818937c7"
    },
    "data": {
        "transaction_id": "4f0a7b1f-a394-11e7-9273-0ef1982c1e4a"
    }
}

In this section:

Documentation