PaymentService
A list of all methods in the PaymentService service. Click on the method name to view detailed information about that method.
| Methods | Description |
|---|---|
| list_payments | Retrieve a list of all payments that you have created. You can filter the list with query parameters. |
| create_payment | Create a payment |
| retrieve_payment | Retrieve details of a payment |
| update_payment | Change or modify a payment when the status of the payment is ACT (active). You can update additional fields if they are listed under payment_options in the response from Get Payment Method Required Fields and is_updateable is set to true |
| cancel_payment | Cancel a payment where the status of the payment is ACT. Relevant to payment methods where is_cancelable = true in the response to List Payment Methods by Country. This method triggers the Payment Canceled webhook. This webhook contains the same information as the response. NOTE: If the status is CLO, use the Create Refund method. |
list_payments
Retrieve a list of all payments that you have created. You can filter the list with query parameters.
- HTTP Method:
GET - Endpoint:
/v1/payments
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| created_after | str | ❌ | The ID of the payment created before the first payment you want to retrieve. String starting with payment_. |
| created_before | str | ❌ | The ID of the payment created after the last payment you want to retrieve. String starting with payment_. |
| customer | Customer | ❌ | Filters the list for payments related to the specified customer. |
| destination_card | str | ❌ | Filters the list for payments related to the specified destination card. |
| ending_before | str | ❌ | The ID of the payment created after the last payment you want to retrieve. String starting with payment_. Deprecated. |
| ewallet | str | ❌ | Filters the list for payments related to the specified wallet. |
| group | bool | ❌ | When true, includes only group payments in the response. When false, excludes group payments from the response. Default is false. |
| invoice | str | ❌ | Filters according to the invoice. String starting with invoice_. |
| limit | str | ❌ | The maximum number of payments to return. Range, 1-100. Default is 10. |
| payment_method | str | ❌ | Filters the list for payments related to the specified payment method. |
| order | str | ❌ | Filters the list for payments related to the specified order. |
| starting_after | str | ❌ | The ID of a payment in the list. The list begins with the payment that was created next after the payment with this ID. Use this filter to get the next page of results. Relevant when endingbefore is not used. String starting with payment. |
| subscription | str | ❌ | Filters the list for payments related to the specified subscription. |
| merchant_reference_id | str | ❌ | Merchant-defined ID. |
Return Type
InlineResponse200_53
Example Usage Code Snippet
from rapyd_sdk import RapydSdk, Environment
from rapyd_sdk.models import Customer
sdk = RapydSdk(
base_url=Environment.DEFAULT.value,
timeout=10000
)
customer=Customer(
addresses=[
{
"canton": "canton",
"city": "city",
"country": "GB",
"created_at": 3.34,
"district": "district",
"id_": "id",
"line_1": "line_1",
"line_2": "line_2",
"line_3": "line_3",
"metadata": {},
"name": "name",
"phone_number": "phone_number",
"state": "state",
"zip": "zip"
}
],
business_vat_id="business_vat_id",
created_at=7,
default_payment_method="default_payment_method",
delinquent=False,
description="description",
discount={
"coupon": {
"amount_off": 0.13,
"created": 1671697165,
"currency": "GBP",
"description": "Sample Coupon 1",
"discount_duration_in_uses": 2,
"discount_valid_until": 7.67,
"discount_validity_in_months": 2,
"duration": "forever",
"duration_in_months": 3,
"id_": "coupon_c1194a18a9972ca7f9804826f00c9eb8",
"max_redemptions": 2,
"metadata": {},
"percent_off": 10,
"redeem_by": 0.44,
"times_redeemed": 6.69,
"valid": True
},
"customer": "cus_3f4ed3168413d863671602dfbe839aa2",
"end": 1679473563,
"id_": "dis_ab0445dee00fdcdd83811760ffe90e3b",
"number_of_uses": 2.89,
"start": 1679473563,
"subscription": "sub_199e8c92ec0ec2bcbe56740042639d6e",
"valid": True
},
email="email",
ewallet="ewallet",
id_="id",
invoice_prefix="invoice_prefix",
metadata={},
name="name",
payment_methods={
"data": [
{
"category": "bank",
"fingerprint_token": "fingerprint_token",
"id_": "id",
"image": "image",
"last4": "4487",
"metadata": {},
"name": "name",
"network_reference_id": "network_reference_id",
"next_action": "3d_verification",
"redirect_url": "redirect_url",
"supporting_documentation": "supporting_documentation",
"token": "token",
"type_": "type",
"webhook_url": "webhook_url"
}
],
"has_more": True,
"total_count": 7,
"url": "url"
},
phone_number="phone_number",
subscriptions=[
{
"billing": "pay_automatically",
"billing_cycle_anchor": "now",
"cancel_at_period_end": True,
"canceled_at": 5.63,
"created_at": 1592379647,
"current_period_end": 1594971647,
"current_period_start": 1592379647,
"customer_token": "cus_3f4ed3168413d863671602dfbe839aa2",
"days_until_due": 30,
"discount": {
"coupon": {
"amount_off": 0.13,
"created": 1671697165,
"currency": "GBP",
"description": "Sample Coupon 1",
"discount_duration_in_uses": 2,
"discount_valid_until": 7.67,
"discount_validity_in_months": 2,
"duration": "forever",
"duration_in_months": 3,
"id_": "coupon_c1194a18a9972ca7f9804826f00c9eb8",
"max_redemptions": 2,
"metadata": {},
"percent_off": 10,
"redeem_by": 0.44,
"times_redeemed": 6.69,
"valid": True
},
"customer": "cus_3f4ed3168413d863671602dfbe839aa2",
"end": 1679473563,
"id_": "dis_ab0445dee00fdcdd83811760ffe90e3b",
"number_of_uses": 2.89,
"start": 1679473563,
"subscription": "sub_199e8c92ec0ec2bcbe56740042639d6e",
"valid": True
},
"ended_at": 7.3,
"id_": "sub_04fd8fbd78d7dd7e0e6323810a69275c",
"metadata": {},
"payment_fields": {},
"payment_method": "card_320dcb1879fbc41f13a81e690636f3c2",
"payout_fields": {},
"simultaneous_invoice": True,
"status": "active",
"subscription_items": {
"data": [
{
"created": 1.05,
"id_": "subi_e5dbbf84c68e5bb7db761625158d4262",
"metadata": "{\"merchant_defined\": True }",
"plan": {
"aggregate_usage": "max",
"amount": 5.37,
"billing_scheme": "per_unit",
"created_at": 1592311574,
"currency": "GBP",
"id_": "plan_51788cf4ed1b672cb0a2a97773887f5b",
"interval": "month",
"interval_count": 2,
"metadata": {},
"nickname": "Basic Parking",
"product": {
"active": True,
"attributes": [
"attributes"
],
"created_at": 1592299157,
"description": "The ultimate in comfort for the dedicated gamer",
"id_": "product_0d9dc6be69c769560fe913f3b086d8ca",
"images": [
"images"
],
"metadata": {},
"name": "Gamer's Red Chair",
"package_dimensions": {
"height": 10,
"length": 20,
"weight": 100,
"width": 40
},
"shippable": True,
"skus": [
{
"active": True,
"attributes": {
"color": "green"
},
"created_at": 1546353713,
"currency": "GBP",
"id_": "sku_a6d86bdc6f3a7ef6cb51de5a5678493f",
"image": "image",
"inventory": {},
"metadata": {},
"package_dimensions": {
"height": 1,
"length": 2,
"weight": 3,
"width": 4
},
"price": 10.99,
"product": "product_f383d03c34fb499eb3ada4e3c574002a",
"updated_at": 1546354288
}
],
"statement_descriptor": "statement_descriptor",
"type_": "goods",
"unit_label": "unit_label",
"updated_at": 1592300812
},
"tiers": [
{
"amount": 15,
"flat_amount": 6.45,
"up_to": "inf"
}
],
"tiers_mode": "graduated",
"transform_usage": {
"divide_by": 1,
"round": "round"
},
"trial_period_days": 9.42,
"usage_type": "metered"
},
"quantity": 4.27,
"subscription_id": "sub_0de9c79c1e2beee09499dc8220493d5"
}
],
"has_more": True,
"total_count": 1,
"url": "/v1/subscription_items?subscription=sub_324ee75f8c26f1df94bc8cc693f3c729"
},
"tax_percent": 10.5,
"trial_end": 9.98,
"trial_start": 3.73,
"type_": "payout"
}
]
)
result = sdk.payment.list_payments(
created_after="created_after",
created_before="created_before",
customer=customer,
destination_card="destination_card",
ending_before="ending_before",
ewallet="ewallet",
group=True,
invoice="invoice",
limit="limit",
payment_method="payment_method",
order="order",
starting_after="starting_after",
subscription="subscription",
merchant_reference_id="merchant_reference_id"
)
print(result)
create_payment
Create a payment
- HTTP Method:
POST - Endpoint:
/v1/payments
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| request_body | V1PaymentsBody | ✅ | The request body. |
Return Type
InlineResponse200_54
Example Usage Code Snippet
from rapyd_sdk import RapydSdk, Environment
from rapyd_sdk.models import V1PaymentsBody
sdk = RapydSdk(
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = V1PaymentsBody(
address={
"canton": "canton",
"city": "city",
"country": "GB",
"created_at": 3.34,
"district": "district",
"id_": "id",
"line_1": "line_1",
"line_2": "line_2",
"line_3": "line_3",
"metadata": {},
"name": "name",
"phone_number": "phone_number",
"state": "state",
"zip": "zip"
},
amount=5.04,
capture=True,
client_details={
"ip_address": "ip_address",
"java_enabled": False,
"java_script_enabled": False,
"language": "language",
"screen_color_depth": 1,
"screen_height": 4,
"screen_width": 8,
"time_zone_offset": 5
},
complete_payment_url="complete_payment_url",
currency="GBP",
customer="customer",
description="description",
error_payment_url="error_payment_url",
escrow=True,
escrow_release_days="/6/",
ewallet="ewallet",
ewallets="",
expiration=3.35,
fixed_side="fixed_side",
group_payment="group_payment",
initiation_type="customer_present",
merchant_reference_id="merchant_reference_id",
metadata={},
payment_fees={
"fx_fee": {
"calc_type": "gross",
"value": 2.5
},
"gross_fees": 4.23,
"net_fees": 2.4,
"transaction_fee": {
"calc_type": "gross",
"fee_type": "absolute",
"value": 2
},
"total_merchant_fees": 3.19
},
payment_method="uteli",
payment_method_options={},
receipt_email="receipt_email",
requested_currency="requested_currency",
statement_descriptor="statement_descriptor"
)
result = sdk.payment.create_payment(request_body=request_body)
print(result)
retrieve_payment
Retrieve details of a payment
- HTTP Method:
GET - Endpoint:
/v1/payments/{paymentId}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| payment_id | str | ✅ | ID of the payment. String starting with 'payment_'. |
Return Type
InlineResponse200_54
Example Usage Code Snippet
from rapyd_sdk import RapydSdk, Environment
sdk = RapydSdk(
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.payment.retrieve_payment(payment_id="paymentId")
print(result)
update_payment
Change or modify a payment when the status of the payment is ACT (active). You can update additional fields if they are listed under payment_options in the response from Get Payment Method Required Fields and is_updateable is set to true
- HTTP Method:
POST - Endpoint:
/v1/payments/{paymentId}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| request_body | PaymentsPaymentIdBody | ✅ | The request body. |
| payment_id | str | ✅ | ID of the payment. String starting with payment_. |
Return Type
InlineResponse200_54
Example Usage Code Snippet
from rapyd_sdk import RapydSdk, Environment
from rapyd_sdk.models import PaymentsPaymentIdBody
sdk = RapydSdk(
base_url=Environment.DEFAULT.value,
timeout=10000
)
request_body = PaymentsPaymentIdBody(
address={
"canton": "canton",
"city": "city",
"country": "GB",
"created_at": 3.34,
"district": "district",
"id_": "id",
"line_1": "line_1",
"line_2": "line_2",
"line_3": "line_3",
"metadata": {},
"name": "name",
"phone_number": "phone_number",
"state": "state",
"zip": "zip"
},
description="description",
escrow=True,
escrow_release_days="/3/",
initiation_type="initiation_type",
metadata={},
receipt_email="receipt_email"
)
result = sdk.payment.update_payment(
request_body=request_body,
payment_id="paymentId"
)
print(result)
cancel_payment
Cancel a payment where the status of the payment is ACT. Relevant to payment methods where is_cancelable = true in the response to List Payment Methods by Country. This method triggers the Payment Canceled webhook. This webhook contains the same information as the response. NOTE: If the status is CLO, use the Create Refund method.
- HTTP Method:
DELETE - Endpoint:
/v1/payments/{paymentId}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| payment_id | str | ✅ | ID of the payment. String starting with payment_. |
Return Type
InlineResponse200_54
Example Usage Code Snippet
from rapyd_sdk import RapydSdk, Environment
sdk = RapydSdk(
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.payment.cancel_payment(payment_id="paymentId")
print(result)
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs