Bridging Intent and Action
A TransactionRequest is the crucial link between a customer's desire to pay and the actual transfer of crypto assets. Let's break down this key component of our payment process.
Endpoints
POST /transaction-requests
What is a TransactionRequest?
The TransactionRequest object is created for a Payment when a customer has an intent to make a payment. When a customer decides to pay, we generate this object, which includes:
destination_address
: The blockchain address where the customer needs to send their payment.amount
: The exact amount of cryptocurrency to be sent.currency_id
: The specific cryptocurrency to be used for the payment.
These details ensure that the right amount of the right crypto goes to the right place.
Securing the Transaction: Signatures
For some blockchain transactions, we require a digital signature. This acts like a seal of authenticity on your payment instruction. To learn how to generate and use these signatures, check out our "Signature Generation" guide.
Tracking Progress: TransactionRequest Status
Every TransactionRequest has a lifecycle, represented by its status
attribute. Here's what each status means:
Status | Description |
---|---|
pending | The starting point. We've created the TransactionRequest, but no action has been taken yet. |
confirming | The customer has sent the transaction, but we're waiting for the blockchain to confirm it. |
confirmed | Success! The blockchain has confirmed the transaction. The payment is complete. |
failed | Unfortunately, the transaction sent by the customer failed on the blockchain. |
Pro Tip:
By monitoring the status of a TransactionRequest, you can keep your customers informed about their payment progress in real-time.