Make a Payment

Payment API - Make a Payment - API specification for processing a payment with details operations and response formats.

API Overview:

• API Version: v1

• Endpoint: /api/payment

• Method: POST

• Purpose: Facilitates payment transactions.

Key Parameters for Payment:

• Optional Parameters:

  • CharityId, ProcessorGuid: Identifiers for the charity and processor.

    • Search for your Charity here: Search for a Charity for your Donation

    • ProcessorGuid will be provided by FrontStream.

  • Card details: Credit card number, type, expiration date, CVV, and name on card (optional).

  • Billing and Shipping details: Address, email, city, state, zip, etc.

  • Transaction and Fee Details: Includes transaction amounts, tip, commission rate overrides, and fees.

• Required Parameters:

  • Email, IpAddress, NameOnCard, Transactions (mandatory for each payment).

Response Details:

• A successful transaction will return information including:

  • Successful: A boolean indicating if the payment was successful.

  • Message: General response message.

  • TransactionId: Unique identifier for the transaction.

  • PaymentGuid: Unique payment GUID.

  • Transaction Status: Indicates if the payment is successful, pending, or failed.

  • Fees: Transaction-related fee details.

Schemas:

• The API uses several schemas to define the request and response structures, such as:

  • PaymentRequest: Defines the required fields for initiating a payment.

  • PaymentResponse: Defines the expected response structure, including success flags, messages, transaction IDs, and fees.

  • FeeResponse: Details the various fees, including card processing and commission rates.

  • BrokenRule: Used for error handling, containing error codes and messages.

Transaction Breakdown:

• Multiple transaction items can be submitted in a single payment request, each with its own fee, amount, and type (e.g., donation fee, peer-to-peer fee, ticket fee).

Payment Method Types:

• Supported payment methods include credit cards (AMEX, Visa, Mastercard, etc.), Google Pay, Apple Pay, ACH, and Stripe.

Error Handling:

• 400 (Bad Request): If payment creation fails, an array of errors is returned detailing why the request failed.

This API is designed to handle complex payments with options for fee coverage, transaction splitting, and integration with external systems (e.g., ticketing or donation platforms).

Payment Example

See how to make a Payment here:

Payment