Skip to content

Latest commit

 

History

History
24 lines (22 loc) · 3.8 KB

TransactionRequest.md

File metadata and controls

24 lines (22 loc) · 3.8 KB
Raw

RebillySdk::TransactionRequest

Properties

Name Type Description Notes
website_id **** The website identifier string.
customer_id **** The customer identifier string.
currency ****
amount Float The transaction amount.
invoice_ids Array<ResourceId> The array of invoice identifiers. [optional]
payment_instruction **** Payment instruction. If not supplied, customer's default payment instrument will be used. [optional]
billing_address **** Billing address. If not supplied, we use the billing address associated with the payment instrument, and then customer. [optional]
request_id String The request id is recommended. It prevents duplicate transaction requests within a short period of time. If a duplicate request is sent with the same `requestId` it will be ignored to prevent double-billing anyone. It must be unique within a 24-hour period. We recommend generating a UUID v4 as its value. [optional]
gateway_account_id **** Rebilly will select the appropriate payment gateway account for the transaction based on the properties of the transaction and the `gateway-account-requested` event rules configurations. If you wish to prevent Rebilly from making the gateway account selection, you may supply a gateway account id here, and it will be used instead. Only use this field if you intend to override the settings. [optional]
description String The payment description. [optional]
notification_url String The URL where a server-to-server notification request type `POST` with a transaction payload will be sent when the transaction's result is finalized. Do not trust the notification; follow with a `GET` request to confirm the result of the transaction. Please respond with a `2xx` HTTP status code, or we will reattempt the request again. You may use `{id}` or `{result}` as placeholders in the URL and we will replace them with the transaction's id and result accordingly. [optional]
redirect_url String The URL to redirect the end-user when an offsite transaction is completed. Defaults to the website's configured URL. You may use `{id}` or `{result}` as placeholders in the URL and we will replace them with the transaction's id and result accordingly. [optional]
custom_fields ResourceCustomFields [optional]
risk_metadata RiskMetadata [optional]
is_processed_outside BOOLEAN True if transaction was processed outside Rebilly. [optional] [default to false]
is_merchant_initiated BOOLEAN True if the transaction was initiated by the merchant. [optional] [default to false]
processed_time DateTime The time the transaction was processed. Can be specified only if transaction was processed outside Rebilly. [optional]
type String The type of transaction requested. You should always include the type within your API request. This supports a limited subset of Transaction types. To refund or void, use the refund endpoint. To `capture` use the `sale` type. If any existing `authorize` transactions are eligible, then they will be captured and the `sale` will be converted to a `capture` type. The `setup` type will set up the payment instrument by following the `setupInstruction` in the selected gateway account. If the instruction is to `do-nothing`, a transaction with result `approved` of type `setup` will be returned.