Add a balance or payment transfer

Creates a completed incoming transfer by default — used both for adding points balance and for recording a credit-wallet payment. Pass state: pending for a credit payment awaiting confirmation.

POST/wallets/{wallet_id}/transfers

Authorization

AuthorizationBearer token (JWT) · headerrequired

Path parameters

wallet_idintegerrequired

Request body

requiredapplication/json

amountintegerrequired

Positive integer amount to add.

descriptionstringrequired

reference_codestring

payment_methodstring

shop_idstring

statestring

default: "completed"

Allowed:pendingcompleted

Responses

201

Transfer created

_linksHalLinks

idinteger

directionstring

Allowed:incomingoutgoing

statestring

Allowed:pendingcompletedreverseddeletedexpired

amountinteger

Positive for incoming transfers, negative for outgoing.

original_amountinteger

Order total that earned this transfer, for points earned from a purchase.

descriptionstring

reference_codestring

payment_methodstring

shop_idstring

wallet_idinteger

balance_expires_atstring<date-time>

created_onstring<date-time>

422

Invalid transfer (e.g. insufficient balance for an outgoing amount)

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

wallet_idpath*

Bodyapplication/json

amountinteger*Positive integer amount to add.descriptionstring*reference_codestringpayment_methodstringshop_idstringstatestring

Request

curl -X POST 'https://api.onbolder.com/v2/wallets/0/transfers' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "amount": 500,
  "description": "Signup bonus",
  "reference_code": "signup-3001"
}'

const response = await fetch("https://api.onbolder.com/v2/wallets/0/transfers", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"amount\": 500,\n  \"description\": \"Signup bonus\",\n  \"reference_code\": \"signup-3001\"\n}"
});

import requests

response = requests.post(
    "https://api.onbolder.com/v2/wallets/0/transfers",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"amount\": 500,\n  \"description\": \"Signup bonus\",\n  \"reference_code\": \"signup-3001\"\n}",
)

Response

{
  "_links": {
    "property1": {
      "href": "string",
      "templated": true,
      "method": "get",
      "title": "string",
      "type": "string"
    },
    "property2": {
      "href": "string",
      "templated": true,
      "method": "get",
      "title": "string",
      "type": "string"
    }
  },
  "id": 0,
  "direction": "incoming",
  "state": "pending",
  "amount": 0,
  "original_amount": 0,
  "description": "string",
  "reference_code": "string",
  "payment_method": "string",
  "shop_id": "string",
  "wallet_id": 0,
  "balance_expires_at": "2019-08-24T14:15:22Z",
  "created_on": "2019-08-24T14:15:22Z"
}