Update a transfer.

PUT https://api.leapa.co/v2/transfers/{transfer_id}

This endpoint needs your API key

Send it as a bearer token in the Authorization header. A request without one is answered with 401. See Authentication for where to find your key and how to keep it secret.

Request

curl -X PUT "https://api.leapa.co/v2/transfers/trf_18d94b0fa5" \
  -H "Authorization: Bearer $LEAPA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Room 204, two nights"
  }'

Response

{
  "id": "obj_5f21c8a40b",
  "object": "string",
  "amount": 45000,
  "currency": "BIF",
  "description": "Room 204, two nights",
  "type": "deposit",
  "created_date": 0,
  "merchant_id": "mer_1b47d0e9ca",
  "merchant_name": "Jeanne Ndayishimiye",
  "live": false,
  "modified_date": 0,
  "reversal_id": "string"
}

Path parameters

Values that go into the URL itself.

transfer_idstringrequired
Example:trf_18d94b0fa5

Request body

application/json

Required. Send it as JSON.

descriptionstring
Description of the transfer.

Response

application/json

idstring
Id of the transfer
objectstring
object to be returned
amountinteger<int64>
Amount to be transferred.
currencystring
Three-Letter ISO currency code
Allowed values:BIFUSDKESXAF
descriptionstring
Description of the payout.
typestring
Type of the transfer. Either deposit or reversal
Allowed values:depositreversal
created_dateinteger<int64>
UTC UNIX Epoch Timestamp in millisecond at which the record was created.
merchant_idstring
ID of the merchant receiving the fund
merchant_namestring
Name of the merchant receiving the fund
liveboolean
Whether the object exist in live or test mode.
modified_dateinteger<int64>
UTC UNIX Epoch Timestamp in millisecond at which the object was modified.
reversal_idstring
ID of the reversal transfer for a deposit. Only valid for bank and card type.

Status codes

200OK
400Bad request
401Unauthorized
402Payment required
403Forbidden
404Not found
428Precondition required
500Server error