Skip to Content
Version 0.0.2 is released 🎉
DocumentationCrowd FundingCampaignsCampaign Payments

Create Campaign Payment

Endpoint

POST /crowdfunding/campaigns/payment

https://api.growforme.com/crowdfunding/campaigns/payment

Authorization

Requires an API key in the X-API-Key header.

Supported Languages

  • English

Request Body

{ "campaign_id": 0, "amount": 0, "payment_method": "string", "user": { "user_type": "string", "first_name": "string", "last_name": "string", "phone": "string", "email": "string", "dob": "string", "gender": "string", "regType": "string", "regNumber": "string" } }

Responses

  • 200 OK: Payment processed successfully.
  • 400 Bad Request: Invalid request data.
  • 403 Forbidden: Invalid API key.

Header Parameters

ParameterTypeRequiredDescription
x-api-keystringYesAPI key for authorization

Get All Campaigns Payments

Endpoint

GET /crowdfunding/campaigns/payments

https://api.growforme.com/crowdfunding/campaigns/payments

Authorization

Requires an API key in the X-API-Key header.

Supported Languages

  • English

Request Parameters

ParameterTypeRequiredDescription
campaign_idstringYesThe ID of the campaign for which payments are retrieved.

Responses

  • 200 OK: Returns a list of payments made.
  • 400 Bad Request: Invalid request data.
  • 403 Forbidden: Invalid API key.

Header Parameters

ParameterTypeRequiredDescription
x-api-keystringYesAPI key for authorization

Example Response

[ { "amount": "string", "currency": "string", "payment_method": "string", "payment_provider": "string" } ]

Get Payments Made by a Funder

Endpoint

GET /crowdfunding/campaigns/funders/{identifier}/payments

https://api.growforme.com/crowdfunding/campaigns/funders/{identifier}/payments

Path Parameters

ParameterTypeRequiredDescription
identifierstringYesUnique identifier of the funder (e.g., user ID)

Authorization

Requires an API key in the X-API-Key header.

Supported Languages

  • English

Responses

  • 200 OK: Returns a list of payments made by a sponsor.
  • 400 Bad Request: Invalid request data.
  • 403 Forbidden: Invalid API key.
  • 404 Not Found: Funder not found.

Header Parameters

ParameterTypeRequiredDescription
x-api-keystringYesAPI key for authorization

Example Response

{ "funder": "string", "payment": [ { "amount": "string", "currency": "string", "payment_method": "string", "payment_provider": "string" } ] }

Content-Type

application/json

Last updated on