Skip to main content
GET
Credits, debits, purchases, transfers, and marketplace sales all come back in the same shape, so you can read and reconcile them the same way.

Configuration

Header Parameters

string
required
Your ZBD API key.

Path Parameters

string
required
The transaction_id returned when the transaction was created.

Response

The transaction is in data.
string
ZBD’s ID for the transaction.
string
Which call created it: a credit type such as reward, debit, purchase, a transfer type such as gift, or marketplace_sale.
string
completed or failed. Every movement in a transaction settles together, or none of them do.
string
The currency code for every amount in the transaction.
integer
The total, in the currency’s smallest unit.
object | null
The user the value came from. null for a credit, which has no payer inside ZBD.
object[]
Each movement of value: who received it (to, either a user_id or a party such as publisher or zbd), the amount, and for marketplace sales the recipient’s role. A marketplace sale groups its movements under line_items.
string | null
Your own ID for the transaction, if you sent one.
string | null
The project the transaction belongs to, if you sent one.
string
When the transaction was created, as an ISO 8601 timestamp.

Errors