GuidesAPI Reference
API Reference
SupportPartnerStack Login

Create a transaction

post
https://api.partnerstack.com/api/v2/transactions

Creates a new transaction

Note that customer_external_key or customer_email can be provided in place of customer_key to reference the customer. The customer_key referred in this endpoint corresponds to the internal customer key generated by PartnerStack.

These customer reference fields are required, but mutually exclusive (i.e. you must provide exactly and only one of the three).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 255

An external key that can be used to reference the customer. This is the same as the customer_key value used when creating the customer with PartnerStackJS.

integer
required
-50000000000 to 50000000000

Transaction amount in cents for specified currency.

string | null

Key of transaction category.

string
required
length between 3 and 3

Transaction currency type. Note that the format is the three-letter ISO currency code.

string
length between 1 and 255

Key of customer who made the transaction.

string
length between 4 and 255

Key of transaction record in PartnerStack.

metadata
object | null

Additional data that can be provided for the transaction on creation. Note that you can only store a maximum of 25 metadata attributes. The value of each attribute cannot exceed 100 characters, and the name of each attribute cannot exceed 30 characters.

string | null

Key of transaction product.

boolean

True if created in a test partnership or by a test customer

integer

The created_at date of the transaction in epoch (ms).

string | null

The unique identifier of the teammate that drove the transaction.

string | null

External identifier of the subscription/product associated with the transaction.

Responses

Updated 13 days ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 13 days ago