Record an offline commitment payment

POST

zapier

actions

commitments

{id}

offline-payments

Record an offline commitment payment

curl --request POST \
  --url https://api.gratona.com/v3/zapier/actions/commitments/{id}/offline-payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 25,
  "payment_date": "2026-10-20",
  "external_reference": "external-recurring-001",
  "payment_method": 2,
  "currency": "$",
  "notes": "Offline gift received.",
  "idempotency_key": "external-record-001"
}
'

import requests

url = "https://api.gratona.com/v3/zapier/actions/commitments/{id}/offline-payments"

payload = {
    "amount": 25,
    "payment_date": "2026-10-20",
    "external_reference": "external-recurring-001",
    "payment_method": 2,
    "currency": "$",
    "notes": "Offline gift received.",
    "idempotency_key": "external-record-001"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: 25,
    payment_date: '2026-10-20',
    external_reference: 'external-recurring-001',
    payment_method: 2,
    currency: '$',
    notes: 'Offline gift received.',
    idempotency_key: 'external-record-001'
  })
};

fetch('https://api.gratona.com/v3/zapier/actions/commitments/{id}/offline-payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gratona.com/v3/zapier/actions/commitments/{id}/offline-payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 25,
    'payment_date' => '2026-10-20',
    'external_reference' => 'external-recurring-001',
    'payment_method' => 2,
    'currency' => '$',
    'notes' => 'Offline gift received.',
    'idempotency_key' => 'external-record-001'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gratona.com/v3/zapier/actions/commitments/{id}/offline-payments"

	payload := strings.NewReader("{\n  \"amount\": 25,\n  \"payment_date\": \"2026-10-20\",\n  \"external_reference\": \"external-recurring-001\",\n  \"payment_method\": 2,\n  \"currency\": \"$\",\n  \"notes\": \"Offline gift received.\",\n  \"idempotency_key\": \"external-record-001\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gratona.com/v3/zapier/actions/commitments/{id}/offline-payments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 25,\n  \"payment_date\": \"2026-10-20\",\n  \"external_reference\": \"external-recurring-001\",\n  \"payment_method\": 2,\n  \"currency\": \"$\",\n  \"notes\": \"Offline gift received.\",\n  \"idempotency_key\": \"external-record-001\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v3/zapier/actions/commitments/{id}/offline-payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 25,\n  \"payment_date\": \"2026-10-20\",\n  \"external_reference\": \"external-recurring-001\",\n  \"payment_method\": 2,\n  \"currency\": \"$\",\n  \"notes\": \"Offline gift received.\",\n  \"idempotency_key\": \"external-record-001\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": 12345,
  "client_id": 12345,
  "donor_id": 12345,
  "commitment_id": 12345,
  "sponsorship_id": 12345,
  "designation": 4711,
  "type": 12345,
  "one_time": 1,
  "method": 1,
  "currency": "$",
  "method_label": "example",
  "payment_date": "2026-10-20",
  "external_reference": "external-recurring-001",
  "transaction_id": "external-payment-001",
  "transaction_status": "completed",
  "notes": "Offline gift received.",
  "created_at": "2026-10-20T10:00:00Z",
  "updated_at": "2026-10-20T10:00:00Z",
  "amount": 25,
  "refunded_amount": 0,
  "net_amount": 25,
  "remaining_refundable_amount": 25,
  "individual_transaction_amount": 25,
  "payment_transaction_amount": 25,
  "combined_transaction_amount": 25,
  "batched_individual_amount": 25,
  "non_batched_transaction_amount": 25,
  "actual_charged_amount": 25,
  "batch_donation_id": 12345,
  "batch_id": 12345,
  "batch_count": 12345,
  "is_batched": false,
  "has_combined_transaction_amount": false,
  "batch_group_id": "example",
  "amount_context": "example",
  "batch_donation_ids": [
    123
  ],
  "processing_fee": 25,
  "platform_fee": 25,
  "amount_excluding_fee": 25,
  "processor_net_amount": 25,
  "donor_covered_fee": 25,
  "processor_fee_currency": "example",
  "processing_fee_known": false
}

{
  "success": true,
  "data": "<unknown>",
  "errors": [
    {
      "code": "VALIDATION_ERROR",
      "message": "Record was not found.",
      "details": "<unknown>",
      "field": "donor_id",
      "messages": [
        "<string>"
      ]
    }
  ],
  "warnings": [
    "<string>"
  ],
  "meta": "<unknown>"
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "success": false,
  "errors": [
    {
      "code": "INSUFFICIENT_SCOPE",
      "message": "Required scope is missing.",
      "required_scope": "schema:read",
      "available_scopes": [
        "<string>"
      ],
      "required_permission_groups": [
        [
          "<string>"
        ]
      ]
    }
  ]
}

{
  "success": true,
  "data": "<unknown>",
  "errors": [
    {
      "code": "VALIDATION_ERROR",
      "message": "Record was not found.",
      "details": "<unknown>",
      "field": "donor_id",
      "messages": [
        "<string>"
      ]
    }
  ],
  "warnings": [
    "<string>"
  ],
  "meta": "<unknown>"
}

{
  "success": true,
  "data": "<unknown>",
  "errors": [
    {
      "code": "VALIDATION_ERROR",
      "message": "Record was not found.",
      "details": "<unknown>",
      "field": "donor_id",
      "messages": [
        "<string>"
      ]
    }
  ],
  "warnings": [
    "<string>"
  ],
  "meta": "<unknown>"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Headers

Idempotency-Key

string

Stable mutation replay key. Required for note creation; offline payments derive a key from external_reference when omitted.

Maximum string length: 191

Path Parameters

integer

required

Identifier of the existing record in the authenticated organization.

Body

application/json

Validated input accepted by this Zapier transport.

amount

number

required

Individual gift amount in the supplied currency. Validation: required|numeric|min:0.01.

Required range: x >= 0.01

Example:

25

payment_date

string<date>

required

Date the offline payment was received. Validation: required|date.

Example:

"2026-10-20"

external_reference

string

required

Stable external record/reference identifying this mutation occurrence. Validation: required|string|max:191.

Maximum string length: 191

Example:

"external-recurring-001"

payment_method

enum<integer> | null

Offline method: 1 cash, 2 check, 4 wire transfer, 7 external processor. Validation: nullable|integer|in:1,2,4,7.

Available options:

1,

2,

4,

7,

null

Example:

2

currency

string | null

Stored currency value; legacy callers commonly use a currency symbol. Validation: nullable|string|max:10.

Maximum string length: 10

Example:

"$"

notes

string | null

Internal description associated with the recorded gift. Validation: nullable|string|max:5000.

Maximum string length: 5000

Example:

"Offline gift received."

idempotency_key

string | null

Stable caller key used by the selected mutation to prevent duplicate records. Validation: nullable|string|max:191.

Maximum string length: 191

Example:

"external-record-001"

Response

Created, updated or replayed record; this transport unwraps the primitive success envelope.

integer | null

Existing record identifier in the authenticated organization.

Example:

12345

client_id

integer | null

Client id.

Example:

12345

donor_id

integer | null

Donor who owns the gift or commitment.

Example:

12345

commitment_id

integer | null

Commitment id.

Example:

12345

sponsorship_id

integer | null

Sponsorship id.

Example:

12345

designation

integer | null

Recipient/designation identifier for the donation.

Example:

4711

type

integer | null

Record type accepted by this operation.

Example:

12345

one_time

integer | null

Compatibility one-time gift indicator.

Example:

1

method

integer | null

Stored compatibility payment method identifier.

Example:

1

currency

string | null

Stored currency value; legacy callers commonly use a currency symbol.

Example:

"$"

method_label

string | null

Method label.

Example:

"example"

payment_date

string | null

Date the offline payment was received.

Example:

"2026-10-20"

external_reference

string | null

Stable external record/reference identifying this mutation occurrence.

Example:

"external-recurring-001"

transaction_id

string | null

External transaction reference stored with the record.

Example:

"external-payment-001"

transaction_status

string | null

Recorded settlement status.

Example:

"completed"

notes

string | null

Internal description associated with the recorded gift.

Example:

"Offline gift received."

created_at

string | null

Created at.

Example:

"2026-10-20T10:00:00Z"

updated_at

string | null

Updated at.

Example:

"2026-10-20T10:00:00Z"

amount

number | null

Individual gift amount in the supplied currency.

Example:

25

refunded_amount

number | null

Recorded amount already refunded.

Example:

0

net_amount

number | null

Net amount.

Example:

25

remaining_refundable_amount

number | null

Remaining refundable amount.

Example:

25

individual_transaction_amount

number | null

Individual transaction amount.

Example:

25

payment_transaction_amount

number | null

Payment transaction amount.

Example:

25

combined_transaction_amount

number | null

Combined transaction amount.

Example:

25

batched_individual_amount

number | null

Batched individual amount.

Example:

25

non_batched_transaction_amount

number | null

Non batched transaction amount.

Example:

25

actual_charged_amount

number | null

Actual charged amount.

Example:

25

batch_donation_id

integer | null

Batch donation id.

Example:

12345

batch_id

integer | null

Batch id.

Example:

12345

batch_count

integer | null

Batch count.

Example:

12345

is_batched

boolean | null

Is batched.

Example:

false

has_combined_transaction_amount

boolean | null

Has combined transaction amount.

Example:

false

batch_group_id

string | null

Batch group id.

Example:

"example"

amount_context

string | null

Amount context.

Example:

"example"

batch_donation_ids

integer[]

Numeric donation IDs sharing the combined payment context.

processing_fee

number | null

Processing fee.

Example:

25

platform_fee

number | null

Platform fee.

Example:

25

amount_excluding_fee

number | null

Amount excluding fee.

Example:

25

processor_net_amount

number | null

Processor net amount.

Example:

25

donor_covered_fee

number | null

Donor covered fee.

Example:

25

processor_fee_currency

string | null

Processor fee currency.

Example:

"example"

processing_fee_known

boolean | null

Processing fee known.

Example:

false

Record an offline commitment payment

curl --request POST \
  --url https://api.gratona.com/v3/zapier/actions/commitments/{id}/offline-payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 25,
  "payment_date": "2026-10-20",
  "external_reference": "external-recurring-001",
  "payment_method": 2,
  "currency": "$",
  "notes": "Offline gift received.",
  "idempotency_key": "external-record-001"
}
'

import requests

url = "https://api.gratona.com/v3/zapier/actions/commitments/{id}/offline-payments"

payload = {
    "amount": 25,
    "payment_date": "2026-10-20",
    "external_reference": "external-recurring-001",
    "payment_method": 2,
    "currency": "$",
    "notes": "Offline gift received.",
    "idempotency_key": "external-record-001"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: 25,
    payment_date: '2026-10-20',
    external_reference: 'external-recurring-001',
    payment_method: 2,
    currency: '$',
    notes: 'Offline gift received.',
    idempotency_key: 'external-record-001'
  })
};

fetch('https://api.gratona.com/v3/zapier/actions/commitments/{id}/offline-payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gratona.com/v3/zapier/actions/commitments/{id}/offline-payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 25,
    'payment_date' => '2026-10-20',
    'external_reference' => 'external-recurring-001',
    'payment_method' => 2,
    'currency' => '$',
    'notes' => 'Offline gift received.',
    'idempotency_key' => 'external-record-001'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gratona.com/v3/zapier/actions/commitments/{id}/offline-payments"

	payload := strings.NewReader("{\n  \"amount\": 25,\n  \"payment_date\": \"2026-10-20\",\n  \"external_reference\": \"external-recurring-001\",\n  \"payment_method\": 2,\n  \"currency\": \"$\",\n  \"notes\": \"Offline gift received.\",\n  \"idempotency_key\": \"external-record-001\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gratona.com/v3/zapier/actions/commitments/{id}/offline-payments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 25,\n  \"payment_date\": \"2026-10-20\",\n  \"external_reference\": \"external-recurring-001\",\n  \"payment_method\": 2,\n  \"currency\": \"$\",\n  \"notes\": \"Offline gift received.\",\n  \"idempotency_key\": \"external-record-001\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v3/zapier/actions/commitments/{id}/offline-payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 25,\n  \"payment_date\": \"2026-10-20\",\n  \"external_reference\": \"external-recurring-001\",\n  \"payment_method\": 2,\n  \"currency\": \"$\",\n  \"notes\": \"Offline gift received.\",\n  \"idempotency_key\": \"external-record-001\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": 12345,
  "client_id": 12345,
  "donor_id": 12345,
  "commitment_id": 12345,
  "sponsorship_id": 12345,
  "designation": 4711,
  "type": 12345,
  "one_time": 1,
  "method": 1,
  "currency": "$",
  "method_label": "example",
  "payment_date": "2026-10-20",
  "external_reference": "external-recurring-001",
  "transaction_id": "external-payment-001",
  "transaction_status": "completed",
  "notes": "Offline gift received.",
  "created_at": "2026-10-20T10:00:00Z",
  "updated_at": "2026-10-20T10:00:00Z",
  "amount": 25,
  "refunded_amount": 0,
  "net_amount": 25,
  "remaining_refundable_amount": 25,
  "individual_transaction_amount": 25,
  "payment_transaction_amount": 25,
  "combined_transaction_amount": 25,
  "batched_individual_amount": 25,
  "non_batched_transaction_amount": 25,
  "actual_charged_amount": 25,
  "batch_donation_id": 12345,
  "batch_id": 12345,
  "batch_count": 12345,
  "is_batched": false,
  "has_combined_transaction_amount": false,
  "batch_group_id": "example",
  "amount_context": "example",
  "batch_donation_ids": [
    123
  ],
  "processing_fee": 25,
  "platform_fee": 25,
  "amount_excluding_fee": 25,
  "processor_net_amount": 25,
  "donor_covered_fee": 25,
  "processor_fee_currency": "example",
  "processing_fee_known": false
}

{
  "success": true,
  "data": "<unknown>",
  "errors": [
    {
      "code": "VALIDATION_ERROR",
      "message": "Record was not found.",
      "details": "<unknown>",
      "field": "donor_id",
      "messages": [
        "<string>"
      ]
    }
  ],
  "warnings": [
    "<string>"
  ],
  "meta": "<unknown>"
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "success": false,
  "errors": [
    {
      "code": "INSUFFICIENT_SCOPE",
      "message": "Required scope is missing.",
      "required_scope": "schema:read",
      "available_scopes": [
        "<string>"
      ],
      "required_permission_groups": [
        [
          "<string>"
        ]
      ]
    }
  ]
}

{
  "success": true,
  "data": "<unknown>",
  "errors": [
    {
      "code": "VALIDATION_ERROR",
      "message": "Record was not found.",
      "details": "<unknown>",
      "field": "donor_id",
      "messages": [
        "<string>"
      ]
    }
  ],
  "warnings": [
    "<string>"
  ],
  "meta": "<unknown>"
}

{
  "success": true,
  "data": "<unknown>",
  "errors": [
    {
      "code": "VALIDATION_ERROR",
      "message": "Record was not found.",
      "details": "<unknown>",
      "field": "donor_id",
      "messages": [
        "<string>"
      ]
    }
  ],
  "warnings": [
    "<string>"
  ],
  "meta": "<unknown>"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}