Skip to main content
POST
Start a batch payment import

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json
filename
string

S3 filename of the CSV

original_filename
string

Original uploaded filename

csv_entity_field
string

CSV header name for entity identifier

entity_field
string

Gratona entity field key used for matching

csv_donor_field
string

CSV header name for donor identifier

donor_field
string

Gratona donor field key used for matching

csv_amount_field
string

CSV header name for amount column

csv_date_field
string

CSV header name for payment date column

csv_method_field
string

CSV header name for payment method column

method_default
integer

Default payment method if not specified in CSV

csv_type_field
string

CSV header name for payment type column

type_default
integer

Default payment type if not specified in CSV

csv_result_field
string

CSV header name for result column

source_system
string

External source system label used with source object ID

source_object_type
string

External source object type, defaults to donation

duplicate_policy
enum<string>

How to handle source object IDs, including link-only provenance adoption for an existing Gratona donation

Available options:
create_only,
skip_existing,
fail_on_conflict,
link_existing
csv_source_object_id_field
string

CSV header name for durable source record ID

csv_source_modified_at_field
string

CSV header name for source-system modified timestamp

csv_existing_donation_id_field
string

CSV header name for an existing Gratona donation ID used by link_existing

csv_transaction_id_field
string

CSV header name for gateway/source transaction ID

csv_transaction_status_field
string

CSV header name for transaction status

csv_currency_field
string

CSV header name for ISO currency code

currency_default
string

Default ISO currency code

csv_actual_charged_amount_field
string

CSV header name for actual charged amount

csv_receipt_sent_at_field
string

CSV header name for imported receipt sent date

csv_tax_deductible_field
string

CSV header name for tax deductible flag

tax_deductible_default
boolean

Default tax deductible value when CSV column is not mapped

csv_in_kind_category_field
string

CSV header name for in-kind category

include_refunds
boolean

Whether refund columns should update existing donations

csv_refund_amount_field
string

CSV header name for imported refund amount

csv_refund_date_field
string

CSV header name for imported refund date

csv_refund_id_field
string

CSV header name for external refund ID

csv_refund_reason_field
string

CSV header name for imported refund reason

include_soft_credits
boolean

Whether soft credit columns should create soft credit records

csv_soft_credit_donor_field
string

CSV header name for soft credit donor identifier

soft_credit_donor_field
string

Gratona donor field key used for soft credit donor matching

csv_soft_credit_amount_field
string

CSV header name for soft credit amount

csv_soft_credit_type_field
string

CSV header name for soft credit type name or ID

soft_credit_type_default
string

Default active soft credit type name or ID

csv_soft_credit_note_field
string

CSV header name for soft credit note

csv_soft_credit_source_object_id_field
string

CSV header name for durable soft credit source ID

program_id
integer

Program ID

Response

Batch import started successfully

message
string
Example:

"Payment import batch has been started."

batch_id
integer
Example:

123