PaymentLinkService.md

PaymentLinkService

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

Methods	Description
payment_link	Retrieve details of a payment link.
create_payment_link	Creates a reusable link for a hosted payment page. <BR> A customer can use the link and the hosted payment page multiple times. After providing required information, the customer is redirected seamlessly to a Rapyd Checkout page to complete the payment.You can create the link for everyone or for a specific customer. You can make the payment amount fixed, editable, or open.

payment_link

Retrieve details of a payment link.

• HTTP Method: GET
• Endpoint: /v1/hosted/collect/payments/{paymentLink}

Parameters

Name	Type	Required	Description
payment_link	str	✅	ID of the payment link. String starting with hpreuse.
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_26

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment

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

result = sdk.payment_link.payment_link(
    payment_link="paymentLink",
    access_key="access_key",
    content_type="Content-Type",
    salt="salt",
    signature="signature",
    timestamp="timestamp",
    idempotency="idempotency"
)

print(result)

create_payment_link

Creates a reusable link for a hosted payment page. <BR> A customer can use the link and the hosted payment page multiple times. After providing required information, the customer is redirected seamlessly to a Rapyd Checkout page to complete the payment.You can create the link for everyone or for a specific customer. You can make the payment amount fixed, editable, or open.

• HTTP Method: POST
• Endpoint: /v1/hosted/collect/payments/

Parameters

Name	Type	Required	Description
request_body	CollectPaymentsBody	❌	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_26

Example Usage Code Snippet

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

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

request_body = CollectPaymentsBody(
    amount="amount",
    amount_is_editable=True,
    checkout={},
    country="country",
    currency="currency",
    customer="customer",
    fixed_side="buy",
    language="en",
    max_payments=7,
    merchant_reference_id="merchant_reference_id",
    requested_currency="requested_currency"
)

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

print(result)