Transactions
Transactions enable businesses to manage and track all financial exchanges within the Snap Business Manager.
Attributes
Attribute | Description | Required | Possible Values |
---|---|---|---|
organization_id | Organization ID | R | |
account_id | Ad Account ID | R | |
payment_action_id | Payment Action ID | R | |
payment_action_type | Payment Type | R | AUTHORIZATION, CHARGE, CORRECTION, REFUND, VERIFICATION, UNRECOGNIZED. |
credential_id | Credential ID | R | |
credential_type | Credential Type | R | COUPON, CREDIT_CARD, DIRECT_DEBIT, IN_APP_PURCHASE, LINE_OF_CREDIT, PAYPAL, PREPAY, SNAPCHAT. |
payment_items | Array of Payment Items. See table below | R | |
status | Transaction Status | R | COMPLETED, FAILED, PENDING, UNRECOGNIZED. |
total_amount | Transaction Amount | R | { "amount": Number, "currency_type": "USD"} |
Payment Item
Attribute | Description | Required | Possible Values |
---|---|---|---|
payment_item_id | Payment Item ID | R | |
name | Payment Item Name | R | |
start_date | Start Date in ISO time string | R | |
end_date | End Date in ISO time string | R | |
subtotal_amount.amount | Item Amount | R | |
subtotal_amount.currency_type | Item Amount Currency | R | USD, CAD, GBP, EUR, AUD |
Get all Transactions
curl "https://adsapi.snapchat.com/v1/organizations/8fdeefec-f502-4ca8-9a84-6411e0a51053/transactions" \
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
{
"request_status": "SUCCESS",
"request_id": "1f4f4b52-91cc-4d9a-9bdf-f7aa93337df2",
"organization_id": "8fdeefec-f502-4ca8-9a84-6411e0a51053",
"transactions": [
{
"sub_request_status": "SUCCESS",
"transaction": {
"id": "755d42ac-13b9-492f-95a5-628455fd8331",
"account_id": "ea3e370f-43ae-5h53-8f10-1d2z47d9778a",
"payment_items": [
{
"payment_item_id": "23c06de7-526b-472c-a041-c3da568e5b00",
"name": "Example Transactions",
"start_date": "2023-10-07T04:00:00.000Z",
"end_date": "2023-10-08T03:59:59.999Z",
"subtotal_amount": {
"amount": 585,
"currency_type": "USD"
},
"quantity": 1847
},
{
"payment_item_id": "23c06de7-526b-471c-a041-c3da568e5b00",
"name": "Example Transactions",
"start_date": "2023-10-07T04:00:00.000Z",
"end_date": "2023-10-08T03:59:59.999Z",
"subtotal_amount": {
"amount": 79000,
"currency_type": "USD"
},
"quantity": 469559
}
],
"payment_action_id": "90dbd505-577b-4249-81e6-377be22ed8d3",
"payment_action_type": "CHARGE",
"credential_type": "LINE_OF_CREDIT",
"credential_id": "288194d8-02bb-4719-a448-28g865e3e213",
"payment_method_id": "e703eb9f-8eac-4eda-deec3935444d",
"total_amount": {
"amount": 210252,
"currency_type": "USD"
},
"status": "COMPLETED",
"created_time": "2023-10-08T10:31:14.804Z",
"last_update_time": "2023-10-08T10:31:15.684Z"
}
}
]
}
The following API request retrieves all Transactions for an Organization.
HTTP Request
GET https://adsapi.snapchat.com/v1/organizations/{organization_id}/transactions
Parameters
Parameter | Default | Description |
---|---|---|
start_time | Start time of transactions in UTC yyyy-mm-ddThh:mm:ss | |
end_time | End time of transactions in UTC yyyy-mm-ddThh:mm:ss | |
ad_account_id | Ad Account ID of the ad account to retrieve |
Was this page helpful?