Skip to main content

TransactionPatchInput

    external_id string

    Payment gateway id

    order_amount integer

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

    donation_amount integer

    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 string

    Donation currency

    charity_id uuid

    Cents id of the charity

    donation_cause string

    Cause unique name (in the namespace of the charity)

    consumer_user_id string

    Cents id of consumer user (if we have data of it)

    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)

    consumer_user_email_anonymized boolean

    Consumer user email anonymized flag (if email is anonymized or not)

    billable_address

    object

    street_address stringrequired
    city stringrequired
    region_state stringrequired
    zip_code stringrequired
    country stringrequired
    payment_method uuid

    Payment method id to be used for this transactions. This field is needed only in the scenarios where there are multiple payment options available and the payment method to be used has to be stored in cents.

    transaction_status string

    Possible values: [draft, to_be_payed, 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 company) used to reconcilate transaction with the pre_transaction