RaiseNow EPayment API (1.0.0)

Download OpenAPI specification:Download

RaiseNow: support@raisenow.com URL: https://support.raisenow.com

Auto generated EPMS API via epms-api-deployer

OAuth2

Token

Endpoint for the OAuth 2 client-credentials grant flow. For more information about OAuth 2 please visit:

oauth.net

Request Body schema: application/json
required

Customer to add

grant_type required	string Grant type
client_id required	string Client Id
client_secret required	string Client secret

Responses

Request samples

Payload

Content type

application/json

{"grant_type": "client_credentials",
"client_id": "41c066ea-53e2-4a27-aa84-a2035cd34065",
"client_secret": "*******"
}

Response samples

200
400
401

Content type

application/json

{"token_type": "Bearer",
"expires_in": 3600,
"access_token": "eyJ...Rl6w"
}

Organisations

List Organisations

Lists all Organisations. Limited to 500 records. Use /search/organisations whenever possible.

Responses

Response samples

200
401
403

Content type

application/json

[{"uuid": "d4aabab9-3765-4726-bca3-0da1d88bdeaa",
"name": "Futurogoal",
"created": "1454186729",
"approval_status": "approved",
"active": true
},
{"uuid": "d4aabab9-3725-4726-bca3-0da1d88bdeaa",
"name": "Sample Organisation",
"created": "1454185729",
"approval_status": "approval_pending",
"active": false
}
]

Get Organisation

Retrieve an Organisation

path Parameters

organisation-uuid

required

string

Example: 3c18fb9c-a43d-44fc-8ed2-764168d1d425

The identifier of the Organisation

Responses

Response samples

200
401
403
404

Content type

application/json

{"uuid": "d4aabab9-3765-4726-bca3-0da1d88bdeaa",
"name": "Sample Organisation",
"created": 1454186729,
"active": true,
"approval_status": "approved",
"website_url": "https://raisenow.com",
"merchant_category_code": "8699",
"locale": "de_CH",
"accounts": [{"uuid": "e6f92b16-da43-44de-9b59-4759a52e0b3b"
}
]
}

Organisation Addresses

List Organisation Addresses

Retrieve a list of addresses for the Organisation

path Parameters

organisation-uuid

required

string

Example: 3c18fb9c-a43d-44fc-8ed2-764168d1d425

The identifier of the Organisation

Responses

Response samples

200
401
403
404

Content type

application/json

[{"uuid": "c6f92b16-da43-44de-9b59-4759a52e0b3c",
"created": 1530097351,
"address_line1": "Finance",
"address_line2": "221B Baker St",
"postal_code": "NW1 6XE",
"city": "London",
"country_code": "UK",
"type": "billing"
}
]

Get Organisation Address

Retrieve an Organisation Address

path Parameters

organisation-uuid required	string Example: 3c18fb9c-a43d-44fc-8ed2-764168d1d425 The identifier of the Organisation
address-uuid required	string Example: c6f92b16-da43-44de-9b59-4759a52e0b3c The identifier of the Address

Responses

Response samples

200
401
403
404

Content type

application/json

{"uuid": "c6f92b16-da43-44de-9b59-4759a52e0b3c",
"created": 1530097351,
"address_line1": "Finance",
"address_line2": "221B Baker St",
"postal_code": "NW1 6XE",
"city": "London",
"country_code": "UK",
"type": "billing"
}

Organisation Metadata

Get Organisation Metadata

Retrieve Metadata about an Organisation.

path Parameters

organisation-uuid

required

string

Example: 3c18fb9c-a43d-44fc-8ed2-764168d1d425

The identifier of the Organisation

Responses

Response samples

200
401
403
404

Content type

application/json

{"metadata_name_1": "some value",
"something": "some other value"
}

Accounts

List Accounts

Retrieve a list of Accounts.

Responses

Response samples

200
401
403

Content type

application/json

[{"uuid": "e6f92b16-da43-44de-9b59-4759a52e0b3b",
"name": "Some Account",
"created": 1530097351,
"active": false,
"organisation_uuid": "3c18fb9c-a43d-44fc-8ed2-764168d1d425"
},
{"uuid": "e6f92b16-d143-44de-9b59-4759a52e0b3b",
"name": "Another Account",
"created": 1530096351,
"active": true,
"organisation_uuid": "3c18fb9c-a43d-44fc-8ed2-764168d1d425"
}
]

Get Account

Retrieve an Account.

path Parameters

account-uuid

required

string

Example: e6f92b16-da43-44de-9b59-4759a52e0b3b

The identifier of the Account

Responses

Response samples

200
401
403
404

Content type

application/json

{"uuid": "e6f92b16-da43-44de-9b59-4759a52e0b3b",
"name": "Some Account",
"created": 1530097351,
"active": true,
"organisation": {"uuid": "d4aabab9-3725-4726-bca3-0da1d88bdeaa",
"name": "Sample Organisation",
"created": "1454185729",
"active": true
}
}

Get Account Billing Data

Retrieve Account billing data.

path Parameters

account-uuid

required

string

Example: e6f92b16-da43-44de-9b59-4759a52e0b3b

The identifier of the Account

Responses

Response samples

200
401
403
404

Content type

application/json

{"organisation_name": "RaiseNow",
"account_name": "Test Account",
"account_holder": "Example",
"iban": "xxxxxxx",
"vat_number": "0000000",
"recipient_emails": ["admin@rn.com"
],
"address": {"address_line1": "7 Long Street",
"address_line2": "Strawberry Fields",
"postal_code": "MK16 7QR",
"city": "Metropolis",
"country_code": "US"
}
}

Account Addresses

List Account Addresses

Returns a list of addresses for the Account

path Parameters

account-uuid

required

string

Example: e6f92b16-da43-44de-9b59-4759a52e0b3b

The identifier of the Account

Responses

Response samples

200
401
403
404

Content type

application/json

[{"uuid": "c6f92b16-da43-44de-9b59-4759a52e0b3c",
"created": 1530097351,
"address_line1": "Finance",
"address_line2": "221B Baker St",
"postal_code": "NW1 6XE",
"city": "London",
"country_code": "UK",
"type": "billing"
}
]

Get Account Address

Retrieve a Account Address

path Parameters

account-uuid required	string Example: e6f92b16-da43-44de-9b59-4759a52e0b3b The identifier of the Account
address-uuid required	string Example: c6f92b16-da43-44de-9b59-4759a52e0b3c The identifier of the Address

Responses

Response samples

200
401
403
404

Content type

application/json

{"uuid": "c6f92b16-da43-44de-9b59-4759a52e0b3c",
"created": 1530097351,
"address_line1": "Finance",
"address_line2": "221B Baker St",
"postal_code": "NW1 6XE",
"city": "London",
"country_code": "UK",
"type": "billing"
}

Account Metadata

Get Account Metadata

Retrieve Metadata about an Account

path Parameters

account-uuid

required

string

Example: e6f92b16-da43-44de-9b59-4759a52e0b3b

The identifier of the Account

Responses

Response samples

200
401
403
404

Content type

application/json

{"metadata_name_1": "some value",
"something": "some other value"
}

Payments

Initialise a payment

Creates a new Payment.

Request Body schema: application/json
required

account_uuid required	string UUID of the merchant's account.
payment_method required	string Payment method to use. If no `profile` is set, the default profile for this method will be used. Either this field or `profile` is mandatory.
profile required	string Payment method profile to use. Either this field or `payment_method` is mandatory. If both are specified, `profile` will be used.
locale	string Locale to use for interaction with the donor.
required	object (Money) Amount of money.
	CardPaymentInformation (object) Information needed for the payment. Its format depends on the payment method.
create_payment_source	boolean If true, the payment instrument will be saved and it will be possible to charge it again in the future. Not supported by all payment methods.
	object (PaymentSubscription)
return_url	string URL where the donor should be redirected after the payment flow is completed, if the browser must leave the merchant's website.
	object (PaymentSupporter)
create_supporter	boolean If true, a Supporter entry will be created in Supporter Store.
custom_parameters	object Free JSON to be attached to the payment.

Responses

Request samples

Payload

Content type

application/json

{"account_uuid": "6a13d61f-97d9-4c73-b688-bba3f0153f6f",
"payment_method": "card",
"profile": "cards_in_switzerland",
"locale": "de_CH",
"amount": {"value": "1000",
"currency": "EUR"
},
"payment_information": {"number": "4111111111111111",
"expiry_month": 6,
"expiry_year": 2020,
"cvv": "094",
"cardholder": "John Doe",
"brand": "visa"
},
"create_payment_source": false,
"subscription": {"recurring_interval": "1 * *",
"timezone": "Europe/Athens",
"planned_effective_from": "2024-05-12",
"planned_end": "2025-04-30",
"plan_uuid": "7fa7d6be-f919-4b07-9be8-6c3b09d46267"
},
"return_url": "https://www.my-charity.org/thank-you",
"supporter": {"uuid": "4f8c58dd-4373-449a-af66-4229700d4fb4",
"salutation": "ms",
"first_name": "John",
"last_name": "Doe",
"street": "Hardturmstr.",
"house_number": "12/a",
"address_addendum": "Building 3",
"postal_code": "8005",
"city": "Zurich",
"country": "CH",
"email": "john@doe.com",
"email_permission": false,
"custom_parameters": {"birth_date": "04-02-1980",
"civil_status": "married"
}
},
"create_supporter": false,
"custom_parameters": {"campaign": "mother's day",
"purpose": "help a mother"
}
}

Get Payment

Retrieves a Payment.

path Parameters

payment-uuid

required

string

Responses

Response samples

401
403
404

Content type

application/json

{"message": "Authentication Required"
}

Cancel payment

Sets a payment as cancelled. Limitations on the payment status, provider and method apply; violations will result in status code 400.

path Parameters

payment-uuid

required

string

Request Body schema: application/json
optional

reason

string

Optional free text describing the reason of the cancellation

Responses

Request samples

Payload

Content type

application/json

{"reason": "The donor asked to cancel all withstanding payments"
}

Response samples

401
403
404

Content type

application/json

{"message": "Authentication Required"
}

Replace Custom Parameters

Replaces all Custom Parameters of a Payment.

path Parameters

payment-uuid

required

string

Request Body schema: application/json
required

object (Custom parameters)

An arbitrary JSON object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

401
403

Content type

application/json

{"message": "Authentication Required"
}

Patch Custom Parameters

Patches and merges existing Custom Parameters.

path Parameters

payment-uuid

required

string

Request Body schema: application/json
required

object (Custom parameters)

An arbitrary JSON object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

401
403

Content type

application/json

{"message": "Authentication Required"
}

Create a Refund

If amount is not specified, it will refund the whole residual amount of the payment (original amount minus previous refunds). The applied amount will be returned in the response.

path Parameters

payment-uuid

required

string

Request Body schema: application/json
required

object (Money)

Amount of money.

value required	string Amount value in the minor units of the currency (usually cents).
currency required	string Currency in ISO-4217 format (three capital letters)

Responses

Request samples

Payload

Content type

application/json

{"amount": {"value": "1000",
"currency": "EUR"
}
}

Response samples

200
401
403
404

Content type

application/json

{"uuid": "41b4843e-712a-4d12-b127-895ef41603ca",
"amount": {"value": "1000",
"currency": "EUR"
},
"status": "succeeded"
}

Search Payments

Search for Payments

Request Body schema: application/json
required

Search Request

query required	object The query object
	object Aggregations definition
	Array of objects (Multi field sort) List of sorting definitions
size	number <= 10000 Default: 10 How many results to return
from	number Default: 0 Offset for the result list
includes	Array of strings List of fields to include in the result list. Refer to search documentation for more info.
excludes	Array of strings List of fields to exclude from the result list. Refer to search documentation for more info.

Responses

Request samples

Payload

Content type

application/json

{"query": {"$match": {"uuid": "d4aabab9-3765-4726-bca3-0da1d88bdeaa"
}
},
"aggs": {"yourAggregationName": {"type": "term",
"field": "uuid",
"field_type": "numeric"
}
},
"sort": [{"field": "created",
"field_type": "number",
"direction": "desc"
}
],
"size": "100",
"from": "100",
"includes": ["uuid",
"created"
],
"excludes": ["uuid",
"created"
]
}

Response samples

200
400
401
403

Content type

application/json

{"summary": {"hits": 533,
"last_sort_values": [1640073792000
]
},
"hits": [{ }
],
"aggregations": {"yourAggregationName": [{"key": 1640073792000,
"doc_count": 1
}
]
}
}

Payment-Sources

Create a Payment Source

Initialised the creation of a payment source. Depending on the payment method, a small payment may be done and automatically refunded.

Request Body schema: application/json
required

account_uuid required	string UUID of the merchant's account.
payment_method required	string Payment method to use. If no `profile` is set, the default profile for this method will be used. Either this field or `profile` is mandatory.
profile required	string Payment method profile to use. Either this field or `payment_method` is mandatory. If both are specified, `profile` will be used.
locale	string Locale to use for interaction with the donor.
required	object (Money) Amount of money.
	CardPaymentInformation (object) Information needed for the payment. Its format depends on the payment method.
create_payment_source	boolean If true, the payment instrument will be saved and it will be possible to charge it again in the future. Not supported by all payment methods.
	object (PaymentSubscription)
return_url	string URL where the donor should be redirected after the payment flow is completed, if the browser must leave the merchant's website.
	object (PaymentSupporter)
create_supporter	boolean If true, a Supporter entry will be created in Supporter Store.
custom_parameters	object Free JSON to be attached to the payment.

Responses

Request samples

Payload

Content type

application/json

{"account_uuid": "6a13d61f-97d9-4c73-b688-bba3f0153f6f",
"payment_method": "card",
"profile": "cards_in_switzerland",
"locale": "de_CH",
"amount": {"value": "1000",
"currency": "EUR"
},
"payment_information": {"number": "4111111111111111",
"expiry_month": 6,
"expiry_year": 2020,
"cvv": "094",
"cardholder": "John Doe",
"brand": "visa"
},
"create_payment_source": false,
"subscription": {"recurring_interval": "1 * *",
"timezone": "Europe/Athens",
"planned_effective_from": "2024-05-12",
"planned_end": "2025-04-30",
"plan_uuid": "7fa7d6be-f919-4b07-9be8-6c3b09d46267"
},
"return_url": "https://www.my-charity.org/thank-you",
"supporter": {"uuid": "4f8c58dd-4373-449a-af66-4229700d4fb4",
"salutation": "ms",
"first_name": "John",
"last_name": "Doe",
"street": "Hardturmstr.",
"house_number": "12/a",
"address_addendum": "Building 3",
"postal_code": "8005",
"city": "Zurich",
"country": "CH",
"email": "john@doe.com",
"email_permission": false,
"custom_parameters": {"birth_date": "04-02-1980",
"civil_status": "married"
}
},
"create_supporter": false,
"custom_parameters": {"campaign": "mother's day",
"purpose": "help a mother"
}
}

Get Payment Source

Retrieves a Payment Source.

path Parameters

payment-source-uuid

required

string

Responses

Response samples

401
403

Content type

application/json

{"message": "Authentication Required"
}

Charge Payment Source

Charges a Payment Source.

path Parameters

payment-source-uuid

required

string

Responses

Response samples

401
403
404

Content type

application/json

{"message": "Authentication Required"
}

Replace Custom Parameters

Replaces all Custom Parameters of a Payment Source.

path Parameters

payment-source-uuid

required

string

Request Body schema: application/json
required

object (Custom parameters)

An arbitrary JSON object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

401
403

Content type

application/json

{"message": "Authentication Required"
}

Patch Custom Parameters

Patches and merges existing Custom Parameters.

path Parameters

payment-source-uuid

required

string

Request Body schema: application/json
required

object (Custom parameters)

An arbitrary JSON object

Responses

Request samples

Payload

Content type

application/json

{ }

Supporters

List Supporters

Returns a list of Supporters.

query Parameters

from	number Default: 0 Example: from=10 Starting point for pagination.
size	number Default: 100 Example: size=100 Items per page
organisation_uuid	string Default: null Example: organisation_uuid=3c18fb9c-a43d-44fc-8ed2-764168d1d425 Filter results by Organisation UUID
sort_by	string Default: null Example: sort_by=created Sort by a certain field
sort_order	string Default: null Enum: "desc" "asc" Sort a certain field using a specific order

Responses

Response samples

200
401
403

Content type

application/json

[{"uuid": "c6f92b16-da43-44de-9b59-4759a52e0b3c",
"organisation_uuid": "d4aabab9-3765-4726-bca3-0da1d88bdeaa",
"created": 1530097351,
"first_name": "Janis",
"last_name": "Rockwell",
"street": "Apartment 7a",
"house_number": "66",
"postal_code": "809345",
"city": "Blackrock",
"country": "usa",
"email": "jane.rockwell@myspace.com",
"custom_parameters": {"shoe-size": "45",
"t-shirt-size": "S"
},
"raisenow_parameters": {"fundraising_automation": {"crm_id": "123123123"
}
}
},
{"uuid": "e5f92b16-da43-44de-9b59-4759a52e0b3c",
"organisation_uuid": "d4aabab9-3765-4726-bca3-0da1d88bdeaa",
"created": 1530097351,
"first_name": "Martin",
"last_name": "Martini",
"city": "Bern",
"country": "usa",
"custom_parameters": { },
"raisenow_parameters": {"fundraising_automation": {"crm_id": "abc123"
}
}
}
]

Create Supporter

Creates a new Supporter.

Request Body schema: application/json
required

Supporter to add

organisation_uuid required	string Uuid of the Organisation the Supporter belongs to.
raw	string Unstructured supporter details
raw_name	string Unstructured supporter name
legal_entity	string Supporter legal entity or company name
honorific_prefix	string Supporter honorific prefix
salutation	string Supporter salutation
first_name	string Supporter first name
middle_name	string Supporter middle name
last_name	string Supporter last name
care_of	string The c/o field
raw_address	string Unstructured address
street	string First line of address
house_number	string Address house number
address_addendum	string additional line for address, e.g. building name and floor
post_office_box	string Post Office Box
postal_code	string Address postal code
city	string Address city
region_level_1	string The broader administrative region, e.g. state, canton, province
region_level_2	string The narrower administrative region.
country	string address country
email	string <email> Email address
phone	string Phone number
birth_day	string The day part of the birth date.
birth_month	string The month part of the birth date.
birth_year	string The year part of the birth date.
locale	string The locale of the supporter.
	object (Custom Parameters) Any additional fields. Only key/value pairs allowed, no nesting.
raisenow_parameters	object (RaiseNow Parameters) Parameters for RaiseNow specific usage.

Responses

Request samples

Payload

Content type

application/json

{"organisation_uuid": "d4aabab9-3765-4726-bca3-0da1d88bdeaa",
"raw": "Mr. John Goodman, 349 Fifth Avenue, New York",
"raw_name": "John M. Goodman",
"legal_entity": "RaiseNow",
"honorific_prefix": "Prof.",
"salutation": "ms",
"first_name": "Jane",
"middle_name": "Jane",
"last_name": "Rockwell",
"care_of": "Martin Martini",
"raw_address": "349 Fifth Avenue, New York",
"street": "349 Fifth Avenue",
"house_number": "7a",
"address_addendum": "Apartment 32b",
"post_office_box": "PO. Box 9999",
"postal_code": "CH-8048",
"city": "New York",
"region_level_1": "California",
"region_level_2": "Santa Clara County",
"country": "US",
"email": "jane.rockwell@myspace.com",
"phone": "jane.rockwell@myspace.com",
"birth_day": "15",
"birth_month": "12",
"birth_year": "1975",
"locale": "en_US",
"custom_parameters": {"property1": "string",
"property2": "string"
},
"raisenow_parameters": { }
}

Response samples

201
400
401
403
404

Content type

application/json

{"uuid": "c6f92b16-da43-44de-9b59-4759a52e0b3c",
"organisation_uuid": "d4aabab9-3765-4726-bca3-0da1d88bdeaa",
"created": 1530097351,
"first_name": "Janis",
"last_name": "Rockwell",
"street": "Apartment 7a",
"house_number": "66",
"postal_code": "809345",
"city": "Blackrock",
"country": "usa",
"email": "jane.rockwell@myspace.com",
"custom_parameters": {"shoe-size": "45",
"t-shirt-size": "S"
},
"raisenow_parameters": {"fundraising_automation": {"crm_id": "123123123"
}
}
}

Get Supporter

Retrieve a Supporter.

path Parameters

supporter-uuid

required

string

Example: c6f92b16-da43-44de-9b59-4759a52e0b3c

The identifier of the Supporter

Responses

Response samples

200
401
403
404

Content type

application/json

{"uuid": "c6f92b16-da43-44de-9b59-4759a52e0b3c",
"organisation_uuid": "d4aabab9-3765-4726-bca3-0da1d88bdeaa",
"created": 1530097351,
"first_name": "Janis",
"last_name": "Rockwell",
"street": "Apartment 7a",
"house_number": "66",
"postal_code": "809345",
"city": "Blackrock",
"country": "usa",
"email": "jane.rockwell@myspace.com",
"custom_parameters": {"shoe-size": "45",
"t-shirt-size": "S"
},
"raisenow_parameters": {"fundraising_automation": {"crm_id": "123123123"
}
}
}

Update Supporter

Updates a Supporter.

path Parameters

supporter-uuid

required

string

Example: c6f92b16-da43-44de-9b59-4759a52e0b3c

The identifier of the Supporter

Request Body schema: application/json
required

Supporter to add

raw	string Unstructured supporter details
raw_name	string Unstructured supporter name
legal_entity	string Supporter legal entity or company name
honorific_prefix	string Supporter honorific prefix
salutation	string Supporter salutation
first_name	string Supporter first name
middle_name	string Supporter middle name
last_name	string Supporter last name
care_of	string The c/o field
raw_address	string Unstructured address
street	string First line of address
house_number	string Address house number
address_addendum	string additional line for address, e.g. building name and floor
post_office_box	string Post Office Box
postal_code	string Address postal code
city	string Address city
region_level_1	string The broader administrative region, e.g. state, canton, province
region_level_2	string The narrower administrative region.
country	string address country
email	string <email> Email address
phone	string Phone number
birth_day	string The day part of the birth date.
birth_month	string The month part of the birth date.
birth_year	string The year part of the birth date.
locale	string The locale of the supporter.
	object (Custom Parameters) Any additional fields. Only key/value pairs allowed, no nesting.
raisenow_parameters	object (RaiseNow Parameters) Parameters for RaiseNow specific usage.

Responses

Request samples

Payload

Content type

application/json

{"raw": "Mr. John Goodman, 349 Fifth Avenue, New York",
"raw_name": "John M. Goodman",
"legal_entity": "RaiseNow",
"honorific_prefix": "Prof.",
"salutation": "ms",
"first_name": "Jane",
"middle_name": "Jane",
"last_name": "Rockwell",
"care_of": "Martin Martini",
"raw_address": "349 Fifth Avenue, New York",
"street": "349 Fifth Avenue",
"house_number": "7a",
"address_addendum": "Apartment 32b",
"post_office_box": "PO. Box 9999",
"postal_code": "CH-8048",
"city": "New York",
"region_level_1": "California",
"region_level_2": "Santa Clara County",
"country": "US",
"email": "jane.rockwell@myspace.com",
"phone": "jane.rockwell@myspace.com",
"birth_day": "15",
"birth_month": "12",
"birth_year": "1975",
"locale": "en_US",
"custom_parameters": {"property1": "string",
"property2": "string"
},
"raisenow_parameters": { }
}

Response samples

400
401
403
404

Content type

application/json

{"request_id": "5ca31551a0695",
"error": {"http_code": 400,
"message": [{"code": "error.validation.not_valid",
"property": "email",
"message": "email is not valid"
}
],
"code": "bad_request"
}
}

Subscription Plans

List Subscription Plans

Returns a list of Subscription Plans.

The returned list will always include the 'RaiseNow global default plan'. Which is the fallback for all Organisations without a default Subscription Plan configured.

Responses

Response samples

200
401
403

Content type

application/json

[{"uuid": "eff8fbeb-c237-42a5-930e-d17cccb56f0a",
"organisation_uuid": "c27197be-ae0c-435b-9ba5-7c0941477ed0",
"name": "raisenow global default plan",
"is_default": false
},
{"uuid": "5d9f242b-c631-44b7-b9e2-cbaf17b60000",
"organisation_uuid": "b7ae4b36-b9cb-4b85-8d21-8bcc962ca6c6",
"account_uuid": "b7ae4b36-b9cb-4b85-8d21-8bcc962ca6c5",
"name": "myplan",
"is_default": true
},
{"uuid": "5d9f242b-c631-44b7-b9e2-cbaf17b60001",
"organisation_uuid": "b7ae4b36-b9cb-4b85-8d21-8bcc962ca6c6",
"account_uuid": "b7ae4b36-b9cb-4b85-8d21-8bcc962ca6c1",
"name": "myplan2",
"is_default": false
}
]

Create Subscription Plan

Creates a new Subscription Plan.

Request Body schema: application/json
required

Subscription Plan to add

organisation_uuid required	string Uuid of the Organisation the Subscription Plan belongs to
account_uuid	string Uuid of the Account the Subscription Plan belongs to
name required	string A name for the Subscription Plan
is_default	boolean True if the Subscription Plan should be the default.
dunning_configuration	object Dunning configuration for the Subscription Plan.
notification_configuration	object Notification configuration for the Subscription Plan.

Responses

Request samples

Payload

Content type

application/json

{"organisation_uuid": "e6f92b16-d143-44de-9b59-4759a52e0b3a",
"account_uuid": "e6f92b16-d143-44de-9b59-4759a52e0b3b",
"name": "My Plan",
"is_default": true,
"dunning_configuration": { },
"notification_configuration": { }
}

Response samples

Content type

application/json

{"organisation_uuid": "e6f92b16-d143-44de-9b59-4759a52e0b3a",
"account_uuid": "e6f92b16-d143-44de-9b59-4759a52e0b3b",
"name": "My Plan",
"is_default": true,
"dunning_configuration": { },
"notification_configuration": { }
}

Get Subscription Plan

Retrieve a single Subscription Plan.

path Parameters

subscription-plan-uuid

required

string

Example: c6f92b16-da43-44de-9b59-4759a52e0b34

The identifier of the Subscription Plan

Responses

Response samples

200
401
403
404

Content type

application/json

{"organisation_uuid": "e6f92b16-d143-44de-9b59-4759a52e0b3a",
"account_uuid": "e6f92b16-d143-44de-9b59-4759a52e0b3b",
"name": "My Plan",
"is_default": true,
"dunning_configuration": { },
"notification_configuration": { }
}

Update Subscription Plan

Update a Subscription Plan.

path Parameters

subscription-plan-uuid

required

string

Example: c6f92b16-da43-44de-9b59-4759a52e0b34

The identifier of the Subscription Plan

Request Body schema: application/json
required

Subscription Plan to update

account_uuid	string Uuid of the Account the Subscription Plan belongs to
name	string A name for the Subscription Plan
is_default	boolean Default: false True if the Subscription Plan should be the default.
dunning_configuration	object Dunning configuration for the Subscription Plan.
notification_configuration	object Notification configuration for the Subscription Plan.

Responses

Request samples

Payload

Content type

application/json

{"account_uuid": "e6f92b16-d143-44de-9b59-4759a52e0b3b",
"name": "My Plan",
"is_default": true,
"dunning_configuration": { },
"notification_configuration": { }
}

Response samples

400
401
403
404
409

Content type

application/json

{"request_id": "5ca31551a0695",
"http_code": 400,
"code": "bad_request",
"errors": [{"code": "error.validation.not_blank",
"property": "name",
"message": "Should not be blank"
}
]
}

Subscriptions

Create Subscription

Creates a new Subscription.

Request Body schema: application/json
required

Subscription to add

account_uuid required	string Uuid of the Account the Subscription belongs to
payment_source_uuid required	string Uuid of the PaymentSource to be charged by that Subscription
test_mode	boolean Whether it is a test subscription or not, set to false by default and has to match test_mode of payment source
supporter_uuid required	string Uuid of the Supporter the subscription belongs to
subscription_plan_uuid	string Uuid of the Subscription Plan to be used. If not set the default Subscription Plan will be used.
currency required	string Currency of the subscription
amount required	integer The amount that will be charged
timezone	string Default: "UTC" Timezone of the subscription. Used to calculate the charge dates. Supported timezones: https://www.php.net/manual/en/timezones.php. If an invalid timezone is given we fall back to UTC.
recurring_interval required	string Charge interval definition Last 3 parts (day, month and year) of a cron expression. Alternatively one of weekly, monthly, quarterly, semestral or yearly.
status	string Default: "pending" Enum: "active" "pending" Initial status of a created Subscription
planned_effective_from	string Date of when the subscription should become active (In YYYY-MM-DD format)
planned_end	string Date of when the subscription should end (In YYYY-MM-DD format)
	object (Custom Parameters) List of key/value pairs. (Only string values)
	object (RaiseNow Parameters) Data for RaiseNow internal use.

Responses

Request samples

Payload

Content type

application/json

{"account_uuid": "e6f92b16-d143-44de-9b59-4759a52e0b3b",
"payment_source_uuid": "507e016b-d6ae-48d0-ab75-45c0169d91a5",
"test_mode": true,
"supporter_uuid": "c6f92b16-da43-44de-9b59-4759a52e0b3c",
"subscription_plan_uuid": "c6f92b16-da43-44de-9b59-4759a52e0b22",
"currency": "USD",
"amount": 1500,
"timezone": "Europe/Zurich",
"recurring_interval": "15 3,6,9,12 *",
"status": "active",
"planned_effective_from": "2021-12-01",
"planned_end": "2025-12-01",
"custom_parameters": {"something": "some value",
"something_else": "some other value"
},
"raisenow_parameters": {"property1": { },
"property2": { }
}
}

Response samples

201
400
401
403
404

Content type

application/json

{"uuid": "994b2075-6fda-42f6-b12b-c9c7b97b3c19",
"organisation_uuid": "3c18fb9c-a43d-44fc-8ed2-764168d1d425",
"account_uuid": "e6f92b16-d143-44de-9b59-4759a52e0b3b",
"supporter_uuid": "c6f92b16-da43-44de-9b59-4759a52e0b3c",
"subscription_plan": {"uuid": "507e016b-d6ae-48d0-ab75-45c0169d9122",
"name": "My Subscription Plan"
},
"payment_source_uuid": "507e016b-d6ae-48d0-ab75-45c0169d91a5",
"payment_provider": "stripe",
"payment_method": "card",
"created": 1454186729,
"currency": "USD",
"amount": 1500,
"timezone": "Europe/Zurich",
"charged_by": "raisenow",
"next_due_date": 1454186729,
"subscription_status": "active",
"recurring_interval": "1 0 L 3,6,9,12 *",
"planned_effective_from": 1454186729,
"planned_since": 1454186729,
"planned_end": 1454186729,
"ended_at": 1454186729,
"suspension_start": 1454186729,
"suspension_end": 1454186729,
"consecutive_failed_invoices": 0,
"test_mode": true,
"custom_parameters": {"something": "some value",
"something_else": "some other value"
},
"raisenow_parameters": {"property1": { },
"property2": { }
}
}

Get Subscription

Retrieve a Subscription.

path Parameters

subscription-uuid

required

string

Example: 994b2075-6fda-42f6-b12b-c9c7b97b3c99

The identifier of the Subscription

Responses

Response samples

200
401
403
404

Content type

application/json

{"uuid": "994b2075-6fda-42f6-b12b-c9c7b97b3c19",
"organisation_uuid": "3c18fb9c-a43d-44fc-8ed2-764168d1d425",
"account_uuid": "e6f92b16-d143-44de-9b59-4759a52e0b3b",
"supporter_uuid": "c6f92b16-da43-44de-9b59-4759a52e0b3c",
"subscription_plan": {"uuid": "507e016b-d6ae-48d0-ab75-45c0169d9122",
"name": "My Subscription Plan"
},
"payment_source_uuid": "507e016b-d6ae-48d0-ab75-45c0169d91a5",
"payment_provider": "stripe",
"payment_method": "card",
"created": 1454186729,
"currency": "USD",
"amount": 1500,
"timezone": "Europe/Zurich",
"charged_by": "raisenow",
"next_due_date": 1454186729,
"subscription_status": "active",
"recurring_interval": "1 0 L 3,6,9,12 *",
"planned_effective_from": 1454186729,
"planned_since": 1454186729,
"planned_end": 1454186729,
"ended_at": 1454186729,
"suspension_start": 1454186729,
"suspension_end": 1454186729,
"consecutive_failed_invoices": 0,
"test_mode": true,
"custom_parameters": {"something": "some value",
"something_else": "some other value"
},
"raisenow_parameters": {"property1": { },
"property2": { }
}
}

Update Subscription

Update a Subscription.

path Parameters

subscription-uuid

required

string

Example: 994b2075-6fda-42f6-b12b-c9c7b97b3c99

The identifier of the Subscription

Request Body schema: application/json
required

Subscription to update

supporter_uuid	string Uuid of the Supporter the subscription belongs to. Can only be updated if previously not set.
subscription_plan_uuid	string Uuid of the Subscription Plan to be used. If not set the default Subscription Plan will be used.
payment_source_uuid	string Uuid of the PaymentSource to be used
amount	integer The amount that will be charged
timezone	string Default: "UTC" Timezone of the subscription. Used to calculate the charge dates. Supported timezones: https://www.php.net/manual/en/timezones.php. If an invalid timezone is given we fall back to UTC.
recurring_interval	string Charge interval definition Last 3 parts of cron definition or one of weekly, monthly, quarterly, semestral or yearly
planned_effective_from	string Date of when the subscription should become active (In YYYY-MM-DD format)
planned_end	string Date of when the subscription should end (In YYYY-MM-DD format)
	object (Custom Parameters) List of key/value pairs. (Only string values)
	object (RaiseNow Parameters) Data for RaiseNow internal use.

Responses

Request samples

Payload

Content type

application/json

{"supporter_uuid": "c6f92b16-da43-44de-9b59-4759a52e0b3c",
"subscription_plan_uuid": "c6f92b16-da43-44de-9b59-4759a52e0b22",
"payment_source_uuid": "c6f92b34-da43-44ae-9b59-4759a52e0b12",
"amount": 1500,
"timezone": "Europe/Zurich",
"recurring_interval": "L 3,6,9,12 *",
"planned_effective_from": "2021-12-01",
"planned_end": "2025-12-01",
"custom_parameters": {"something": "some value",
"something_else": "some other value"
},
"raisenow_parameters": {"property1": { },
"property2": { }
}
}

Response samples

400
401
403
404
409

Content type

application/json

{"request_id": "5ca31551a0695",
"error": {"http_code": 400,
"message": [{"code": "error.validation.not_blank",
"property": "name",
"message": "Should not be blank"
}
],
"code": "bad_request"
}
}

Activate Subscription

Activates a Subscription.

After activation a Subscription will create Invoices and Charge Attempts according to it's interval definition.

path Parameters

subscription-uuid

required

string

Example: 994b2075-6fda-42f6-b12b-c9c7b97b3c99

The identifier of the Subscription

Responses

Response samples

401
403
404
409

Content type

application/json

{"message": "Authentication Required"
}

Cancel Subscription

Cancel a Subscription.

A cancelled Subscription will no longer create Invoices or Charge Attempts.

path Parameters

subscription-uuid

required

string

Example: 994b2075-6fda-42f6-b12b-c9c7b97b3c99

The identifier of the Subscription

Responses

Response samples

401
403
404
409

Content type

application/json

{"message": "Authentication Required"
}

Suspend Subscription

Create or modify a Subscription suspension.

A suspended Subscription will not create Invoices or Charge Attempts.

path Parameters

subscription-uuid

required

string

Example: 994b2075-6fda-42f6-b12b-c9c7b97b3c99

The identifier of the Subscription

Request Body schema: application/json
optional

Subscription Suspension

suspension_start	string Start date of the suspension (YYYY-MM-DD format >= today). It cannot be set when modifying a currently suspended subscription, otherwise it will be suspended immediately if not already suspended.
suspension_end	string End date of the suspension (YYYY-MM-DD format). If not provided, the Subscription will be suspended indefinitely.

Responses

Request samples

Payload

Content type

application/json

{"suspension_start": "2022-01-01",
"suspension_end": "2023-01-01"
}

Response samples

401
403
404
409

Content type

application/json

{"message": "Authentication Required"
}

Invoices

Get Invoices

Retrieve all Invoices of a Subscription.

path Parameters

subscription-uuid

required

string

Example: 994b2075-6fda-42f6-b12b-c9c7b97b3c99

The identifier of the Subscription

Responses

Response samples

200
401
403
404

Content type

application/json

[{"uuid": "5d9f242b-c631-44b7-b9e2-000000000001",
"subscription": {"uuid": "5d9f242b-c631-44b7-b9e2-000000000000"
},
"created": 1623248926,
"status": "open",
"amount": 100,
"refunded_amount": 0,
"currency": "CHF",
"next_attempt_date": 1623249926,
"failed_payment_attempts": 0,
"is_manually_created": false,
"status_reason": "pending"
},
{"uuid": "5d9f242b-c631-44b7-b9e2-100000000001",
"subscription": {"uuid": "5d9f242b-c631-44b7-b9e2-000000000000"
},
"created": 1623248926,
"status": "paid",
"amount": 100,
"refunded_amount": 0,
"currency": "CHF",
"failed_payment_attempts": 0,
"is_manually_created": false,
"status_reason": "paid"
}
]

Create Invoice

Creates a new Invoice for the Subscription.

path Parameters

subscription-uuid

required

string

Example: 994b2075-6fda-42f6-b12b-c9c7b97b3c99

The identifier of the Subscription

Request Body schema: application/json
required

Invoice

amount	number The amount to be collected with this Invoice. If not specified the Subscription amount will be used.
	object (Custom Parameters) List of key/value pairs. (Only string values)
	object (RaiseNow Parameters) Data for RaiseNow internal use.

Responses

Request samples

Payload

Content type

application/json

{"amount": 4000,
"custom_parameters": {"something": "some value",
"something_else": "some other value"
},
"raisenow_parameters": {"property1": { },
"property2": { }
}
}

Response samples

201
400
401
403
404

Content type

application/json

{"uuid": "5d9f242b-c631-44b7-b9e2-000000000001",
"created": 1623248926,
"status": "open",
"amount": 100,
"refunded_amount": 0,
"currency": "CHF",
"next_attempt_date": 1643249926,
"failed_payment_attempts": 1,
"is_manually_created": true,
"status_reason": "pending",
"subscription": {"uuid": "5d9f242b-c631-44b7-b9e2-000000000000"
},
"charge_attempts": [{"uuid": "5d9f242b-c631-44b7-b9e2-000000000011",
"status": "pending",
"created": 1623249926
},
{"uuid": "5d9f242b-c631-44b7-b9e2-000000000021",
"status": "failed",
"created": 1623249826
}
],
"raisenow_parameters": {"nested": {"number": 12
}
},
"custom_parameters": {"custom": "foo"
}
}

Get Invoice

Retrieve a Invoice.

path Parameters

invoice-uuid required	string Example: 994b2075-6fda-42f6-b12b-c9c7b97b3a34 The identifier of the Invoice
subscription-uuid required	string Example: 994b2075-6fda-42f6-b12b-c9c7b97b3c99 The identifier of the Subscription

Responses

Response samples

200
401
403
404

Content type

application/json

{"uuid": "5d9f242b-c631-44b7-b9e2-000000000001",
"created": 1623248926,
"status": "open",
"amount": 100,
"refunded_amount": 0,
"currency": "CHF",
"next_attempt_date": 1643249926,
"failed_payment_attempts": 1,
"is_manually_created": true,
"status_reason": "pending",
"subscription": {"uuid": "5d9f242b-c631-44b7-b9e2-000000000000"
},
"charge_attempts": [{"uuid": "5d9f242b-c631-44b7-b9e2-000000000011",
"status": "pending",
"created": 1623249926
},
{"uuid": "5d9f242b-c631-44b7-b9e2-000000000021",
"status": "failed",
"created": 1623249826
}
],
"raisenow_parameters": {"nested": {"number": 12
}
},
"custom_parameters": {"custom": "foo"
}
}

Close an Invoice Manually

Closes a Subscription Invoice Manually.

It sets the invoice status to Paid or Cancelled so that it does not get charged and stop the dunning process.

path Parameters

invoice-uuid required	string Example: 994b2075-6fda-42f6-b12b-c9c7b97b3a34 The identifier of the Invoice
subscription-uuid required	string Example: 994b2075-6fda-42f6-b12b-c9c7b97b3c99 The identifier of the Subscription

Request Body schema: application/json
required

Invoice closing status

status

string

Enum: "paid" "cancelled"

Invoice closing status

Responses

Request samples

Payload

Content type

application/json

{"status": "paid"
}

Response samples

400
401
403
404

Content type

application/json

{"request_id": "5ca31551a0695",
"error": {"http_code": 400,
"message": [{"code": "the_value_you_selected_is_not_a_valid_choice",
"property": "status",
"message": "The value you selected is not a valid choice."
}
],
"code": "bad_request"
}
}

Charge Attempts

Create Charge Attempt

Creates a new Charge Attempt for the Invoice.

To prevent duplicate charges, new ChargeAttempts can only be created for Invoices that are not yet in status 'paid' and have no pending ChargeAttempt.

path Parameters

invoice-uuid required	string Example: 994b2075-6fda-42f6-b12b-c9c7b97b3a34 The identifier of the Invoice
subscription-uuid required	string Example: 994b2075-6fda-42f6-b12b-c9c7b97b3c99 The identifier of the Subscription

Request Body schema: application/json
optional

string (Empty Schema)

Empty Response

Responses

Request samples

Payload

Content type

application/json

""

Response samples

201
401
403
404
409

Content type

application/json

{"uuid": "5d9f242b-c631-44b7-b9e2-a9c7b97b3a32",
"created": 1623248926,
"status": "pending",
"payment_uuid": "5d9f242b-c631-44b7-b9e2-d9c7b97b3d43",
"invoice": {"uuid": "5d9f242b-c631-44b7-b9e2-000000000001",
"created": 1623248926,
"status": "open",
"amount": 100,
"refunded_amount": 0,
"currency": "CHF",
"next_attempt_date": 1623249926,
"failed_payment_attempts": 0,
"is_manually_created": false,
"status_reason": "pending"
},
"subscription": {"uuid": "994b2075-6fda-42f6-b12b-c9c7b97b3c19",
"organisation_uuid": "3c18fb9c-a43d-44fc-8ed2-764168d1d425",
"account_uuid": "e6f92b16-d143-44de-9b59-4759a52e0b3b",
"supporter_uuid": "c6f92b16-da43-44de-9b59-4759a52e0b3c",
"subscription_plan": {"uuid": "507e016b-d6ae-48d0-ab75-45c0169d9122",
"name": "My Subscription Plan"
},
"payment_source_uuid": "507e016b-d6ae-48d0-ab75-45c0169d91a5",
"payment_provider": "stripe",
"payment_method": "card",
"created": 1454186729,
"currency": "USD",
"amount": 1500,
"timezone": "Europe/Zurich",
"charged_by": "raisenow",
"test_mode": true,
"next_due_date": 1454186729,
"subscription_status": "active",
"recurring_interval": "1 0 L 3,6,9,12 *",
"planned_effective_from": 1454186729,
"planned_since": 1454186729,
"planned_end": 1454186729,
"ended_at": 1454186729,
"suspension_start": 1454186729,
"suspension_end": 1454186729,
"consecutive_failed_invoices": 0
}
}

Webhook Endpoints

List Webhook Endpoints

Returns a list of Webhook-Endpoints.

query Parameters

organisation_uuid required	string
account_uuid	string

Responses

Response samples

200
401
403

Content type

application/json

[{"uuid": "e6f92b16-da43-44de-9b59-4759a52a0b3b",
"organisation_uuid": "d4aabab9-3765-4726-bca3-0da1d88bdeaa",
"account_uuid": "e6f92b16-da43-44de-9b59-4759a52e0b3b",
"alias": "My endpoint",
"endpoint": "https://webhook.site/a71b3dfe-a640-4de0-be03-b3303342dc6a"
},
{"uuid": "e6e92b24-da43-44de-9b59-4759a52a0b2a",
"organisation_uuid": "d4aabab9-3765-4726-bca3-0da1d88bdeaa",
"account_uuid": "e6f92b16-da43-44de-9b59-4759a52e0b3b",
"alias": "My other endpoint",
"endpoint": "https://webhook.mydomain/events"
}
]

Create Webhook Endpoint

Creates a new Webhook-Endpoint.

Request Body schema: application/json
required

Webhook to add

organisation_uuid	string Uuid of the Organisation the Webhook Endpoint should belong to.
account_uuid	string Uuid of the Account the Webhook Endpoint should belong to.
alias	string Name for the Webhook Endpoint
endpoint required	string Url for the Webhook Endpoint. Must start with https://
username	string Username for the Webhook Endpoint
password	string Password for the Webhook Endpoint
hmac_key	string HMAC key for the signature.

Responses

Request samples

Payload

Content type

application/json

{"organisation_uuid": "3c18fb9c-a43d-44fc-8ed2-764168d1d425",
"account_uuid": "e6f92b16-da43-44de-9b59-4759a52e0b3b",
"alias": "My Endpoint",
"endpoint": "https://webhook.com/raisenow",
"username": "raisenow",
"password": "myPassw0rd",
"hmac_key": "someSecretString"
}

Response samples

201
400
401
403
404

Content type

application/json

{"uuid": "e6f92b16-da43-44de-9b59-4759a52a0b3b",
"organisation_uuid": "d4aabab9-3765-4726-bca3-0da1d88bdeaa",
"account_uuid": "e6f92b16-da43-44de-9b59-4759a52e0b3b",
"alias": "My endpoint",
"endpoint": "https://webhook.site/a71b3dfe-a640-4de0-be03-b3303342dc6a"
}

Get Webhook Endpoint

Returns Webhook-Endpoint.

path Parameters

webhook-uuid

required

string

Responses

Response samples

200
401
403
404

Content type

application/json

{"uuid": "e6f92b16-da43-44de-9b59-4759a52a0b3b",
"organisation_uuid": "d4aabab9-3765-4726-bca3-0da1d88bdeaa",
"account_uuid": "e6f92b16-da43-44de-9b59-4759a52e0b3b",
"alias": "My endpoint",
"endpoint": "https://webhook.site/a71b3dfe-a640-4de0-be03-b3303342dc6a",
"username": "raisenow",
"hmac_key": "123hmhcsadma"
}

Replace Webhook Endpoint

Replaces Webhook-Endpoint.

path Parameters

webhook-uuid

required

string

Request Body schema: application/json
required

Webhook-Endpoint to update

organisation_uuid	string Uuid of the Organisation the Webhook Endpoint should belong to.
account_uuid	string Uuid of the Account the Webhook Endpoint should belong to.
alias	string Name for the Webhook Endpoint
endpoint required	string Url for the Webhook Endpoint. Must start with https://
username	string Username for the Webhook Endpoint
password	string Password for the Webhook Endpoint
hmac_key	string HMAC key for the signature.

Responses

Request samples

Payload

Content type

application/json

{"organisation_uuid": "3c18fb9c-a43d-44fc-8ed2-764168d1d425",
"account_uuid": "e6f92b16-da43-44de-9b59-4759a52e0b3b",
"alias": "My Endpoint",
"endpoint": "https://webhook.com/raisenow",
"username": "raisenow",
"password": "myPassw0rd",
"hmac_key": "someSecretString"
}

Response samples

400
401
403
404

Content type

application/json

Example

Missing endpoint

{"request_id": "5ca31551a0695",
"http_code": 400,
"code": "bad_request",
"errors": [{"code": "error.validation.not_blank",
"property": "endpoint",
"message": "Should not be blank"
}
]
}

Delete Webhook Endpoint

Updates a Webhook-Endpoint.

path Parameters

webhook-uuid

required

string

Responses

Response samples

401
403
404

Content type

application/json

{"message": "Authentication Required"
}

Update Webhook Endpoint

Updates a Webhook-Endpoint

path Parameters

webhook-uuid

required

string

Request Body schema: application/json
required

Webhook-Endpoint to update

organisation_uuid	string Uuid of the Organisation the Webhook Endpoint should belong to.
account_uuid	string Uuid of the Account the Webhook Endpoint should belong to.
alias	string Name for the Webhook Endpoint
endpoint required	string Url for the Webhook Endpoint. Must start with https://
username	string Username for the Webhook Endpoint
password	string Password for the Webhook Endpoint
hmac_key	string HMAC key for the signature.

Responses

Request samples

Payload

Content type

application/json

{"organisation_uuid": "3c18fb9c-a43d-44fc-8ed2-764168d1d425",
"account_uuid": "e6f92b16-da43-44de-9b59-4759a52e0b3b",
"alias": "My Endpoint",
"endpoint": "https://webhook.com/raisenow",
"username": "raisenow",
"password": "myPassw0rd",
"hmac_key": "someSecretString"
}

Response samples

400
401
403
404

Content type

application/json

Example

Missing endpoint

{"request_id": "5ca31551a0695",
"http_code": 400,
"code": "bad_request",
"errors": [{"code": "error.validation.not_blank",
"property": "endpoint",
"message": "Should not be blank"
}
]
}

Event Subscriptions

List Event Subscriptions

Returns a list of subscribed events.

query Parameters

account_uuid	string
organisation_uuid required	string

Responses

Response samples

200
401
403

Content type

application/json

[{"uuid": "e6f92b16-da43-44de-9b59-4759a52a0b3b",
"organisation_uuid": "3c18fb9c-a43d-44fc-8ed2-764168d1d425",
"account_uuid": "e6f92b16-da43-44de-9b59-4759a52e0b3b",
"action_configuration_uuid": "e6f92b16-da43-44de-9b59-4759a52a0b3b",
"action_type": "webhook",
"event_name": "rnw.event.payment_gateway.payment.succeeded",
"enabled": "true"
}
]

Create Event Subscription

Subscribe to an Event.

Request Body schema: application/json
required

Event Subscription

organisation_uuid	string Uuid of the Organisation.
account_uuid	string Uuid of the Account.
action_configuration_uuid required	string Uuid of the Webhook Endpoint.
action_type required	string Type of action. Only "webhook" is supported.
event_name required	string The name of the event to subscribe to.
filter	string A string defining the logic how to filter the events for this specific event subscription. You can find more info here

Responses

Request samples

Payload

Content type

application/json

{"organisation_uuid": "3c18fb9c-a43d-44fc-8ed2-764168d1d425",
"account_uuid": "e6f92b16-da43-44de-9b59-4759a52e0b3b",
"action_configuration_uuid": "e6f92b16-da43-44de-9b59-4759a52a0b3b",
"action_type": "webhook",
"event_name": "rnw.event.payment_gateway.payment.succeeded",
"filter": "!event.data[\"payment_method\"] === \"card\""
}

Response samples

201
400
401
403
404

Content type

application/json

{"uuid": "e6f92b16-da43-44de-9b59-4759a52a0b3b",
"organisation_uuid": "3c18fb9c-a43d-44fc-8ed2-764168d1d425",
"account_uuid": "e6f92b16-da43-44de-9b59-4759a52e0b3b",
"action_configuration_uuid": "e6f92b16-da43-44de-9b59-4759a52a0b3b",
"action_type": "webhook",
"event_name": "rnw.event.payment_gateway.payment.succeeded",
"enabled": "true"
}

Get Event Subscription

Returns an Event Subscription.

path Parameters

event-subscription-uuid

required

string

Responses

Response samples

200
401
403
404

Content type

application/json

{"uuid": "e6f92b16-da43-44de-9b59-4759a52a0b3b",
"organisation_uuid": "3c18fb9c-a43d-44fc-8ed2-764168d1d425",
"account_uuid": "e6f92b16-da43-44de-9b59-4759a52e0b3b",
"action_configuration_uuid": "e6f92b16-da43-44de-9b59-4759a52a0b3b",
"action_type": "webhook",
"event_name": "rnw.event.payment_gateway.payment.succeeded",
"enabled": "true"
}

Replace Event Subscription

Replaces the Event Subscription.

path Parameters

event-subscription-uuid

required

string

Request Body schema: application/json
required

Event Subscription

organisation_uuid	string Uuid of the Organisation.
account_uuid	string Uuid of the Account.
action_configuration_uuid required	string Uuid of the Webhook Endpoint.
action_type required	string Type of action. Only "webhook" is supported.
event_name required	string The name of the event to subscribe to.
filter	string A string defining the logic how to filter the events for this specific event subscription. You can find more info here

Responses

Request samples

Payload

Content type

application/json

{"organisation_uuid": "3c18fb9c-a43d-44fc-8ed2-764168d1d425",
"account_uuid": "e6f92b16-da43-44de-9b59-4759a52e0b3b",
"action_configuration_uuid": "e6f92b16-da43-44de-9b59-4759a52a0b3b",
"action_type": "webhook",
"event_name": "rnw.event.payment_gateway.payment.succeeded",
"filter": "!event.data[\"payment_method\"] === \"card\""
}

Response samples

400
401
403
404

Content type

application/json

{"request_id": "5ca31551a0695",
"http_code": 400,
"code": "bad_request",
"errors": [{"code": "error.validation.not_blank",
"property": "event_name",
"message": "Should not be blank"
}
]
}

Update Event Subscription

Updates the Event Subscription.

path Parameters

event-subscription-uuid

required

string

Request Body schema: application/json
required

Event Subscription

organisation_uuid	string Uuid of the Organisation.
account_uuid	string Uuid of the Account.
action_configuration_uuid required	string Uuid of the Webhook Endpoint.
action_type required	string Type of action. Only "webhook" is supported.
event_name required	string The name of the event to subscribe to.
filter	string A string defining the logic how to filter the events for this specific event subscription. You can find more info here

Responses

Request samples

Payload

Content type

application/json

{"organisation_uuid": "3c18fb9c-a43d-44fc-8ed2-764168d1d425",
"account_uuid": "e6f92b16-da43-44de-9b59-4759a52e0b3b",
"action_configuration_uuid": "e6f92b16-da43-44de-9b59-4759a52a0b3b",
"action_type": "webhook",
"event_name": "rnw.event.payment_gateway.payment.succeeded",
"filter": "!event.data[\"payment_method\"] === \"card\""
}

Response samples

400
401
403
404

Content type

application/json

{"request_id": "5ca31551a0695",
"http_code": 400,
"code": "bad_request",
"errors": [{"code": "error.validation.not_blank",
"property": "event_name",
"message": "Should not be blank"
}
]
}

Delete Event Subscription

Removes the Event Subscription.

path Parameters

event-subscription-uuid

required

string

Responses

Response samples

401
403
404

Content type

application/json

{"message": "Authentication Required"
}

Activate Event Subscription

Activates the Event Subscription.

path Parameters

event-subscription-uuid

required

string

Responses

Response samples

401
403
404

Content type

application/json

{"message": "Authentication Required"
}

Deactivate Event Subscription

Deactivates the Event Subscription.

path Parameters

event-subscription-uuid

required

string

Responses

Response samples

401
403
404

Content type

application/json

{"message": "Authentication Required"
}

Webhook Responses

List Webhook Responses

Returns a list of Webhook responses

Responses

Response samples

200
401
403

Content type

application/json

[{"uuid": "e6f92b16-da43-44de-9b59-4759a52a0b3b",
"organisation_uuid": "3c18fb9c-a43d-44fc-8ed2-764168d1d425",
"account_uuid": "e6f92b16-da43-44de-9b59-4759a52e0b3b",
"webhook_configuration_uuid": "e6f92b16-da43-44de-9b59-4759a52a0b3b",
"event_uuid": "c6f92b16-da43-44de-9b59-4759a52e0c3c",
"object_uuid": "c6f92abc-da43-44de-9b59-4759a52e0c3c",
"sent_at": 1564045696,
"error": "true",
"status_code": 404,
"reason_phrase": "Not Found"
}
]

Get Webhook Response

Returns a Webhook Response.

path Parameters

webhook-response-uuid

required

string

Responses

Response samples

200
401
403
404

Content type

application/json

{"uuid": "e6f92b16-da43-44de-9b59-4759a52a0b3b",
"organisation_uuid": "3c18fb9c-a43d-44fc-8ed2-764168d1d425",
"account_uuid": "e6f92b16-da43-44de-9b59-4759a52e0b3b",
"webhook_configuration_uuid": "e6f92b16-da43-44de-9b59-4759a52a0b3b",
"event_uuid": "c6f92b16-da43-44de-9b59-4759a52e0c3c",
"object_uuid": "c6f92abc-da43-44de-9b59-4759a52e0c3c",
"sent_at": 1564045696,
"error": "true",
"status_code": 404,
"reason_phrase": "Not Found",
"response_time": 2001,
"error_message": "timeout of 10000ms exceeded",
"do_not_retry": "true",
"request_headers": "{\"Accept\":\"application/json, text/plain, */*\",\"Content-Type\":\"application/json\",\"User-Agent\":\"axios/0.18.1\",\"Content-Length\":2043}",
"request_body": "string",
"response_headers": "{\"Accept\":\"application/json, text/plain, */*\",\"Content-Type\":\"application/json\",\"User-Agent\":\"axios/0.18.1\",\"Content-Length\":2043}",
"response_body": "string"
}

Onboarding

Create partner onboarding process

Request Body schema: application/json
required

external_id	string An external identifier for the organisation of a partner
onboarding_configuration_uuid	string Uuid of the respective partner onboarding configuration
	object
	object

Responses

Request samples

Payload

Content type

application/json

{"external_id": "rand0m-iD-71204-1232",
"onboarding_configuration_uuid": "75838f5c-0c5d-4f7e-b4a7-65356318a5ed",
"user": {"email": "jane@raisenow.com",
"first_name": "jane",
"last_name": "Goodman",
"locale": "en_GB"
},
"organisation": {"name": "Futurogoal",
"merchant_category_code": "8398",
"main_address": {"address_line1": "Finance",
"address_line2": "221B Baker St",
"postal_code": "NW1 6XE",
"city": "London",
"country": "UK"
},
"billing_address": {"address_line1": "Finance",
"address_line2": "221B Baker St",
"postal_code": "NW1 6XE",
"city": "London",
"country": "UK"
},
"billing_information": {"iban": "XXXXXXXXXXXXXXXXXXXXX",
"bank_name": "Small Bank",
"account_holder": "Jon Doe"
},
"additional_information": {"website": "https://www.mysite.org",
"vat_nr": "xxx",
"locale": "de_CH"
}
}
}

Response samples

201
401
403
404

Content type

application/json

{"onboarding_configuration_uuid": "string",
"partner_integration_uuid": "string",
"uuid": "5d9f242b-c631-44b7-b9e2-a9c7b97b3a32",
"label": "pending",
"status": "pending",
"token": "7d1a573ba06244e6bfc70ffc02f014cb",
"url": "https://localhost?token=bff2d9d348920368c8094a2d72d3fbdb",
"expires_at": 1623248926,
"expired": true,
"created": 1623238926,
"external_id": "rand0m-iD-71204-1232",
"initialisation_data": { },
"results": {"organisation": {"uuid": "e5fbbd7b-b2b6-4c29-b913-c6a55ea5fdae"
},
"accounts": {"account_label_1": {"uuid": "65f7fc06-e9ac-4b37-9027-b2a3a94283eb"
},
"account_label_2": {"uuid": "e7c7bbbf-1a20-4d74-b768-446a0ee3a02d"
}
},
"user": {"uuid": "e4e5d876-0152-461b-b7f6-092263e06c75"
}
}
}

Get partner onboarding process by token

path Parameters

token

required

string

Example: 97edb50eb33d94fc583bf0b1d92d5fdc

The generated token of the Onboarding Process

Responses

Response samples

201
404

Content type

application/json

{"uuid": "5d9f242b-c631-44b7-b9e2-a9c7b97b3a32",
"label": "pending",
"status": "pending",
"token": "7d1a573ba06244e6bfc70ffc02f014cb",
"url": "https://localhost?token=bff2d9d348920368c8094a2d72d3fbdb",
"expires_at": 1623248926,
"expired": true,
"created": 1623238926,
"external_id": "rand0m-iD-71204-1232",
"initialisation_data": { },
"results": {"organisation": {"uuid": "e5fbbd7b-b2b6-4c29-b913-c6a55ea5fdae"
},
"accounts": {"account_label_1": {"uuid": "65f7fc06-e9ac-4b37-9027-b2a3a94283eb"
},
"account_label_2": {"uuid": "e7c7bbbf-1a20-4d74-b768-446a0ee3a02d"
}
},
"user": {"uuid": "e4e5d876-0152-461b-b7f6-092263e06c75"
}
}
}

Executes RaiseNow Connect based on onboarding data

path Parameters

token

required

string

Example: 97edb50eb33d94fc583bf0b1d92d5fdc

The generated token of the Onboarding Process

Responses

Response samples

201
404
409

Content type

application/json

{"uuid": "5d9f242b-c631-44b7-b9e2-a9c7b97b3a32",
"label": "pending",
"status": "pending",
"token": "7d1a573ba06244e6bfc70ffc02f014cb",
"url": "https://localhost?token=bff2d9d348920368c8094a2d72d3fbdb",
"expires_at": 1623248926,
"expired": true,
"created": 1623238926,
"external_id": "rand0m-iD-71204-1232",
"initialisation_data": { },
"results": {"organisation": {"uuid": "e5fbbd7b-b2b6-4c29-b913-c6a55ea5fdae"
},
"accounts": {"account_label_1": {"uuid": "65f7fc06-e9ac-4b37-9027-b2a3a94283eb"
},
"account_label_2": {"uuid": "e7c7bbbf-1a20-4d74-b768-446a0ee3a02d"
}
},
"user": {"uuid": "e4e5d876-0152-461b-b7f6-092263e06c75"
}
}
}

Executes partner onboarding process

path Parameters

token

required

string

Example: 97edb50eb33d94fc583bf0b1d92d5fdc

The generated token of the Onboarding Process

Responses

Response samples

201
404
409

Content type

application/json

{"uuid": "5d9f242b-c631-44b7-b9e2-a9c7b97b3a32",
"label": "pending",
"status": "pending",
"token": "7d1a573ba06244e6bfc70ffc02f014cb",
"url": "https://localhost?token=bff2d9d348920368c8094a2d72d3fbdb",
"expires_at": 1623248926,
"expired": true,
"created": 1623238926,
"external_id": "rand0m-iD-71204-1232",
"initialisation_data": { },
"results": {"organisation": {"uuid": "e5fbbd7b-b2b6-4c29-b913-c6a55ea5fdae"
},
"accounts": {"account_label_1": {"uuid": "65f7fc06-e9ac-4b37-9027-b2a3a94283eb"
},
"account_label_2": {"uuid": "e7c7bbbf-1a20-4d74-b768-446a0ee3a02d"
}
},
"user": {"uuid": "e4e5d876-0152-461b-b7f6-092263e06c75"
}
}
}

Get partner onboarding process by uuid

path Parameters

uuid

required

string

Example: 994b2075-6fda-42f6-b12b-c9c7b97b3c99

The identifier of the Process

Responses

Response samples

201
404

Content type

application/json

{"onboarding_configuration_uuid": "string",
"partner_integration_uuid": "string",
"uuid": "5d9f242b-c631-44b7-b9e2-a9c7b97b3a32",
"label": "pending",
"status": "pending",
"token": "7d1a573ba06244e6bfc70ffc02f014cb",
"url": "https://localhost?token=bff2d9d348920368c8094a2d72d3fbdb",
"expires_at": 1623248926,
"expired": true,
"created": 1623238926,
"external_id": "rand0m-iD-71204-1232",
"initialisation_data": { },
"results": {"organisation": {"uuid": "e5fbbd7b-b2b6-4c29-b913-c6a55ea5fdae"
},
"accounts": {"account_label_1": {"uuid": "65f7fc06-e9ac-4b37-9027-b2a3a94283eb"
},
"account_label_2": {"uuid": "e7c7bbbf-1a20-4d74-b768-446a0ee3a02d"
}
},
"user": {"uuid": "e4e5d876-0152-461b-b7f6-092263e06c75"
}
}
}

Check onboarding user email existence

path Parameters

email

required

string

Example: test@test.com

The email to be checked

query Parameters

recaptcha_token

required

string

Example: recaptcha_token=asd8172gdias

Valid Google ReCaptcha token

Responses

Response samples

400
403
404

Content type

application/json

{"request_id": "5ca31551a0695",
"error": {"http_code": 400,
"message": [{"code": "error.validation.not_null",
"property": "recaptcha_token",
"message": "recaptcha_token query param should not be empty"
}
],
"code": "bad_request"
}
}

Reconciliation

(Deprecated) Executes a Reconciliation Blueprint

path Parameters

uuid

required

string

Example: 6d94e6e7-6fb9-4aff-8ebc-a790a60afdf9

The identifier of the Blueprint

Request Body schema: multipart/form-data
required

filename

Array of strings <binary> [ items <binary > ]

Responses

Get reconciliation file Upload parameters.

Get file Upload credentials needed to upload directly to s3.

path Parameters

source-configuration-uuid

required

string

Example: 6d94e6e7-6fb9-4aff-8ebc-a790a60afdf9

The identifier of the source configuration for the type of file that will be uploaded.

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"inputs": {"key": "string",
"X-Amz-Credential": "string",
"X-Amz-Algorithm": "string",
"X-Amz-Date": "string",
"Policy": "string",
"X-Amz-Signature": "string"
},
"attributes": {"action": "string",
"method": "string",
"enctype": "string"
},
"expires": 1528304907
}

RaiseNow EPayment API (1.0.0)

OAuth2

Token

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Organisations

List Organisations

Responses

Response samples

Get Organisation

path Parameters

Responses

Response samples

Organisation Addresses

List Organisation Addresses

path Parameters

Responses

Response samples

Get Organisation Address

path Parameters

Responses

Response samples

Organisation Metadata

Get Organisation Metadata

path Parameters

Responses

Response samples

Accounts

List Accounts

Responses

Response samples

Get Account

path Parameters

Responses

Response samples

Get Account Billing Data

path Parameters

Responses

Response samples

Account Addresses

List Account Addresses

path Parameters

Responses

Response samples

Get Account Address

path Parameters

Responses

Response samples

Account Metadata

Get Account Metadata

path Parameters

Responses

Response samples

Payments

Initialise a payment

Request Body schema: application/jsonrequired

Responses

Request samples

Get Payment

path Parameters

Responses

Response samples

Cancel payment

path Parameters

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Replace Custom Parameters

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Patch Custom Parameters

path Parameters

Request Body schema: application/jsonrequired

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
optional

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required