/transaction/create
Allows you to create a transaction.
Query Params / Form Data
Contains your API key.
Get it from here.
The amount of the transaction in the selected currency.
This value must be in the currency specified by the `currency` parameter.
Worth between 0.1 and 1,000,000 USD. Omit it for an open-ended
transaction.
The currency of the transaction.
A comma-separated list of allowed payment methods for this transaction.
If only one payment method is allowed the payment method selection dialog will be skipped at checkout.
Up to 25 entries, each of which must exist on your account.
The URL to notify when a transaction event occurs.
More info about webhooks can be found here.
Response JSON
Indicates the result of the API request.
For more details about error handling, check here.
The unique ID for the created transaction. It is public.
A private key associated with the transaction. Keep it private - it is both the cancellation credential and the webhook signing secret, and it is returned exactly once, here.
When the transaction stops being payable, in Unix seconds. Always 24 hours after creation.
/transaction/setpaymentmethod
Allows you to set the payment method for an existing transaction.
Query Params / Form Data
The unique ID for the transaction to be updated.
The payment method to be set for the transaction.
Response JSON
Indicates the result of the API request.
For more details about error handling, check here.
The payment instructions that were just minted - the receiving
address or PayPal email, what the buyer owes and in which currency,
and the locked-in rate.
This is the same object /transaction/info returns, so there is no
need to call that endpoint afterwards just to learn the address.
/transaction/cancel
Allows you to cancel a pending transaction.
Cancelling requires proof of ownership: your API key, or the transaction's
private_key. Anything else is a 403. Cancelling is final - nothing revisits
a cancelled transaction, so funds sent to the address afterwards will not
settle.
Query Params / Form Data
The unique ID for the transaction to be cancelled.
The transaction's private key. An alternative to authenticating with your API key - this is the credential a buyer-facing checkout holds.
Response JSON
Indicates the result of the API request.
For more details about error handling, check here.
/transaction/info
Allows you to retrieve information about a transaction.
Query Params / Form Data
Optional API key for accessing private transaction information.
If not provided, only public information will be returned.
The unique ID for the transaction whose information is to be retrieved.
Response JSON
Indicates the result of the API request.
For more details about error handling, check here.
The unique ID of the transaction.
The ID of the seller involved in the transaction.
The current status of the transaction.
The total amount of the transaction that needs to be paid.
The amount already paid for the transaction.
The currency used for the transaction.
An array of allowed payment methods for this transaction.
The timestamp when the transaction was created.
The expiration timestamp of the transaction.
The timestamp when the transaction was cancelled, if applicable.
The timestamp when the transaction was completed, if applicable.
Payment details associated with the transaction, if applicable.
A private key associated with the transaction.
Only returned if a valid API key was provided.
The URL of the webhook to notify when the status changes.
Only returned if a valid API key was provided.