post https://api.berbix.com/v0/transactions
Purpose: To create a transaction associated with a provided Customer UID.
Auth: Requires a Basic auth using an API Secret
as the username with no password.
Expected Response: Returns tokens: refresh_token
, client_token
, and access_token
.
Note: The creation of test transactions is subject to rate-limiting based on the number of test transactions completed in the last four hours.
API Library Usage
var transactionTokens = client.createTransaction({
customerUid: "interal_customer_uid", // ID for the user in internal database
templateKey: "<<template_key>>", // Template key for this transaction
})
$transactionTokens = $client->createTransaction(array(
'customerUid' => "interal_customer_uid", // ID for the user in internal database
'templateKey' => "<<template_key>>", // Template key for this transaction
));
var transactionTokens = client.createTransaction({
"customer_uid": "interal_customer_uid", // ID for the user in internal database
"template_key": "<<template_key>>", // Template key for this transaction
})
transaction_tokens = client.create_transaction(
customer_uid: 'internal_customer_uid', # ID for the user in client database
template_key: '<<template_key>>', # Template key for this transaction
)
CreateHostedTransactionRequest request = new CreateHostedTransactionRequest();
request.customerUid = "interal_customer_uid"; // ID for the user in internal database
request.templateKey = "<<template_key>>"; // Template key for this transaction
CreateHostedTransactionResponse response = berbixClient.createHostedTransaction(request);
tokens, err := client.CreateTransaction(&CreateTransactionOptions{
CustomerUID: "internal_customer_uid", # ID for the user in client database
TemplateKey: "<<template_key>>", # Template key for this transaction,
})
Minimum Body Requirements: customer_uid
and template_key
Additional Requirements:
- Low Code Integration: Include
hosted_options
to create a hosted transaction. - API-Only Integration: Include one or more
api_only_options
if images will be provided directly to the Berbix API as opposed to using a web or mobile client SDK- If API-Only Selfies are enabled, include
consents_to_automated_facial_recognition
. - When API-only values are included, the response will include the
first_step
property.
email
and/orphone
may be included to pre-fill handoff data.
- If API-Only Selfies are enabled, include
Populate values in the Body Params panel below to test.