POST payments Activity
BearerAuthorizationBearer <token>Paste your JWT token here
The data transfer object containing activity-specific payment details.
application/json- body
Defines the DTO for posting an activity payment, containing the necessary information for creating a new activity payment, including the member ID, an optional flag indicating whether the payment was manually marked as paid, and a list of unique identifiers of the activities for which the activity payment is being created. The PostActivityPaymentDTO is used to transfer data from the client to the server when creating a new activity payment, ensuring that all required information is provided and validated appropriately for the creation process, allowing for effective tracking and management of activity payments based on the provided activity IDs in the request payload.
memberId?stringThe identifier of the member who made the payment. This is a foreign key referencing the Member entity. This property is nullable because even if the member is removed from the database, we may want to keep the payment record for historical and auditing purposes. In such cases, the MemberId would be set to null to indicate that the member associated with the payment has been deleted, while still retaining the payment information for reference.
uuidmanuallyMarkedAsPaid?booleanIndicates whether the payment was manually marked as paid by an administrator. This is used to differentiate between payments that were processed through the normal payment flow and those that were manually marked as paid, which may require different handling in terms of accounting and reporting. This property is set to false by default, and can be set to true by an administrator when they manually mark a payment as paid, allowing for better tracking and management of payments that may not have gone through the standard payment processing flow.
activityIds?array<>The list of unique identifiers of the activities for which the activity payment is being created. This field is required to associate the activity payment with the correct activities within the system, allowing for effective tracking and management of activity payments based on the provided activity IDs in the request payload. The PostActivityPaymentDTO ensures that the activity payment is created with the necessary information to effectively manage and track activity payments for the specified activities, providing a structured and validated approach to activity payment creation in the application.
OK
application/json- response
Defines the response DTO for a payment, containing the necessary information about the payment response, including an optional checkout URL. The PostPaymentResponse is used to transfer data from the server to the client after creating a new payment, allowing for the inclusion of relevant information such as a checkout URL if applicable, providing a structured and informative response for payment-related operations in the application.
checkoutUrl?|The URL provided by the Payment Service for the payment intent. This URL is used to redirect the member to the Payment Service payment page where they can complete the payment process. This property is required for all payments, as it is essential for facilitating the payment process through the Payment Service payment gateway and ensuring that members can easily access the payment page to complete their transactions.
curl -X POST 'https://example.com/payments/activity' \ -H 'Content-Type: application/json' \ -d '{}'{ "checkoutUrl": "string"}