TransactionInput

external_id string

Payment gateway id

company_website url

url of the company

company_id uuid

id of the company

payment_gateway_company_id uuid

Payment gateway internal id of the company (even if we do not have data of it)

company_sector string

sector of the company

payment_gateway_order_transaction_id string

Payment Gateway Order Transaction ID, the Identifier for the Initial (order) Transaction in the Process Flow.

order_amount integer

Transaction amount (in the smallest currency unit, so 1000 is 10.00€)

donation_amount integerrequired

Donation amount (in the smallest currency unit, so 1000 is 10.00€)

donation_percentage integer

Donation percentage if available (in integer format, so 3% is 3)

total_amount integer

Total (transaction+donation) amount (in the smallest currency unit, so 1000 is 10.00€)

currency string

Transaction currency

donation_currency stringrequired

Donation currency

charity_id uuid

Cents id of the charity

donation_cause string

Cause unique name (in the namespace of the charity)

consumer_user_full_name string

Consumer user name (if we have data of it)

consumer_user_email email

Consumer user email (if we have data of it)

consumer_user_phone string

Consumer user phone number (if we have data of it)

billable_address

object

street_address stringrequired

city stringrequired

region_state stringrequired

zip_code stringrequired

country stringrequired
transaction_status string

Possible values: [draft, paid, refunded, disputed, failed]

Transaction status

refunded_amount integer

Refunded amount (in the smallest currency unit, so 1000 is 10.00€)

reconciliation_id string

External ID (generated by the payment gateway) used to reconcilate transaction with the pre_transaction