Skip to content

Latest commit

 

History

History
598 lines (541 loc) · 525 KB

PyPI_README.md

File metadata and controls

598 lines (541 loc) · 525 KB

RapydSdk Python SDK 1.0.12

Welcome to the RapydSdk SDK documentation. This guide will help you get started with integrating and using the RapydSdk SDK in your project.

This SDK was generated by liblab

Versions

  • API version: 1.0.12
  • SDK version: 1.0.12

About the API

This is a Beta release of the Python SDK for Rapyd's API methods. It is recommended to initially run the methods in the sandbox environment. For the most up to date documentation of Rapyd's methods, see the online API Reference.

Table of Contents

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: Python >= 3.7

Installation

To get started with the SDK, we recommend installing using pip:

pip install rapyd-sdk

Environments

The SDK supports different environments for various stages of development and deployment.

Here are the available environments:

DEFAULT = "https://sandboxapi.rapyd.net"
SANDBOX = "https://sandboxapi.rapyd.net"
PRODUCTION = "https://api.rapyd.net"

Setting an Environment

To configure the SDK to use a specific environment, you can set the base URL as follows:

from rapyd_sdk import Environment

sdk.set_base_url(Environment.Sandbox.value)

Environment Variables

These are the environment variables for the SDK:

Name Description
ACCESS_KEY Access Key parameter
SECRET_KEY Secret Key parameter

Environment variables are a way to configure your application outside the code. You can set these environment variables on the command line or use your project's existing tooling for managing environment variables.

If you are using a .env file, a template with the variable names is provided in the .env.example file located in the same directory as this README.

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

from rapyd_sdk import RapydSdk

sdk = RapydSdk(timeout=10000)

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

from rapyd_sdk import RapydSdk, Environment

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

result = sdk.webhook_methods.list_webhooks(
    from_created_at="from_created_at",
    limit=50,
    page="page",
    status="status",
    type_="type",
    to_created_at=7.84
)

print(result)

Services

The SDK provides various services to interact with the API.

Below is a list of all available services:
Name
payment_method_type
payment
checkout_page
subscription
subscription_plan
subscription_product
subscription_subscription_item
subscription_invoice
subscription_invoice_item
payment_link
group_payment
escrow
refund
digital_wallet
dispute
customer
payment_address
customer_payment_method
sku
order
order_return
coupon
disburse
disburse_upload_documents
e_wallets
issuing
payment_card_token
issuing_simulations
virtual_accounts
fx
localization_methods
webhook_methods
verify
card_network_lookup_service

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

Below is a list of all available models:
Name Description
InlineResponse200
InlineResponse200_1
InlineResponse200_2
Customer customer
V1PaymentsBody
InlineResponse200_3
PaymentsPaymentIdBody
PaymentIdCaptureBody
PaymentsCompletePaymentBody
InlineResponse200_4
V1CheckoutBody
InlineResponse200_5
PaymentsSubscriptionsBody
InlineResponse200_6
SubscriptionsSubscriptionIdBody
InlineResponse200_7
CheckoutSubscriptionsBody
InlineResponse200_8
InlineResponse200_9
InlineResponse200_20
InlineResponse200_10
V1PlansBody
InlineResponse200_11
PlansPlanIdBody
InlineResponse200_12
InlineResponse200_13
V1ProductsBody
InlineResponse200_14
ProductsProductsIdBody
InlineResponse200_15
V1SubscriptionItemsBody
InlineResponse200_16
SubscriptionItemsSubscriptionItemIdBody
InlineResponse200_17
InlineResponse200_18
SubscriptionItemIdUsageRecordsBody
InlineResponse200_19
InlineResponse200_21
V1InvoicesBody
InlineResponse200_22
InvoicesInvoiceIdBody
InlineResponse200_23
InvoiceIdPayBody
InlineResponse200_24
V1InvoiceItemsBody
InvoiceItemsInvoiceItemBody
InlineResponse200_25
InlineResponse200_26
CollectPaymentsBody
PaymentsGroupPaymentsBody
InlineResponse200_27
InlineResponse200_28
EscrowEscrowReleasesBody
InlineResponse200_29
InlineResponse200_30
V1RefundsBody
InlineResponse200_31
RefundsCompleteBody
RefundsGroupPaymentsBody
InlineResponse200_32
RefundsRefundIdBody
ApplePayObject
InlineResponse200_33
InlineResponse200_34
GetDisputesListByOrgIdStatus
InlineResponse200_35
InlineResponse200_36
V1CustomersBody
InlineResponse200_37
CustomerRequest
InlineResponse200_38
InlineResponse200_39
V1AddressesBody address associated with this specific Rapyd entity Payment/Customer etc...
InlineResponse200_40
InlineResponse200_41
Category
CustomerIdPaymentMethodsBody
InlineResponse200_42
InlineResponse200_43
InlineResponse200_44
SkusSkuIdBody
InlineResponse200_45
V1SkusBody
InlineResponse200_46
V1OrdersBody
InlineResponse200_47
OrdersOrderIdBody
OrderIdPayBody
OrderIdReturnsBody
InlineResponse200_48
InlineResponse200_49
InlineResponse200_50
Coupon The coupon can be applied to the following objects - _ Subscription - All charges in the subscription are subject to the discount described in the coupon. To add a coupon to a subscription, first use Create Coupon. Then add the coupon ID to the coupon field of the subscription with Create Subscription or Update Subscription. _ Customer - The discount applies to all charges to the customer. To add a coupon to a customer, first use Create Coupon. Then add the coupon ID to the coupon field of the customer with Create Customer or Update Customer. * Order - The discount applies to a single order. To add a coupon to an order, first use Create Coupon. The duration field of the coupon must be set to repeating, and the duration_in_months and discount_duration_in_uses fields must be set to 1. Then add the coupon ID to the coupon field of the order with Create an Order or Update Order. A coupon can be applied to one or more customers or subscriptions. However, a subscription can have only one coupon, and the only way to assign two or more coupons to a customer is to assign them to separate subscriptions. If there is a coupon for the customer and another coupon for the customer's subscription, the subscription coupon takes precedence.
InlineResponse200_51
InlineResponse200_52
InlineResponse200_53
InlineResponse200_54
V1PayoutsBody
InlineResponse200_55
InlineResponse200_56
PayoutsBeneficiaryBody
InlineResponse200_57
PayoutsExtendedBeneficiaryBody
BeneficiaryValidateBody
InlineResponse200_58
BeneficiaryBeneficiaryIdBody
InlineResponse200_59
DisburseBeneficiaryBody
InlineResponse200_60
PayoutsSenderBody
InlineResponse200_61
InlineResponse200_62
InlineResponse200_63
PayoutsPayoutIdBody
InlineResponse200_64
InlineResponse200_65
InlineResponse200_66
AccountTransferBody
InlineResponse200_67
TransferResponseBody
AccountDepositBody
InlineResponse200_68
AccountWithdrawBody
BalanceHoldBody
InlineResponse200_69
InlineResponse200_70
EwalletIdContactsBody
InlineResponse200_71
Contact
InlineResponse200_72
InlineResponse200_73
InlineResponse200_97
V1EwalletsBody
InlineResponse200_98
EwalletsEwalletTokenBody
UpdateEwalletStatusStatus
AccountLimitsBody
InlineResponse200_99
InlineResponse200_100
InlineResponse200_101
InlineResponse200_102
InlineResponse200_103
CardDetailsCardTokenBody
InlineResponse200_74
InlineResponse200_75
IssuingCardsBody
InlineResponse200_76
InlineResponse200_77
CardsActivateBody
InlineResponse200_78
IssuingActivateCardBody
InlineResponse200_79
IssuingPinBody
InlineResponse200_80
CardsPersonalizeBody
CardsStatusBody
InlineResponse200_81
InlineResponse200_82
CardsPinBody
InlineResponse200_83
CardTokensGooglePayBody
InlineResponse200_84
IssuingBankaccountsBody
InlineResponse200_107
BankaccountsBankaccounttransfertobankaccountBody
InlineResponse200_108
InlineResponse200_109
BankaccountsVirtualAccountIdBody
InlineResponse200_93
InlineResponse200_110
CollectCardBody
InlineResponse200_85
CardsSimulateBlockBody
InlineResponse200_86
CardsAuthorizationBody
InlineResponse200_87
CardsReversalBody
InlineResponse200_88
CardsClearingBody
InlineResponse200_89
CardsRefundBody
CardsAdjustmentBody
V1VirtualAccountsBody
InlineResponse200_90
VirtualAccountsTransactionsBody
InlineResponse200_91
InlineResponse200_92
VirtualAccountsVirtualAccountIdBody
InlineResponse200_94
InlineResponse200_95
InlineResponse200_96
InlineResponse200_104
InlineResponse200_120
InlineResponse200_121
InlineResponse200_122
InlineResponse200_105
InlineResponse200_106
V1IdentitiesBody
InlineResponse200_111
InlineResponse200_112
InlineResponse200_113
InlineResponse200_114
ApplicationsHostedBody
InlineResponse200_115
InlineResponse200_116
HostedIdvBody
InlineResponse200_117
CnlTerminationQueryBody
InlineResponse200_118
InlineResponse200_119
Status1
PaymentMethodType A type of payment method that a customer can use for making payments.
PaymentAmountRangePerCurrencyInner
Field1 Field Object
Field1Conditions
PaymentMethodTypeRequiredFields Payment Method Type required fields - this is the response of GET required fields for Payment_Method_Type
Payment Collects money from a payment method and deposits it into one or more Rapyd Wallets
Address1 address associated with this specific Rapyd entity Payment/Customer etc.
Dispute Describes the fields contained in REST messages and webhooks for disputes of payments.
PaymentEwallets
PaymentInstructions
NextAction Indicates the next action for completing the payment. Response only. One of the following values are - _ 3d_verification - The next action is 3DS authentication. To simulate 3DS authentication in the sandbox, see Simulating 3DS Authentication. Relevant only to card payments. _ pending_capture - The next action is pending the capture of the amount. Relevant only to card payments when the amount is not zero. _ pending_confirmation - The next action is pending the confirmation for the payment. Relevant to all payment methods excluding card payment. _ not_applicable - The payment has completed or the next action is not relevant.
Outcome The outcome object describes the outcome of the Rapyd Protect risk assessment
Fee
PaymentRefunds Refunds object
PaymentStatus
PaymentSteps
PaymentOptions A payment method type is a type of payment method that any customer can use, for example, eemastercard_card, Mastercard for Estonia. When it is added to a customer profile, it becomes a payment method that is specific to that one customer. The name of the payment method type starts with a prefix for the country, the 2-letter ISO 3166-1 alpha-2 code. If the payment method is valid in multiple countries, the prefix is xx. The payment method type has a suffix with one of the following values - _bank - Bank transfer or bank redirect _card - Credit card, debit card or other card _cash - Cash _ewallet - Local eWallet
BinDetails Bank Identification Number (BIN) details. Read-only. Object containing the following fields - _ bin_number - BIN number _ country - The two-letter ISO 3166-1 ALPHA-2 code for the country. Uppercase. _ funding - Type of card funding. One of the following [credit, debit, prepaid, unknown] _ bank - Name of the issuing bank. Relevant to cards
Condition
Discount Describes the fields relating to discounts in REST messages and webhooks for customer profiles and subscriptions Contains information about the coupon that applies to the customer. Read-only field. Adding a discount is a 2-step process: <BR> 1. Create Coupon, which returns a coupon ID. <BR>2. Add the coupon ID to the coupon field of the customer with Create Customer or Update Customer.
CustomerPaymentMethods An object containing the following fields - _ data - A list of up to three payment methods. For more information, see Customer Payment Method Object. _ has_more - Indicates whether there are more than three payment methods for this customer. _ total_count - Total number of payment methods for this customer. _ url - URL for requesting all of the payment methods for this customer..
Subscription
SubscriptionItems
SubscriptionItem
Plan Describes the pricing structure for the invoice item. For details of the fields in the plan object, see 'Create Plan'.
PlanTiers
PlanTransformUsage Defines the transformation that is applied to the reported usage before the billed price is computed. The transformation divides the quantity by the divisor specified in divide_by, then rounds up or down according to the setting in round. Relevant when billing_scheme is set to per_unit.
Product
ProductPackageDimensions Describes the physical size and weight of the product. Contains the following fields: _ height _ length _ weight _ width These fields are represented as numbers, but it is the responsibility of the merchant to define and interpret the relevant units of length and weight.
Sku
SkuPackageDimensions Physical attributes of the SKU item. Contains the following fields, height length weight width These fields are represented as numbers, but it is the responsibility of the merchant to define and interpret the relevant units of length and weight.
FxFee Describes the fees for processing the currency exchange. Relevant to payouts with FX.
TransactionFee Describes the fee for processing the transaction.
ClientDetailsObject Describes the fields in the client_details object in REST messages for payments. The client_details object describes the browser that the customer is using. The client collects this information and sends it as part of the Create Payment request. This information is used for processing the 3DS version 2 authentication of the customer. Note that Client Details information is not returned in the API response and it does not appear in any webhooks.
CheckoutPageResponse
MerchantCustomerSupport Contains details of the client’s customer support. To configure these fields, use the Client Portal.
HostedPageStatus Status of the hosted page. One of the following: NEW - The hosted page was created. DON - Done. The card was added to the customer profile. EXP - The hosted page expired.
HostedPageAdditionalResponseCartItems Describes the cart items that the customer is purchasing. These items are displayed at the checkout page.
HostedPageAdditionalResponseCustomElements Description of the payment transaction.
V1paymentssubscriptionsSubscriptionItems
InlineResponse200_7Data
SubscriptionHostedPageReponse
SubscriptionHostedPageReponseCustomElements Description of the payment transaction.
SubscriptionHostedPageReponseMerchantCustomerSupport
InlineResponse200_12Data
V1productsPackageDimensions Describes the physical size and weight of the product. Relevant when type is goods.
InlineResponse200_17Data
InlineResponse200_18Data
InvoiceResponse Invoice
InvoiceItemResponse Invoice item
Payout
InvoiceItemResponsePeriod Defines the start and end of the time period that this invoice item refers to. Relevant when the invoice item refers to more than one day. Contains the following fields:
Beneficiary
PayoutEwallets
PayoutInstructions
PayoutFees
Sender
PayoutStatus
EntityType
InlineResponse200_23Data
InlineResponse200_25Data
PaymentLink Retrieves details of a payment link.
GroupPayment Group Payment
EscrowResponse
EscrowResponseEscrowReleases Array of objects that describe individual releases.
EscrowResponseEscrowReleasesData Array of objects that describe individual escrow releases.
EscrowEwallets Describes the wallets and the releases from escrow.
Refund
RefundEwallets
InlineResponse200_32Data
ApplePayObjectResponse
CustomerRequestPaymentMethod The payment method that is used when the transaction does not specify a payment method. String starting with card_ or other_.
DiscountCustomerResponse Describes the fields relating to discounts in REST messages and webhooks for customer profiles and subscriptions Contains information about the coupon that applies to the customer. Read-only field. Adding a discount is a 2-step process: <BR> 1. Create Coupon, which returns a coupon ID. <BR>2. Add the coupon ID to the coupon field of the customer with Create Customer or Update Customer.
AddressResponse
InlineResponse200_43Data
V1skusskuIdInventory inventory object {quantity, type, value}
V1skusskuIdPackageDimensions Physical attributes of the SKU item. Object containing the following fields - height, length, weight, width
OrderResponse
OrderItemResponse
OrderReturnedItemResponse
OrderResponseStatusTransitions Indicates the last time in Unix time that the order transitioned to one of the following statuses. A zero value for a status indicates that the order has never transitioned to it.
V1ordersItems
V1ordersorderIdreturnsItems
OrderReturnedResponse
InlineResponse200_52Data
PayoutMethodTypeDetails
Status
PayoutRequiredFields
MassPayoutResponse
Gender Gender of the individual. Required when entity_type is individual.
InlineResponse200_58Data
InlineResponse200_59Data
V1hosteddisbursebeneficiaryBeneficiaryOptionalFields
HostedBeneficiaryTokenResponse
HostedBeneficiaryTokenResponseBeneficiaryOptionalFields
HostedBeneficiaryTokenResponseMerchantCustomerSupport
InlineResponse200_62Data
PayoutMethodType
PayoutAmountRangePerCurrencyInner
PayoutReturned
PayoutReturnedStatus
InlineResponse200_65Data
Transfer
InlineResponse200_68Data
PutFundsOnHoldResponse
ContactBusiness
InlineResponse200_72Data
InlineResponse200_73Data
InlineResponse200_73DataComplianceLevels
InlineResponse200_73DataElements
Ewallet
Account
EwalletContacts
Limit
V1ewalletsContact
EwalletTransaction
EwalletTransactionDetails
InlineResponse200_103Data
InlineResponse200_103DataBankAccounts Array of objects with details of the virtual accounts. Each object contains the following fields
PaymentParams
CardIssuing
CardIssuingMasked
HostedPageActivateCardResponse
HostedPageCardPinResponse
CardTransaction
SetPinResponse
AddCardtoGooglePayResponse
AddCardtoGooglePayResponseUserAddress The base64 encoded string that contains the encrypted object for Push Provisioning. Required for adding the card to the Google Pay wallet by using the Google Pay pushTokenizeRequest method. For more information refer to the Google Pay Provisioning developer documentation .Details of an account funding transaction (AFT), which transfers funds from a card to a cardholder's wallet.
InlineResponse200_107Data
InlineResponse200_108Data
InlineResponse200_93DataTransactions
InlineResponse200_109Data
InlineResponse200_93Data
InlineResponse200_110Data
V1hostedcollectcardCardFields Contains details about the card.
CardTokenResponse
CardTokenResponseCardFields Contains details about the card.
CardTokenResponsePaymentParams Contains the following fields. When these fields do not include values, the user is redirected to the hosted page, and a related status message appears at the top of the page.
SimulateBlockCardResponse
SimulateCardTransactionAuthorizationRequestEea
SimulateCardTransactionAuthorizationRequestEeaAuthResponse Response related to an authorization. Contains the following fields:
SimulateCardTransactionAuthorizationReversalEea
SimulateClearingCardTransactionEeaRemoteAuthResponse Response to a successful remote authorization request. Contains the following fields:
SimulateClearingCardTransactionEea
InlineResponse200_90Data
InlineResponse200_91Data
InlineResponse200_91DataTransactions
VirtualAccountIssuing
VirtualAccountTransactionResponse
InlineResponse200_94Data
InlineResponse200_95Data
DailyRate Describes currency conversion for payments and payouts. Rapyd uses a snapshot of daily foreign exchange rates fetched at 9 PM UTC. The rate returned includes the FX markup fees.
ListSupportedLanguagesResponse
ListSupportedLanguagesResponseLanguages List of the languages supported for hosted pages.
ListCountriesResponse
ListCountriesResponseLanguages List of the supported countries.
ListCurrenciesResponse
ResendWebhookResponse
ListWebhooksResponseAttempts List of attempts at sending the webhook. Array of objects that contain the following fields:
ListWebhooksResponseAttemptsHttpResponseHeaders Headers of the HTTP response from the configured webhook destination, with the value received.
ListWebhooksResponse
InlineResponse200_111Data
InlineResponse200_112Data
InlineResponse200_113Data
EntityTypeVerify
InlineResponse200_114Data
VerifyHostedAppResponse
VerifyHostedAppResponseMerchantDetails Object containing information about the merchant.
VerifyHostedAppResponseMerchantDetailsMerchantCustomerSupport
InlineResponse200_116Data
InlineResponse200_116DataApplicationType
InlineResponse200_116DataOrganizationDetails
InlineResponse200_116DataRenewResult
InlineResponse200_116DataOrganizationDetailsMerchantCustomerSupport
InlineResponse200_117Data Retrieve the Rapyd ID and merchant reference ID.
InlineResponse200_117DataMerchantCustomerSupport Contains details of the client’s customer support. To configure these fields, use the Client Portal.
V1cnlterminationQuerySearchCriteria Specifies search criteria for the query.
V1cnlterminationQueryQueriedMerchant Information about the merchant who is the subject of the query.
V1cnlterminationQueryQueriedMerchantAddress Details of the merchant's business address.
V1cnlterminationQueryQueriedMerchantPrincipals Details of the registered principal owners of the merchant.<BR> Maximum - 3.
V1cnlterminationQueryQueriedMerchantPrincipalsAddress Details of the owner's business address.
InlineResponse200_118Data
InlineResponse200_119Data
InlineResponse200_119DataMatchStats Statistics about the query.
InlineResponse200_119DataMatches Describes the results of the query.
InlineResponse200_119DataQueryInfo asd
InlineResponse200_119DataPrincipals Details of the registered principal owners of the merchant.<BR> Maximum - 3.
InlineResponse200_119DataMatchedMerchant Data about the merchant on file in the database.
InlineResponse200_119DataRegistrationInfo Registration information in the card network's termination database about the merchant and the acquirer that listed the merchant.
InlineResponse200_119DataQueryInfoQueriedMerchant Details of the merchant who is the subject of the query.

Using Union Types

Union types allow you to specify that a variable can have more than one type. This is particularly useful when a function can accept multiple types of inputs. The Union type hint is used for this purpose.

Example Function with Union Types

You can call service method with an instance of TypeA, TypeB, or a dictionary that can be converted to an instance of either type.

# Model Definition<a id="model-definition"></a>
ParamType = Union[TypeA, TypeB]

# Service Method<a id="service-method"></a>
def service_method(param: ParamType):
...

## Usage<a id="usage"></a>
type_a = TypeA(key="value")
type_b = TypeB(key="value")

sdk.service.service_method(type_a)
sdk.service.service_method(type_b)
sdk.service.service_method({"key": "value"})

You cannot create an instance of a Union type itself. Instead, pass an instance of one of the types in the Union, or a dictionary that can be converted to one of those types.