| Create a transaction |
POST |
app.animate.io/api/v1/transactions |
Required Parameters
| Key |
Value |
| auth_token |
Your platform's auth token |
| listing_id |
The id of the listing associated with the transaction |
Optional Parameters
| Key |
Value |
| price |
The price of the transaction |
| user_id |
The id of the user associated with the transaction |
| Get a transaction |
GET |
app.animate.io/api/v1/transactions/:id |
Please note that updating transaction parameters after a customer has paid does not update the amount billed to the customer. Updates to the amount billed to the customer post payment can be completed via additional transactions, invoices, the Stripe Dashboard, or the Stripe API.
| Update a transaction |
POST |
app.animate.io/api/v1/transactions/:id |
Required Parameters
| Key |
Value |
| auth_token |
Your platform's auth token |
Optional Parameters
| Key |
Value |
| price |
The price of the transaction |
| email |
The email of the user associated with the transaction |
| fullname |
The name of the user associated with the transaction |
| phone_number |
The phone number of the user associated with the transaction |
| start_time |
The transaction's start datetime, if applicable |
| length |
The number of 15 minute intervals the transaction will last, if applicable.
Ex: 4 -> 1 hour duration. Changing this does not impact the price of the transaction. |
| state |
The state of the transaction.
Valid values:
confirmed, completed, awaiting confirmation, cancelled, pending |
| field_nlynyhfvamztk3dvvyfyew |
The field value for field_nlynyhfvamztk3dvvyfyew tied to this transaction |
| field_j1n4ywekfhxgdwmmscw0gq |
The field value for field_j1n4ywekfhxgdwmmscw0gq tied to this transaction |
| field_iu0eodobrhgowrrx5ryzfg |
The field value for field_iu0eodobrhgowrrx5ryzfg tied to this transaction |
| field_hefde2pjxitdj76qkbnrw |
The field value for field_hefde2pjxitdj76qkbnrw tied to this transaction |
| field_6qzwdgqtsuhne0oqrogg |
The field value for field_6qzwdgqtsuhne0oqrogg tied to this transaction |
| field_dklzsrbex5w1ewfnu2gncq |
The field value for field_dklzsrbex5w1ewfnu2gncq tied to this transaction |
| field_fkqjbe6z7yn7j5jyuakg |
The field value for field_fkqjbe6z7yn7j5jyuakg tied to this transaction |
| field_1hnhzbusdl54wk6wzb8ooq |
The field value for field_1hnhzbusdl54wk6wzb8ooq tied to this transaction |
| field_4wyuya3lktau48rbfjb6ua |
The field value for field_4wyuya3lktau48rbfjb6ua tied to this transaction |
| field_4jrusvbtbfqvvi028bs4qq |
The field value for field_4jrusvbtbfqvvi028bs4qq tied to this transaction |
| field_exxh85wlep8bpbqiyzgmkg |
The field value for field_exxh85wlep8bpbqiyzgmkg tied to this transaction |
| field_fswhcu6jdhgbk4bfxkczg |
The field value for field_fswhcu6jdhgbk4bfxkczg tied to this transaction |
| field_tmmuajl4xigzsxaa9hscxg |
The field value for field_tmmuajl4xigzsxaa9hscxg tied to this transaction |
| field_3j3lxkaknauznofwcirtw |
The field value for field_3j3lxkaknauznofwcirtw tied to this transaction |
Please note that deleting a transaction via the Tangram api does not refund the payment by default. Refunds via api should be issues via the Stripe API, Stripe Dashboard, or in app where applicable.
| Delete a transaction |
DELETE |
app.animate.io/api/v1/transactions/:id |
Required Parameters
| Key |
Value |
| auth_token |
Your platform's auth token |