Skip to content

Latest commit

 

History

History
299 lines (222 loc) · 18.8 KB

VirtualAccountsService.md

File metadata and controls

299 lines (222 loc) · 18.8 KB

VirtualAccountsService

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

Methods Description
create_virtual_account Issue a virtual account number to an existing wallet.
simulate_bank_transfer_to_virtual_account Simulate a deposit to a virtual account number that was issued to a wallet. This method is relevant only for testing in the sandbox. The currency of the transfer must be supported by the specific virtual account. This method triggers the Deposit Completed webhook.
retrieve_virtual_account Retrieve a Virtual Account Number object for a wallet.
update_requested_currency Define, change, or cancel the currency to which funds received by a virtual account are converted.<BR>The status of the virtual account must be ACT (active) or PEN (pending).<BR>To cancel a previously defined currency conversion, set requested_currency to null.<BR> Prerequisites:<BR>_ Create Wallet<BR>_ Verify Identity<BR> * Issue Virtual Account to Wallet
close_issuing Delete a virtual account number of an existing wallet. In order to close a virtual account its status must be ACT.
capabilities_of_virtual_accounts Retrieve a list of the capabilities of virtual accounts you can issue to a Rapyd Wallet.<BR> The list is filtered by country.

create_virtual_account

Issue a virtual account number to an existing wallet.

  • HTTP Method: POST
  • Endpoint: /v1/virtual_accounts

Parameters

Name Type Required Description
request_body V1VirtualAccountsBody ✅ 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_90

Example Usage Code Snippet

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

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

request_body = V1VirtualAccountsBody(
    country="country",
    currency="currency",
    description="description",
    ewallet="ewallet",
    merchant_reference_id="merchant_reference_id",
    metadata={},
    requested_currency="requested_currency"
)

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

print(result)

simulate_bank_transfer_to_virtual_account

Simulate a deposit to a virtual account number that was issued to a wallet. This method is relevant only for testing in the sandbox. The currency of the transfer must be supported by the specific virtual account. This method triggers the Deposit Completed webhook.

  • HTTP Method: POST
  • Endpoint: /v1/virtual_accounts/transactions

Parameters

Name Type Required Description
request_body VirtualAccountsTransactionsBody ✅ 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_91

Example Usage Code Snippet

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

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

request_body = VirtualAccountsTransactionsBody(
    amount="amount",
    currency="currency",
    issued_bank_account="issued_bank_account"
)

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

print(result)

retrieve_virtual_account

Retrieve a Virtual Account Number object for a wallet.

  • HTTP Method: GET
  • Endpoint: /v1/virtual_accounts/{virtualAccountId}

Parameters

Name Type Required Description
virtual_account_id str ✅ ID of the Virtual Account Number object. String starting with issuing_.

Return Type

InlineResponse200_92

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment

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

result = sdk.virtual_accounts.retrieve_virtual_account(virtual_account_id="virtualAccountId")

print(result)

update_requested_currency

Define, change, or cancel the currency to which funds received by a virtual account are converted.<BR>The status of the virtual account must be ACT (active) or PEN (pending).<BR>To cancel a previously defined currency conversion, set requested_currency to null.<BR> Prerequisites:<BR>_ Create Wallet<BR>_ Verify Identity<BR> * Issue Virtual Account to Wallet

  • HTTP Method: POST
  • Endpoint: /v1/virtual_accounts/{virtualAccountId}

Parameters

Name Type Required Description
request_body VirtualAccountsVirtualAccountIdBody ❌ The request body.
virtual_account_id str ✅ ID of the Virtual Account Number object. String starting with issuing_.
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_93

Example Usage Code Snippet

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

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

request_body = VirtualAccountsVirtualAccountIdBody(
    requesting_currency="SVC"
)

result = sdk.virtual_accounts.update_requested_currency(
    request_body=request_body,
    virtual_account_id="virtualAccountId",
    access_key="access_key",
    content_type="Content-Type",
    salt="salt",
    signature="signature",
    timestamp="timestamp",
    idempotency="idempotency"
)

print(result)

close_issuing

Delete a virtual account number of an existing wallet. In order to close a virtual account its status must be ACT.

  • HTTP Method: DELETE
  • Endpoint: /v1/virtual_accounts/{virtualAccountId}

Parameters

Name Type Required Description
virtual_account_id str ✅ ID of the virtual account. String starting with issuing_.
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_94

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment

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

result = sdk.virtual_accounts.close_issuing(
    virtual_account_id="virtualAccountId",
    access_key="access_key",
    content_type="Content-Type",
    salt="salt",
    signature="signature",
    timestamp="timestamp",
    idempotency="idempotency"
)

print(result)

capabilities_of_virtual_accounts

Retrieve a list of the capabilities of virtual accounts you can issue to a Rapyd Wallet.<BR> The list is filtered by country.

  • HTTP Method: GET
  • Endpoint: /v1/virtual_accounts/capabilities/{country}

Parameters

Name Type Required Description
country str ✅ Two-letter ISO 3166-1 ALPHA-2 code of the country.
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_95

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment

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

result = sdk.virtual_accounts.capabilities_of_virtual_accounts(
    country="country",
    access_key="access_key",
    content_type="Content-Type",
    salt="salt",
    signature="signature",
    timestamp="timestamp",
    idempotency="idempotency"
)

print(result)