Balance transactions

Balance transactions API.

This API is experimental and not guaranteed to be backward compatible.

Retrieve a list of balance transactions

Retrieve a list of balance transactions.

This operation is experimental and not guaranteed to be backward compatible.

Request
Security:
query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

A list was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/balance-transactions
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/organizations/unknown/balance-transactions?limit=1000&offset=0' \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Retrieve a balance transaction

Retrieve a balance transaction with specified identifier.

This operation is experimental and not guaranteed to be backward compatible.

Request
Security:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

An entry was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/balance-transactions/{id}
Request samples
curl -i -X GET \
  https://api-sandbox.rebilly.com/organizations/unknown/balance-transactions/:id \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "type": "charge",
  • "parentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "transactionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "settlementCurrency": "USD",
  • "settlementAmount": 0,
  • "settlementTime": "2019-08-24T14:15:22Z",
  • "settlementRate": 0,
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ],
  • "_embedded": [
    ]
}