Home B2Core IB API Transactions

Transactions

On this page:

THE TRANSACTION OBJECT

A detailed description of the JSON object

GET[base]/transactions

Get a transactions list

GET[base]/transactions/{transactionId}

Get transaction details

The Transaction object

This object provides the following data about a transaction:

transactionId string

The identifier of the transaction.

transactionAmount string

The amount of the transaction.

transactionCurrencyCode string

The alphabetic code of a currency (such as USD).

transactionCurrencySign string

The sign of the currency.

transactionCurrencyPrecision integer

The minor unit of a currency (the number of digits after the decimal separator).

transactionSide string

The side of the transaction. Possible values:

  • credit

  • debit

transactionIdentifier string

The identifier of the transaction.

transactionTime string

The date and time when a transaction was executed.

tradePlatformId string

The identifier of a trading platform.

tradePlatformName string

The name of a trading platform.

tradePlatformGroupName string

The platform group name.

tradeIdentifier string

The identifier of a trade.

tradeId string

The identifier of the trade on a trading platform.

paymentGroupId string

The identifier of a partnership program.

paymentGroupName string

The name of a partnership program.

paymentProfileId string

The identifier of a partner profile.

paymentProfileUuid string

The universally unique identifier of the partner profile (if provided). Refer to Integrations for more information.

paymentUserId string

The identifier of a client.

paymentUserEmail string

The email of a client.

paymentUserFirstName string

The first name of a client.

paymentUserMiddleName string

The middle name of a client.

paymentUserLastName string

The last name of a client.

paymentUserName string

The name of a client.

paymentWalletId string

The identifier of a partner’s wallet.

paymentWalletNumber string

The number of a partner’s wallet.

paymentWalletUuid string

The universally unique identifier of the wallet (if provided). Refer to Integrations for more information.

paymentMethodId string

The identifier of a payment method.

paymentId string

The identifier of a reward payment.

paymentCount integer

The total number of reward payments.

createTime string

The date and time when the object has been created.

updateTime string

The date and time when the object has been last updated.

THE TRANSACTION OBJECT 
{
  "transactionId": "6006dda272f002519c3eb505",
  "transactionAmount": "2.14285602",
  "transactionCurrencyCode": "BTC",
  "transactionCurrencySign": "₿",
  "transactionCurrencyPrecision": 8,
  "transactionSide": "culpa fugiat deserunt elit ex",
  "transactionIdentifier": "12345",
  "transactionTime": "2021-01-01T00:00:00+00:00",
  "tradePlatformId": null,
  "tradePlatformName": null,
  "tradePlatformGroupName": null,
  "tradeIdentifier": null,
  "tradeId": null,
  "paymentGroupId": "6006dda272f002519c3eb505",
  "paymentGroupName": "Standard",
  "paymentProfileId": "6006dda272f002519c3eb505",
  "paymentProfileUuid": null,
  "paymentUserId": "6006dda272f002519c3eb505",
  "paymentUserEmail": "a31b1402@privaterelay.appleid.com",
  "paymentUserFirstName": "Mary",
  "paymentUserMiddleName": "Jane",
  "paymentUserLastName": "Smith",
  "paymentUserName": "Mary Jane Smith",
  "paymentWalletId": "6006dda272f002519c3eb505",
  "paymentWalletNumber": "12345",
  "paymentWalletUuid": null,
  "paymentMethodId": "6006dda272f002519c3eb505",
  "paymentId": "6006dda272f002519c3eb505",
  "paymentCount": 2,
  "createTime": "2021-01-01T00:00:00+00:00",
  "updateTime": "2021-01-01T00:00:00+00:00"
}

Get a transactions list

Use this method to obtain a list of transactions.

To obtain detailed information about a specified transaction, use a separate method to get transaction details.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Query parameters:

This method supports pagination, sorting, and filtering. For details on applying the parameters, refer to the Query parameters section. Possible parameters for filtering and sorting are listed below. For values description, refer to the Transaction object.

Possible values for the filter parameter:

  • groupId

  • paymentIdFilter

  • profileIdFilter

  • transactionIdentifier

  • transactionSideFilter

  • transactionStartTime

  • transactionEndTime

  • userId

  • walletIdF

Possible values for the sort_by parameter:

  • transactionId

  • transactionTime

GET[base]/transactions

curl --location -g --request GET 'https://your.base-url.here/transactions?limit=10&offset=0&sort_by=transactionTime&sort_order=desc&filter[groupId]=6006dda272f002519c3eb505&filter[paymentId]=6006dda272f002519c3eb505&filter[profileId]=6006dda272f002519c3eb505&filter[transactionIdentifier]=12345&filter[transactionSide]=debit&filter[transactionStartTime]=2021-01-01T00:00:00+00:00&filter[transactionEndTime]=2021-01-31T23:59:59+00:00&filter[userId]=6006dda272f002519c3eb505&filter[walletId]=6006dda272f002519c3eb505' \
--header 'Authorization: Bearer <token>'

Response

Body:

In case of success, the response body contains an array of Transaction objects providing information about all transactions that correspond to the query parameters specified in the request.

Get transaction details

Use this method to obtain detailed information about a specified transaction.

To obtain a list of transactions, use a separate method to get a list of transactions.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

transactionId required

The transaction identifier.

GET[base]v1/transactions/{transactionId}

curl --location --request GET 'https://your.base-url.here/transactions/60ba407d15951453e60e49f8' \
--header 'Authorization: Bearer <token>'

Response

Body:

In case of success, the response body contains a Transaction object providing information about the specified transaction.