Skip to content

Latest commit

 

History

History
155 lines (116 loc) · 7.71 KB

GroupPaymentService.md

File metadata and controls

155 lines (116 loc) · 7.71 KB

GroupPaymentService

A list of all methods in the GroupPaymentService service. Click on the method name to view detailed information about that method.

Methods Description
create_group_payment Create a group payment.
retrieve_group_payment_id Retrieve details of a group payment.
deletegroup_payment_id Cancel a group payment.

create_group_payment

Create a group payment.

  • HTTP Method: POST
  • Endpoint: /v1/payments/group_payments

Parameters

Name Type Required Description
request_body PaymentsGroupPaymentsBody ✅ The request body.
access_key str ✅ Unique access key provided by Rapyd for each authorized user.
content_type str ✅ Indicates that the data appears in JSON format. Set to application/json.
salt str ✅ Random string. Recommended length: 8-16 characters.
signature str ✅ Signature calculated for each request individually. See Request Signatures.
timestamp str ✅ Timestamp for the request, in Unix time (seconds).
idempotency str ❌ A unique key that prevents the platform from creating the same object twice.

Return Type

InlineResponse200_27

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment
from rapyd_sdk.models import PaymentsGroupPaymentsBody

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

request_body = PaymentsGroupPaymentsBody(
    description="description",
    merchant_reference_id="merchant_reference_id",
    metadata={},
    payments={}
)

result = sdk.group_payment.create_group_payment(
    request_body=request_body,
    access_key="access_key",
    content_type="Content-Type",
    salt="salt",
    signature="signature",
    timestamp="timestamp",
    idempotency="idempotency"
)

print(result)

retrieve_group_payment_id

Retrieve details of a group payment.

  • HTTP Method: GET
  • Endpoint: /v1/payments/group_payments/{groupPaymentId}

Parameters

Name Type Required Description
group_payment_id str ✅ ID of the group payment. String starting with gp_
access_key str ✅ Unique access key provided by Rapyd for each authorized user.
content_type str ✅ Indicates that the data appears in JSON format. Set to application/json.
salt str ✅ Random string. Recommended length: 8-16 characters.
signature str ✅ Signature calculated for each request individually. See Request Signatures.
timestamp str ✅ Timestamp for the request, in Unix time (seconds).
idempotency str ❌ A unique key that prevents the platform from creating the same object twice.

Return Type

InlineResponse200_27

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

result = sdk.group_payment.retrieve_group_payment_id(
    group_payment_id="groupPaymentId",
    access_key="access_key",
    content_type="Content-Type",
    salt="salt",
    signature="signature",
    timestamp="timestamp",
    idempotency="idempotency"
)

print(result)

deletegroup_payment_id

Cancel a group payment.

  • HTTP Method: DELETE
  • Endpoint: /v1/payments/group_payments/{groupPaymentId}

Parameters

Name Type Required Description
group_payment_id str ✅ ID of the group payment. String starting with gp_
access_key str ✅ Unique access key provided by Rapyd for each authorized user.
content_type str ✅ Indicates that the data appears in JSON format. Set to application/json.
salt str ✅ Random string. Recommended length: 8-16 characters.
signature str ✅ Signature calculated for each request individually. See Request Signatures.
timestamp str ✅ Timestamp for the request, in Unix time (seconds).
idempotency str ❌ A unique key that prevents the platform from creating the same object twice.

Return Type

InlineResponse200_27

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

result = sdk.group_payment.deletegroup_payment_id(
    group_payment_id="groupPaymentId",
    access_key="access_key",
    content_type="Content-Type",
    salt="salt",
    signature="signature",
    timestamp="timestamp",
    idempotency="idempotency"
)

print(result)