Authorize Payment

curl --request POST \
  --url https://server.stage.overflow.co/api/v3/payments/authorize \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-client-id: <api-key>' \
  --data '
{
  "amountInCents": 5000,
  "email": "jane@example.com",
  "paymentMethod": {
    "paymentMethodType": "Card",
    "defaultForDonor": true,
    "encryptedCardNumber": "<string>",
    "encryptedExpiryMonth": "<string>",
    "encryptedExpiryYear": "<string>",
    "encryptedSecurityCode": "<string>"
  },
  "processingChannel": "Ecommerce",
  "anonymous": false,
  "billingAddress": {
    "city": "<string>",
    "country": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "browserInfo": {
    "acceptHeader": "<string>",
    "colorDepth": 123,
    "javaEnabled": true,
    "language": "<string>",
    "screenHeight": 123,
    "screenWidth": 123,
    "timeZoneOffset": 123,
    "userAgent": "<string>"
  },
  "dedication": {
    "recipientEmail": "<string>",
    "recipientName": "<string>"
  },
  "deductible": true,
  "firstName": "Jane",
  "fundId": "fund_abc123",
  "lastName": "Donor",
  "locationId": "<string>",
  "metadata": {},
  "notes": "<string>",
  "phone": "+15555550100",
  "riskData": {
    "clientData": "<string>"
  },
  "subFundId": "<string>"
}
'

import requests

url = "https://server.stage.overflow.co/api/v3/payments/authorize"

payload = {
    "amountInCents": 5000,
    "email": "jane@example.com",
    "paymentMethod": {
        "paymentMethodType": "Card",
        "defaultForDonor": True,
        "encryptedCardNumber": "<string>",
        "encryptedExpiryMonth": "<string>",
        "encryptedExpiryYear": "<string>",
        "encryptedSecurityCode": "<string>"
    },
    "processingChannel": "Ecommerce",
    "anonymous": False,
    "billingAddress": {
        "city": "<string>",
        "country": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "state": "<string>",
        "zip": "<string>"
    },
    "browserInfo": {
        "acceptHeader": "<string>",
        "colorDepth": 123,
        "javaEnabled": True,
        "language": "<string>",
        "screenHeight": 123,
        "screenWidth": 123,
        "timeZoneOffset": 123,
        "userAgent": "<string>"
    },
    "dedication": {
        "recipientEmail": "<string>",
        "recipientName": "<string>"
    },
    "deductible": True,
    "firstName": "Jane",
    "fundId": "fund_abc123",
    "lastName": "Donor",
    "locationId": "<string>",
    "metadata": {},
    "notes": "<string>",
    "phone": "+15555550100",
    "riskData": { "clientData": "<string>" },
    "subFundId": "<string>"
}
headers = {
    "x-client-id": "<api-key>",
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-client-id': '<api-key>',
    'x-api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amountInCents: 5000,
    email: 'jane@example.com',
    paymentMethod: {
      paymentMethodType: 'Card',
      defaultForDonor: true,
      encryptedCardNumber: '<string>',
      encryptedExpiryMonth: '<string>',
      encryptedExpiryYear: '<string>',
      encryptedSecurityCode: '<string>'
    },
    processingChannel: 'Ecommerce',
    anonymous: false,
    billingAddress: {
      city: '<string>',
      country: '<string>',
      line1: '<string>',
      line2: '<string>',
      state: '<string>',
      zip: '<string>'
    },
    browserInfo: {
      acceptHeader: '<string>',
      colorDepth: 123,
      javaEnabled: true,
      language: '<string>',
      screenHeight: 123,
      screenWidth: 123,
      timeZoneOffset: 123,
      userAgent: '<string>'
    },
    dedication: {recipientEmail: '<string>', recipientName: '<string>'},
    deductible: true,
    firstName: 'Jane',
    fundId: 'fund_abc123',
    lastName: 'Donor',
    locationId: '<string>',
    metadata: {},
    notes: '<string>',
    phone: '+15555550100',
    riskData: {clientData: '<string>'},
    subFundId: '<string>'
  })
};

fetch('https://server.stage.overflow.co/api/v3/payments/authorize', 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://server.stage.overflow.co/api/v3/payments/authorize",
  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([
    'amountInCents' => 5000,
    'email' => 'jane@example.com',
    'paymentMethod' => [
        'paymentMethodType' => 'Card',
        'defaultForDonor' => true,
        'encryptedCardNumber' => '<string>',
        'encryptedExpiryMonth' => '<string>',
        'encryptedExpiryYear' => '<string>',
        'encryptedSecurityCode' => '<string>'
    ],
    'processingChannel' => 'Ecommerce',
    'anonymous' => false,
    'billingAddress' => [
        'city' => '<string>',
        'country' => '<string>',
        'line1' => '<string>',
        'line2' => '<string>',
        'state' => '<string>',
        'zip' => '<string>'
    ],
    'browserInfo' => [
        'acceptHeader' => '<string>',
        'colorDepth' => 123,
        'javaEnabled' => true,
        'language' => '<string>',
        'screenHeight' => 123,
        'screenWidth' => 123,
        'timeZoneOffset' => 123,
        'userAgent' => '<string>'
    ],
    'dedication' => [
        'recipientEmail' => '<string>',
        'recipientName' => '<string>'
    ],
    'deductible' => true,
    'firstName' => 'Jane',
    'fundId' => 'fund_abc123',
    'lastName' => 'Donor',
    'locationId' => '<string>',
    'metadata' => [
        
    ],
    'notes' => '<string>',
    'phone' => '+15555550100',
    'riskData' => [
        'clientData' => '<string>'
    ],
    'subFundId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>",
    "x-client-id: <api-key>"
  ],
]);

$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://server.stage.overflow.co/api/v3/payments/authorize"

	payload := strings.NewReader("{\n  \"amountInCents\": 5000,\n  \"email\": \"jane@example.com\",\n  \"paymentMethod\": {\n    \"paymentMethodType\": \"Card\",\n    \"defaultForDonor\": true,\n    \"encryptedCardNumber\": \"<string>\",\n    \"encryptedExpiryMonth\": \"<string>\",\n    \"encryptedExpiryYear\": \"<string>\",\n    \"encryptedSecurityCode\": \"<string>\"\n  },\n  \"processingChannel\": \"Ecommerce\",\n  \"anonymous\": false,\n  \"billingAddress\": {\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip\": \"<string>\"\n  },\n  \"browserInfo\": {\n    \"acceptHeader\": \"<string>\",\n    \"colorDepth\": 123,\n    \"javaEnabled\": true,\n    \"language\": \"<string>\",\n    \"screenHeight\": 123,\n    \"screenWidth\": 123,\n    \"timeZoneOffset\": 123,\n    \"userAgent\": \"<string>\"\n  },\n  \"dedication\": {\n    \"recipientEmail\": \"<string>\",\n    \"recipientName\": \"<string>\"\n  },\n  \"deductible\": true,\n  \"firstName\": \"Jane\",\n  \"fundId\": \"fund_abc123\",\n  \"lastName\": \"Donor\",\n  \"locationId\": \"<string>\",\n  \"metadata\": {},\n  \"notes\": \"<string>\",\n  \"phone\": \"+15555550100\",\n  \"riskData\": {\n    \"clientData\": \"<string>\"\n  },\n  \"subFundId\": \"<string>\"\n}")

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

	req.Header.Add("x-client-id", "<api-key>")
	req.Header.Add("x-api-key", "<api-key>")
	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://server.stage.overflow.co/api/v3/payments/authorize")
  .header("x-client-id", "<api-key>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amountInCents\": 5000,\n  \"email\": \"jane@example.com\",\n  \"paymentMethod\": {\n    \"paymentMethodType\": \"Card\",\n    \"defaultForDonor\": true,\n    \"encryptedCardNumber\": \"<string>\",\n    \"encryptedExpiryMonth\": \"<string>\",\n    \"encryptedExpiryYear\": \"<string>\",\n    \"encryptedSecurityCode\": \"<string>\"\n  },\n  \"processingChannel\": \"Ecommerce\",\n  \"anonymous\": false,\n  \"billingAddress\": {\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip\": \"<string>\"\n  },\n  \"browserInfo\": {\n    \"acceptHeader\": \"<string>\",\n    \"colorDepth\": 123,\n    \"javaEnabled\": true,\n    \"language\": \"<string>\",\n    \"screenHeight\": 123,\n    \"screenWidth\": 123,\n    \"timeZoneOffset\": 123,\n    \"userAgent\": \"<string>\"\n  },\n  \"dedication\": {\n    \"recipientEmail\": \"<string>\",\n    \"recipientName\": \"<string>\"\n  },\n  \"deductible\": true,\n  \"firstName\": \"Jane\",\n  \"fundId\": \"fund_abc123\",\n  \"lastName\": \"Donor\",\n  \"locationId\": \"<string>\",\n  \"metadata\": {},\n  \"notes\": \"<string>\",\n  \"phone\": \"+15555550100\",\n  \"riskData\": {\n    \"clientData\": \"<string>\"\n  },\n  \"subFundId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://server.stage.overflow.co/api/v3/payments/authorize")

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

request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<api-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amountInCents\": 5000,\n  \"email\": \"jane@example.com\",\n  \"paymentMethod\": {\n    \"paymentMethodType\": \"Card\",\n    \"defaultForDonor\": true,\n    \"encryptedCardNumber\": \"<string>\",\n    \"encryptedExpiryMonth\": \"<string>\",\n    \"encryptedExpiryYear\": \"<string>\",\n    \"encryptedSecurityCode\": \"<string>\"\n  },\n  \"processingChannel\": \"Ecommerce\",\n  \"anonymous\": false,\n  \"billingAddress\": {\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip\": \"<string>\"\n  },\n  \"browserInfo\": {\n    \"acceptHeader\": \"<string>\",\n    \"colorDepth\": 123,\n    \"javaEnabled\": true,\n    \"language\": \"<string>\",\n    \"screenHeight\": 123,\n    \"screenWidth\": 123,\n    \"timeZoneOffset\": 123,\n    \"userAgent\": \"<string>\"\n  },\n  \"dedication\": {\n    \"recipientEmail\": \"<string>\",\n    \"recipientName\": \"<string>\"\n  },\n  \"deductible\": true,\n  \"firstName\": \"Jane\",\n  \"fundId\": \"fund_abc123\",\n  \"lastName\": \"Donor\",\n  \"locationId\": \"<string>\",\n  \"metadata\": {},\n  \"notes\": \"<string>\",\n  \"phone\": \"+15555550100\",\n  \"riskData\": {\n    \"clientData\": \"<string>\"\n  },\n  \"subFundId\": \"<string>\"\n}"

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

{
  "donorId": "6710f34fd5061afeec3eab57",
  "contributionId": "7710f34fd5061afeec3eab59",
  "paymentMethodId": "5710f34fd5061afeec3eab58",
  "paymentMethod": {
    "brand": "visa",
    "last4": "1111",
    "expiration": {
      "month": "<string>",
      "year": "<string>"
    }
  },
  "subscriptionId": "8810f34fd5061afeec3eab60"
}

POST

api

payments

authorize

Authorize Payment

curl --request POST \
  --url https://server.stage.overflow.co/api/v3/payments/authorize \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-client-id: <api-key>' \
  --data '
{
  "amountInCents": 5000,
  "email": "jane@example.com",
  "paymentMethod": {
    "paymentMethodType": "Card",
    "defaultForDonor": true,
    "encryptedCardNumber": "<string>",
    "encryptedExpiryMonth": "<string>",
    "encryptedExpiryYear": "<string>",
    "encryptedSecurityCode": "<string>"
  },
  "processingChannel": "Ecommerce",
  "anonymous": false,
  "billingAddress": {
    "city": "<string>",
    "country": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "browserInfo": {
    "acceptHeader": "<string>",
    "colorDepth": 123,
    "javaEnabled": true,
    "language": "<string>",
    "screenHeight": 123,
    "screenWidth": 123,
    "timeZoneOffset": 123,
    "userAgent": "<string>"
  },
  "dedication": {
    "recipientEmail": "<string>",
    "recipientName": "<string>"
  },
  "deductible": true,
  "firstName": "Jane",
  "fundId": "fund_abc123",
  "lastName": "Donor",
  "locationId": "<string>",
  "metadata": {},
  "notes": "<string>",
  "phone": "+15555550100",
  "riskData": {
    "clientData": "<string>"
  },
  "subFundId": "<string>"
}
'

import requests

url = "https://server.stage.overflow.co/api/v3/payments/authorize"

payload = {
    "amountInCents": 5000,
    "email": "jane@example.com",
    "paymentMethod": {
        "paymentMethodType": "Card",
        "defaultForDonor": True,
        "encryptedCardNumber": "<string>",
        "encryptedExpiryMonth": "<string>",
        "encryptedExpiryYear": "<string>",
        "encryptedSecurityCode": "<string>"
    },
    "processingChannel": "Ecommerce",
    "anonymous": False,
    "billingAddress": {
        "city": "<string>",
        "country": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "state": "<string>",
        "zip": "<string>"
    },
    "browserInfo": {
        "acceptHeader": "<string>",
        "colorDepth": 123,
        "javaEnabled": True,
        "language": "<string>",
        "screenHeight": 123,
        "screenWidth": 123,
        "timeZoneOffset": 123,
        "userAgent": "<string>"
    },
    "dedication": {
        "recipientEmail": "<string>",
        "recipientName": "<string>"
    },
    "deductible": True,
    "firstName": "Jane",
    "fundId": "fund_abc123",
    "lastName": "Donor",
    "locationId": "<string>",
    "metadata": {},
    "notes": "<string>",
    "phone": "+15555550100",
    "riskData": { "clientData": "<string>" },
    "subFundId": "<string>"
}
headers = {
    "x-client-id": "<api-key>",
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-client-id': '<api-key>',
    'x-api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amountInCents: 5000,
    email: 'jane@example.com',
    paymentMethod: {
      paymentMethodType: 'Card',
      defaultForDonor: true,
      encryptedCardNumber: '<string>',
      encryptedExpiryMonth: '<string>',
      encryptedExpiryYear: '<string>',
      encryptedSecurityCode: '<string>'
    },
    processingChannel: 'Ecommerce',
    anonymous: false,
    billingAddress: {
      city: '<string>',
      country: '<string>',
      line1: '<string>',
      line2: '<string>',
      state: '<string>',
      zip: '<string>'
    },
    browserInfo: {
      acceptHeader: '<string>',
      colorDepth: 123,
      javaEnabled: true,
      language: '<string>',
      screenHeight: 123,
      screenWidth: 123,
      timeZoneOffset: 123,
      userAgent: '<string>'
    },
    dedication: {recipientEmail: '<string>', recipientName: '<string>'},
    deductible: true,
    firstName: 'Jane',
    fundId: 'fund_abc123',
    lastName: 'Donor',
    locationId: '<string>',
    metadata: {},
    notes: '<string>',
    phone: '+15555550100',
    riskData: {clientData: '<string>'},
    subFundId: '<string>'
  })
};

fetch('https://server.stage.overflow.co/api/v3/payments/authorize', 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://server.stage.overflow.co/api/v3/payments/authorize",
  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([
    'amountInCents' => 5000,
    'email' => 'jane@example.com',
    'paymentMethod' => [
        'paymentMethodType' => 'Card',
        'defaultForDonor' => true,
        'encryptedCardNumber' => '<string>',
        'encryptedExpiryMonth' => '<string>',
        'encryptedExpiryYear' => '<string>',
        'encryptedSecurityCode' => '<string>'
    ],
    'processingChannel' => 'Ecommerce',
    'anonymous' => false,
    'billingAddress' => [
        'city' => '<string>',
        'country' => '<string>',
        'line1' => '<string>',
        'line2' => '<string>',
        'state' => '<string>',
        'zip' => '<string>'
    ],
    'browserInfo' => [
        'acceptHeader' => '<string>',
        'colorDepth' => 123,
        'javaEnabled' => true,
        'language' => '<string>',
        'screenHeight' => 123,
        'screenWidth' => 123,
        'timeZoneOffset' => 123,
        'userAgent' => '<string>'
    ],
    'dedication' => [
        'recipientEmail' => '<string>',
        'recipientName' => '<string>'
    ],
    'deductible' => true,
    'firstName' => 'Jane',
    'fundId' => 'fund_abc123',
    'lastName' => 'Donor',
    'locationId' => '<string>',
    'metadata' => [
        
    ],
    'notes' => '<string>',
    'phone' => '+15555550100',
    'riskData' => [
        'clientData' => '<string>'
    ],
    'subFundId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>",
    "x-client-id: <api-key>"
  ],
]);

$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://server.stage.overflow.co/api/v3/payments/authorize"

	payload := strings.NewReader("{\n  \"amountInCents\": 5000,\n  \"email\": \"jane@example.com\",\n  \"paymentMethod\": {\n    \"paymentMethodType\": \"Card\",\n    \"defaultForDonor\": true,\n    \"encryptedCardNumber\": \"<string>\",\n    \"encryptedExpiryMonth\": \"<string>\",\n    \"encryptedExpiryYear\": \"<string>\",\n    \"encryptedSecurityCode\": \"<string>\"\n  },\n  \"processingChannel\": \"Ecommerce\",\n  \"anonymous\": false,\n  \"billingAddress\": {\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip\": \"<string>\"\n  },\n  \"browserInfo\": {\n    \"acceptHeader\": \"<string>\",\n    \"colorDepth\": 123,\n    \"javaEnabled\": true,\n    \"language\": \"<string>\",\n    \"screenHeight\": 123,\n    \"screenWidth\": 123,\n    \"timeZoneOffset\": 123,\n    \"userAgent\": \"<string>\"\n  },\n  \"dedication\": {\n    \"recipientEmail\": \"<string>\",\n    \"recipientName\": \"<string>\"\n  },\n  \"deductible\": true,\n  \"firstName\": \"Jane\",\n  \"fundId\": \"fund_abc123\",\n  \"lastName\": \"Donor\",\n  \"locationId\": \"<string>\",\n  \"metadata\": {},\n  \"notes\": \"<string>\",\n  \"phone\": \"+15555550100\",\n  \"riskData\": {\n    \"clientData\": \"<string>\"\n  },\n  \"subFundId\": \"<string>\"\n}")

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

	req.Header.Add("x-client-id", "<api-key>")
	req.Header.Add("x-api-key", "<api-key>")
	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://server.stage.overflow.co/api/v3/payments/authorize")
  .header("x-client-id", "<api-key>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amountInCents\": 5000,\n  \"email\": \"jane@example.com\",\n  \"paymentMethod\": {\n    \"paymentMethodType\": \"Card\",\n    \"defaultForDonor\": true,\n    \"encryptedCardNumber\": \"<string>\",\n    \"encryptedExpiryMonth\": \"<string>\",\n    \"encryptedExpiryYear\": \"<string>\",\n    \"encryptedSecurityCode\": \"<string>\"\n  },\n  \"processingChannel\": \"Ecommerce\",\n  \"anonymous\": false,\n  \"billingAddress\": {\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip\": \"<string>\"\n  },\n  \"browserInfo\": {\n    \"acceptHeader\": \"<string>\",\n    \"colorDepth\": 123,\n    \"javaEnabled\": true,\n    \"language\": \"<string>\",\n    \"screenHeight\": 123,\n    \"screenWidth\": 123,\n    \"timeZoneOffset\": 123,\n    \"userAgent\": \"<string>\"\n  },\n  \"dedication\": {\n    \"recipientEmail\": \"<string>\",\n    \"recipientName\": \"<string>\"\n  },\n  \"deductible\": true,\n  \"firstName\": \"Jane\",\n  \"fundId\": \"fund_abc123\",\n  \"lastName\": \"Donor\",\n  \"locationId\": \"<string>\",\n  \"metadata\": {},\n  \"notes\": \"<string>\",\n  \"phone\": \"+15555550100\",\n  \"riskData\": {\n    \"clientData\": \"<string>\"\n  },\n  \"subFundId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://server.stage.overflow.co/api/v3/payments/authorize")

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

request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<api-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amountInCents\": 5000,\n  \"email\": \"jane@example.com\",\n  \"paymentMethod\": {\n    \"paymentMethodType\": \"Card\",\n    \"defaultForDonor\": true,\n    \"encryptedCardNumber\": \"<string>\",\n    \"encryptedExpiryMonth\": \"<string>\",\n    \"encryptedExpiryYear\": \"<string>\",\n    \"encryptedSecurityCode\": \"<string>\"\n  },\n  \"processingChannel\": \"Ecommerce\",\n  \"anonymous\": false,\n  \"billingAddress\": {\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"state\": \"<string>\",\n    \"zip\": \"<string>\"\n  },\n  \"browserInfo\": {\n    \"acceptHeader\": \"<string>\",\n    \"colorDepth\": 123,\n    \"javaEnabled\": true,\n    \"language\": \"<string>\",\n    \"screenHeight\": 123,\n    \"screenWidth\": 123,\n    \"timeZoneOffset\": 123,\n    \"userAgent\": \"<string>\"\n  },\n  \"dedication\": {\n    \"recipientEmail\": \"<string>\",\n    \"recipientName\": \"<string>\"\n  },\n  \"deductible\": true,\n  \"firstName\": \"Jane\",\n  \"fundId\": \"fund_abc123\",\n  \"lastName\": \"Donor\",\n  \"locationId\": \"<string>\",\n  \"metadata\": {},\n  \"notes\": \"<string>\",\n  \"phone\": \"+15555550100\",\n  \"riskData\": {\n    \"clientData\": \"<string>\"\n  },\n  \"subFundId\": \"<string>\"\n}"

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

{
  "donorId": "6710f34fd5061afeec3eab57",
  "contributionId": "7710f34fd5061afeec3eab59",
  "paymentMethodId": "5710f34fd5061afeec3eab58",
  "paymentMethod": {
    "brand": "visa",
    "last4": "1111",
    "expiration": {
      "month": "<string>",
      "year": "<string>"
    }
  },
  "subscriptionId": "8810f34fd5061afeec3eab60"
}

Authorizations

x-client-id

string

header

required

Client ID for API authentication

x-api-key

string

header

required

API Key for API authentication

Body

application/json

amountInCents

integer

required

Charge amount in cents. Use 0 for tokenize-only flows (e.g. saving a payment method without an immediate charge).

Required range: x >= 0

Example:

5000

string<email>

required

Donor email address.

Example:

"jane@example.com"

paymentMethod

CardPaymentMethod · object

required

Payment method details.

CardPaymentMethod
BankPaymentMethod
PlaidBankPaymentMethod
WalletPaymentMethod
StoredPaymentMethod

Show child attributes

processingChannel

enum<string>

required

Determines shopper interaction type. Maps 1-to-1 to Adyen shopperInteraction.

Available options:

Ecommerce,

MailOrderTelephoneOrder,

ContinuedAuthorization

Example:

"Ecommerce"

anonymous

boolean

Whether the donation should be anonymous.

Example:

false

billingAddress

object

Billing address for the payment.

Show child attributes

browserInfo

object

Browser information collected by the Adyen SDK.

Show child attributes

coveredFees

object

Fee coverage details when the donor opts to cover fees.

Show child attributes

dedication

object

Dedication details for the donation.

Show child attributes

deductible

boolean

Whether the donation is tax-deductible. Defaults to the campaign setting when not provided, or true for nonprofit donations without a campaign. Ignored for tokenize-only ($0) flows since no contribution is created.

Example:

true

firstName

string

Donor's first name.

Example:

"Jane"

fundId

string

Fund to allocate the donation to.

Example:

"fund_abc123"

lastName

string

Donor's last name.

Example:

"Donor"

locationId

string

Location associated with the donation.

metadata

object

Arbitrary key-value metadata.

Show child attributes

notes

string

Donor notes for the donation.

phone

string

Donor phone number.

Example:

"+15555550100"

recurring

object

Recurring schedule options. Omit for one-time charges.

Show child attributes

riskData

object

Risk data collected by the Adyen SDK.

Show child attributes

subFundId

string

Sub-fund to allocate the donation to.

Response

201 - application/json

donorId

string

required

Donor ID. Either the existing donor matched by email/phone, or a newly created one.

Example:

"6710f34fd5061afeec3eab57"

contributionId

string

Contribution ID. Present when a payment was charged (new-method charge or stored-method charge). Use this to correlate with webhook notifications and reference the payment in subsequent API calls.

Example:

"7710f34fd5061afeec3eab59"

paymentMethodId

string

Payment method ID. Present when a new payment method was tokenized (either as the main output of a $0 tokenize-only flow, or as a side-effect of an authorize-and-store flow). Use this ID for future charges against the stored payment method.

Example:

"5710f34fd5061afeec3eab58"

paymentMethod

object

Display details for the tokenized payment method. Present together with paymentMethodId.

Show child attributes

subscriptionId

string

Subscription ID. Present when a recurring schedule was created. Use this to manage the recurring donation in subsequent API calls.

Example:

"8810f34fd5061afeec3eab60"

Last modified on July 14, 2026

Get Location Get Tap Destinations

⌘I

Start Here

Contributions

Deposits

Refunds

Chargebacks

Webhooks

Donors

Subscriptions

Payment Methods

Campaigns

Locations

Payments

Tap

Status

Authorize Payment

Authorizations

Body

Response