Rapyd

https://docs.rapyd.net/en/
Admin
Rapyd is a global FinTech platform that provides businesses with a comprehensive suite of services...
Tokens:1,934,968
Snippets:11,730
Trust Score:9.2
Update:4 months ago
Show doc for...
Tokens:
Raw
### Get Payment Method Required Fields in PHP

Source: https://docs.rapyd.net/en/subscriptions-369196.html

This PHP example demonstrates how to retrieve required fields for a payment method. It includes path setup for a utility file and error handling.

```PHP
<?php
$path = $_SERVER['DOCUMENT_ROOT'];
$path .= "/<path-to-your-utility-file>/utilities.php";
include($path);

try {
    $object = make_request('get', '/v1/payment_methods/sg_fast_bank/required_fields');
    echo $object;
} catch (Exception $e) {
    echo "Error: $e";
}
?>
```

--------------------------------

### Create Product in PHP

Source: https://docs.rapyd.net/en/create-product.html

A PHP example for creating a product. It includes the necessary utility file and demonstrates how to structure the request body.

```PHP
<?php
$path = $_SERVER['DOCUMENT_ROOT'];
$path .= "/<path-to-your-utility-file>/utilities.php";
include($path);

$body = [
  "id" =>  "",
  "name" =>  "Monthly parking",
  "type" =>  "services",
  "active" =>  true,
  "attributes"  => [
    "location",
    "size"
    ],
  "description" =>  "Monthly parking - covered area, compact car",
  "shippable" =>  false,
  "statement_descriptor" =>  "",
  "unit_label" =>  ""
];

try {
    $object = make_request('post', '/v1/products', $body);
    var_dump($object);
} catch(Exception $e) {
    echo "Error: $e";
}
?>
```

--------------------------------

### Create Subscription with Coupon

Source: https://docs.rapyd.net/en/create-subscription-by-hosted-page.html

This example demonstrates how to create a new subscription using a hosted page and apply a coupon code for a discount. It includes essential parameters like customer ID, country, billing type, payment method, subscription items, completion URLs, page expiration, and the coupon code.

```APIDOC
## POST /v1/checkout/subscriptions

### Description
Creates a new subscription for a customer using a hosted payment page and applies a specified coupon.

### Method
POST

### Endpoint
/v1/checkout/subscriptions

### Parameters
#### Request Body
- **customer** (string) - Required - The unique identifier of the customer.
- **country** (string) - Required - The country code (ISO 3166-1 alpha-2) for the subscription.
- **billing** (string) - Required - The billing type, e.g., "pay_automatically".
- **payment_method_** (string) - Required - The token of the payment method to be used for the subscription.
- **subscription_items** (array) - Required - A list of subscription items, each with a `plan` and `quantity`.
  - **plan** (string) - Required - The token of the subscription plan.
  - **quantity** (integer) - Required - The quantity of the plan.
- **complete_payment_url** (string) - Required - The URL to redirect the customer to upon successful payment.
- **error_payment_url** (string) - Required - The URL to redirect the customer to if payment fails.
- **page_expiration** (integer) - Required - The Unix timestamp for when the hosted page will expire.
- **merchant_main_button** (string) - Optional - The text for the main button on the hosted page.
- **coupon** (string) - Optional - The token of the coupon to apply to the subscription.

### Request Example
```json
{
    "customer": "cus_4e25112ac20e144ad073a614dc46934b",
    "country": "IS",
    "billing": "pay_automatically",
    "payment_method_": "card_0ef78a1d5cbd4d84133c8d94b2d34a4f",
    "subscription_items": [
        {
            "plan": "plan_27921a1d4ebeb2db2e6aadf69a0094b1",
            "quantity": 1
        }
    ],
    "complete_payment_url": "https://complete.rapyd.net",
    "error_payment_url": "https://error.rapyd.net",
    "page_expiration": 1795276710,
    "merchant_main_button": "pay",
    "coupon": "coupon_e4ea7af090c212aa2634b6d88a308a80"
}
```

### Response
#### Success Response (200)
- **status** (object) - Contains the status of the operation.
  - **error_code** (string) - The error code if an error occurred.
  - **status** (string) - The status of the operation (e.g., "SUCCESS").
  - **message** (string) - A message describing the operation status.
  - **response_code** (string) - The response code.
  - **operation_id** (string) - A unique identifier for the operation.
- **data** (object) - Contains the details of the created subscription hosted page.
  - **id** (string) - The unique identifier of the hosted page.
  - **status** (string) - The current status of the hosted page (e.g., "NEW").
  - **cancel_url** (string) - The URL to cancel the hosted page.
  - **complete_url** (string) - The URL to complete the hosted page.
  - **language** (string) - The language of the hosted page.
  - **merchant_color** (string) - The primary color for the hosted page.
  - **merchant_logo** (string) - The URL of the merchant's logo.
  - **merchant_website** (string) - The merchant's website URL.
  - **merchant_customer_support** (object) - Contact information for merchant customer support.
    - **url** (string) - Support URL.
    - **email** (string) - Support email address.
    - **phone_number** (string) - Support phone number.
  - **merchant_alias** (string) - The merchant's alias.
  - **merchant_terms** (string) - The URL to the merchant's terms and conditions.

#### Response Example
```json
{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "b20242dc-4147-4300-b701-e5c2fb19a62b"
    },
    "data": {
        "id": "hp_sub_bb61e733db533c95125ab96c24a97cb3",
        "status": "NEW",
        "cancel_url": "https://example1234.net",
        "complete_url": "https://example1234.net",
        "language": "",
        "merchant_color": "323fff",
        "merchant_logo": "",
        "merchant_website": "https://example1234.net",
        "merchant_customer_support": {
            "url": "https://example1234.net",
            "email": "support@example1234.net",
            "phone_number": "121255551213"
        },
        "merchant_alias": "Doc Team",
        "merchant_terms": "https://example1234.net/terms_and_conditions"
    }
}
```
```

--------------------------------

### Get Payout Not Found Example

Source: https://docs.rapyd.net/en/payout-errors.html

This example shows an invalid `payout_id` format for retrieving a payout. Ensure the `payout_id` is correct and belongs to the current environment.

```http
get /v1/payouts/payout_1234
```

```http
get /v1/payouts/payout_60dca835ac0b2c822f76c48641d8bae0
```

--------------------------------

### Create Product Request - Python

Source: https://docs.rapyd.net/en/subscriptions-369196.html

This Python example shows how to define and send a request to create a product using a utility function.

```python
from pprint import pprint

from utilities import make_request

product = {
    "name": "Acme Music Stream",
    "type": "services"
}

results = make_request(method='post',
                       path=f'/v1/products',
                       body=product)
pprint(results)
```

--------------------------------

### Get Payment Method Required Fields Request (JavaScript)

Source: https://docs.rapyd.net/en/card-payment-with-3ds-verification.html

Example of making a GET request to retrieve required fields for a payment method using JavaScript. Requires a 'makeRequest' utility function.

```javascript
const makeRequest = require('<path-to-your-utility-file>/utilities').makeRequest;

async function main() {
  try {
    const result = await makeRequest('GET', '/v1/payment_methods/sg_debit_cup_card/required_fields');

    console.log(result);
  } catch (error) {
    console.error('Error completing request', error);
  }
}
```

--------------------------------

### Get Payment Method Required Fields Request Example

Source: https://docs.rapyd.net/en/bank-transfers.html

This snippet shows the URL for requesting the required fields for a specific payment method, 'mx_spei_bank'. The request is a GET request and does not have a message body.

```http
GET https://sandboxapi.rapyd.net/v1/payment_methods/mx_spei_bank/required_fields
```

--------------------------------

### Create Product Response Example

Source: https://docs.rapyd.net/en/subscriptions-369196.html

This is an example of the response received after successfully creating a product. It includes the product ID, name, and type.

```json
{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "1f5c173f-fc9a-4d11-9fd3-de91419b5ab7"
    },
    "data": {
        "id": "product_3f22f9ef6eb18894e95127e5bb8e0c9d",
        "active": true,
        "attributes": [],
        "created_at": 1668432691,
        "description": "",
        "images": [],
        "metadata": {},
        "name": "Acme Music Stream",
        "package_dimensions": {
            "height": 0,
            "length": 0,
            "weight": 0,
            "width": 0
        },
        "shippable": false,
        "skus": [],
        "statement_descriptor": "",
        "type": "services",
        "unit_label": "",
        "updated_at": 1668432691
    }
}
```

--------------------------------

### Create Plan Request Example

Source: https://docs.rapyd.net/en/subscriptions-369196.html

This is an example of a request to create a new plan for a product. It specifies currency, billing interval, product ID, amount, nickname, and usage type.

```json
{
    "currency": "SGD",
    "interval": "month",
    "product": "product_3f22f9ef6eb18894e95127e5bb8e0c9d",
    "amount": 3,
    "nickname": "Basic Streaming",
    "usage_type": "licensed"
}
```

--------------------------------

### Get Payout Required Fields in .NET Core

Source: https://docs.rapyd.net/en/bank-account-payout.html

This .NET Core example demonstrates how to construct and make a request to get the required fields for a payout. Ensure you have the RapydApiRequestSample.Utilities class available.

```csharp
using System;

namespace RapydApiRequestSample
{
    class Program
    {
        static void Main(string[] args)
        {
            try
            {
                string beneficiaryCountry = "PH";
                string beneficiaryEntityType = "individual";
                string payoutAmount = "10000";
                string payoutCurrency = "PHP";
                string senderCountry = "GB";
                string senderCurrency = "PHP";
                string senderEntityType = "company";

                string result = RapydApiRequestSample.Utilities.MakeRequest("GET", $"/v1/payout_methods/ph_anzbank_bank/required_fields?sender_country={senderCountry}&sender_currency={senderCurrency}&beneficiary_country={beneficiaryCountry}&payout_currency={payoutCurrency}&sender_entity_type={senderEntityType}&beneficiary_entity_type={beneficiaryEntityType}&amount={payoutAmount}");

                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Error completing request: " + e.Message);
            }
        }
    }
}
```

--------------------------------

### Get Payment Method Required Fields in Python

Source: https://docs.rapyd.net/en/subscriptions-369196.html

This Python example shows how to get required fields for a payment method using a utility function. It utilizes f-strings for path formatting and pretty-printing the results.

```Python
from pprint import pprint

from utilities import make_request

payment_method = 'sg_fast_bank'
results = make_request(method='get',
                       path=f'/v1/payment_methods/{payment_method}/required_fields')
pprint(results)

```

--------------------------------

### Create Product Request - .NET Core

Source: https://docs.rapyd.net/en/subscriptions-369196.html

This .NET Core example demonstrates how to serialize and send a request to create a product.

```csharp
using System;
 using System.Text.Json;

 namespace RapydApiRequestSample
 {
    class Program
    {
        static void Main(string[] args)
        {
            try
            {
                var requestObj = new
                {
                    name = "Acme Music Stream",
                    type = "services",
                };

                string request = JsonSerializer.Serialize(requestObj);

                string result = RapydApiRequestSample.Utilities.MakeRequest("POST", "/v1/products", request);

                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Error completing request: " + e.Message);
            }
        }
    }
 }
```

--------------------------------

### Create Product Request - JavaScript

Source: https://docs.rapyd.net/en/subscriptions-369196.html

This JavaScript example shows how to make a POST request to create a product, including the request body.

```javascript
const makeRequest = require('<path-to-your-utility-file>/utilities').makeRequest;

async function main() {
  try {
    const body = {
      name: 'Acme Music Stream',
      type: 'services'
    };
    const result = await makeRequest('POST', '/v1/products', body);

    console.log(result);
  } catch (error) {
    console.error('Error completing request', error);
  }
}
```

--------------------------------

### Get Payment Method Required Fields Request (Python)

Source: https://docs.rapyd.net/en/card-payment-with-3ds-verification.html

Example of making a GET request to retrieve required fields for a payment method using Python. Requires a 'make_request' function from a 'utilities' module.

```python
from pprint import pprint

from utilities import make_request

payment_method = 'sg_debit_cup_card'
results = make_request(method='get', path=f'/v1/payment_methods/{payment_method}/required_fields')
pprint(results)
                    
```

--------------------------------

### Payout Amount Not Within Range Example

Source: https://docs.rapyd.net/en/payout-errors.html

Illustrates an incorrect payout amount that is too low and a correct example that meets the minimum requirement. Use Get Payout Required Fields to determine valid ranges.

```json
{
    "payout_amount": 1.24
}
```

```json
{
    "payout_amount": 1.25
}
```

--------------------------------

### Retrieve Product (PHP)

Source: https://docs.rapyd.net/en/retrieve-product.html

Retrieve product information using PHP. This example assumes a 'utilities.php' file is available in the specified path.

```php
<?php
$path = $_SERVER['DOCUMENT_ROOT'];
$path .= "/<path-to-your-utility-file>/utilities.php";
include($path);

try {
    $object = make_request('get', '/v1/products/product_0d9dc6be69c769560fe913f3b086d8ca');
    var_dump($object);
} catch(Exception $e) {
    echo "Error: $e";
}
?>
```

--------------------------------

### Correct Example for Issuing Virtual Account with Ewallet ID

Source: https://docs.rapyd.net/en/rapyd-error-codes.html

This example demonstrates the correct way to issue a virtual account by including the required `ewallet` ID along with currency and country. The `ewallet` ID should start with 'ewallet_'.

```JSON
{
    "ewallet": "ewallet_b16ab040e51deda7f6a786862bd3fe7b",
    "currency": "USD",
    "country": "US"
}
```

--------------------------------

### Create Product in Python

Source: https://docs.rapyd.net/en/create-product.html

This Python snippet demonstrates creating a product. It defines the product details in a dictionary and uses a `make_request` function.

```Python
product = {
    "id": "",
    "name": "Monthly parking",
    "type": "services",
    "active": True,
    "attributes": [
        "location",
        "size"
    ],
    "description": "Monthly parking - covered area, compact car",
    "metadata": {
        "merchant_defined": True
    },
    "shippable": False,
    "statement_descriptor": "monthly_parking",
    "unit_label": "",
}
result = make_request(method='post', path='/v1/products', body=product)
pprint(result)
```

--------------------------------

### Payment Response with Zero Amount

Source: https://docs.rapyd.net/en/create-payment-600631.html

This is an example of a payment response where the amount is zero, often indicating a successful setup or pre-authorization.

```json
{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "6bdbbf8b-5f47-4168-8c66-91b26ec09ceb"
    },
    "data": {
        "id": "payment_cb4a7902384f510151e849d5b623ba61",
        "amount": 0,
        "original_amount": 3600,
        "is_partial": false,

```

--------------------------------

### Create Customer with Address

Source: https://docs.rapyd.net/en/create-customer.html

This example shows how to create a customer and include their address details in the request.

```APIDOC
## POST /v1/customers

### Description
Creates a new customer, including their address information.

### Method
POST

### Endpoint
/v1/customers

### Parameters
#### Request Body
- **name** (string) - Required - The name of the customer.
- **email** (string) - Required - The email address of the customer.
- **payment_method** (object) - Required - Details of the payment method.
  - **type** (string) - Required - The type of payment method (e.g., 'sg_fast_bank').
  - **fields** (object) - Required - Fields specific to the payment method type.
- **addresses** (array) - Optional - A list of addresses for the customer.
  - **name** (string) - Required - Name associated with the address.
  - **line_1** (string) - Required - First line of the address.
  - **city** (string) - Required - City.
  - **country** (string) - Required - Country code (e.g., 'US').
  - **zip** (string) - Required - Postal or ZIP code.
  - **phone_number** (string) - Optional - Phone number associated with the address.

### Request Example
```json
{
    "name": "John Doe",
    "email": "johndoe@rapyd.net",
    "payment_method": {
        "type": "sg_fast_bank",
        "fields": {}
    },
    "addresses": [
        {
            "name": "John Doe",
            "line_1": "123 First Street",
            "city": "Anytown",
            "country": "US",
            "zip": "12345",
            "phone_number": "+19175551234"
        }
    ]
}
```

### Response
#### Success Response (200)
- **status** (object) - Response status details.
- **data** (object) - Customer creation details.
  - **id** (string) - The unique identifier for the created customer.
  - **name** (string) - The name of the customer.
  - **email** (string) - The email of the customer.
  - **addresses** (array) - List of addresses associated with the customer.
    - **id** (string) - The unique identifier for the address.
    - **name** (string) - Name associated with the address.
    - **line_1** (string) - First line of the address.
    - **city** (string) - City.
    - **country** (string) - Country code.
    - **zip** (string) - Postal or ZIP code.
    - **phone_number** (string) - Phone number.

#### Response Example
```json
{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "234f7103-680d-4e3e-8ff6-20ef39624962"
    },
    "data": {
        "id": "cus_7aa97a3e2630b19a26b3fcb59fc9c4f8",
        "delinquent": false,
        "discount": null,
        "name": "John Doe",
        "default_payment_method": "other_acf7bb3d7871998830c2e2d1d65f6639",
        "description": "",
        "email": "johndoe@rapyd.net",
        "phone_number": "",
        "invoice_prefix": "",
        "addresses": [
            {
                "id": "address_f87d65d9f9d58f7464b11a8a1ec89e3a",
                "name": "John Doe",
                "line_1": "123 First Street",
                "city": "Anytown",
                "country": "US",
                "zip": "12345",
                "phone_number": "+19175551234"
            }
        ]
    }
}
```
```

--------------------------------

### Get Payout Required Fields in .NET Core

Source: https://docs.rapyd.net/en/reusing-beneficiary-or-sender.html

This .NET Core example shows how to construct and make a GET request to the Rapyd API to fetch required fields for a payout method. Ensure you have the 'Utilities' class available for making the API call.

```csharp
using System;

namespace RapydApiRequestSample
{
    class Program
    {
        static void Main(string[] args)
        {
            try
            {
                string payoutMethodType = "ph_anzbank_bank";
                string senderCountry = "GB";
                string senderCurrency = "PHP";
                string beneficiaryCountry = "PH";
                string payoutCurrency = "PHP";
                string senderEntityType = "company";
                string beneficiaryEntityType = "individual";
                string payoutAmount = "10000";

                string result = RapydApiRequestSample.Utilities.MakeRequest("GET", $"/v1/payout_methods/{payoutMethodType}/required_fields?sender_country={senderCountry}&sender_currency={senderCurrency}&beneficiary_country={beneficiaryCountry}&payout_currency={payoutCurrency}&sender_entity_type={senderEntityType}&beneficiary_entity_type={beneficiaryEntityType}&payout_amount={payoutAmount}");

                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Error completing request: " + e.Message);
            }
        }
    }
}
```

--------------------------------

### Create Subscription Request Example

Source: https://docs.rapyd.net/en/create-subscription.html

This is an example of a successful request to create a subscription. Ensure all required headers and the correct JSON payload are used.

```json
{
    "customer": "cus_4e25112ac20e144ad073a614dc46934b",
    "billing": "pay_automatically",
    "subscription_items": [
        {
            "plan": "plan_390625a173f599153b5250715d861718",
            "quantity": 1
        }
    ]
}
```

--------------------------------

### SKU Response Parameters Example

Source: https://docs.rapyd.net/en/create-sku.html

Example of the response parameters returned after successfully creating an SKU.

```json
{
    "active": true,
    "attributes": {
        "size": 12,
        "color": "red",
        "arm_rest": true
    },
    "created_at": 1678886400,
    "currency": "USD",
    "id": "sku_12345",
    "image": "https://example.com/image.jpg",
    "inventory": {
        "quantity": 100,
        "type": "finite"
    },
    "price": 25.99,
    "product": "prod_abcde",
    "size": "large",
    "updated_at": 1678886400
}
```

--------------------------------

### Get Payment Method Required Fields in .NET Core

Source: https://docs.rapyd.net/en/card-payments.html

This .NET Core example demonstrates how to make a GET request to the Rapyd API to fetch the required fields for a GB Visa card. Ensure you have a utility function `MakeRequest` available.

```.NET Core
using System;

namespace RapydApiRequestSample
{
    class Program
    {
        static void Main(string[] args)
        {
            try
            {
                string result = RapydApiRequestSample.Utilities.MakeRequest("GET", "/v1/payment_methods/gb_visa_card/required_fields");

                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Error completing request: " + e.Message);
            }
        }
    }
}
```

--------------------------------

### Get Refund Response Structure

Source: https://docs.rapyd.net/en/refunds-369210.html

This is an example of the JSON response received after a refund request is processed. It includes details about the refund status and amount.

```json
{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "bc321df9-7bb4-47ce-907a-7bbc5a9b32f7"
    },
    "data": {
        "id": "refund_dcdacdb591a117d3d5eb30e59011aadd",
        "amount": 15.65,
        "payment": "payment_29816514741fe7e4cdee75f7093ccbe1",
        "currency": "USD",
        "failure_reason": "",
        "metadata": {},
        "reason": "",
        "status": "Completed",
        "receipt_number": 0,
        "created_at": 1589302965,
        "updated_at": 1589302965,
        "merchant_reference_id": "",
        "payment_created_at": 1589237080,
        "payment_method_type": "us_debit_visa_card",
        "ewallets": [
            {
                "ewallet": "ewallet_be4ba8f13da40caa59a7e03022a8acfe",
                "amount": 15.65
            }
        ],
        "proportional_refund": true
    }
}
```

--------------------------------

### Create Plan Response Example

Source: https://docs.rapyd.net/en/subscriptions-369196.html

This is an example of the JSON response received after successfully creating a subscription plan with Rapyd. It includes details about the plan's ID, pricing, and associated product.

```json
{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "935d04de-51b9-4869-a68c-76692ce5387a"
    },
    "data": {
        "id": "plan_5487c8a5be1dd847de7da4ce8feebfab",
        "aggregate_usage": "sum",
        "amount": 3,
        "billing_scheme": "per_unit",
        "created_at": 1668432810,
        "currency": "SGD",
        "interval": "month",
        "interval_count": 1,
        "metadata": {},
        "product": {
            "id": "product_3f22f9ef6eb18894e95127e5bb8e0c9d",
            "active": true,
            "attributes": [],
            "created_at": 1668432691,
            "description": "",
            "images": [],
            "metadata": {},
            "name": "Acme Music Stream",
            "package_dimensions": {
                "height": 0,
                "length": 0,
                "weight": 0,
                "width": 0
            },
            "shippable": false,
            "skus": [],
            "statement_descriptor": "",
            "type": "services",
            "unit_label": "",
            "updated_at": 1668432691
        },
        "nickname": "Basic Streaming",
        "tiers": [],
        "tiers_mode": "",
        "transform_usage": {
            "divide_by": 1,
            "round": "up"
        },
        "trial_period_days": 0,
        "usage_type": "licensed"
    }
}
```

--------------------------------

### Correct Get Beneficiary Request

Source: https://docs.rapyd.net/en/beneficiary-errors.html

This example demonstrates how to correctly retrieve a beneficiary using its ID. Ensure the beneficiary ID is valid and exists.

```http
get /v1/payouts/beneficiary/beneficiary_cb009f46c8dcd85004c8054541287723
```
Tokens:
Raw