Skip to main content

Documentation

Create Checkout Page

Create a checkout page that makes a payment.

This method can be used by all clients without the need for PCI certification.

After the customer submits the information on the hosted page, Rapyd processes the request and sends you one or more webhooks, depending on the payment method and parameters of the request. See Create Payment. The Payment Succeeded Webhook is sent when the customer successfully submits the information on the hosted page.

Note

  • If you create the checkout page specifying the customer field, only the customer’s default payment method appears on the checkout page.

  • The amount must be specified in either amount or the amount field of each item in the cart.

  • If the payment method type is Google Pay, the customer must open the checkout page in a single browser window. On an Apple device, the customer must use Safari.

  • To enable account funding transactions, contact Rapyd Client Support.

Code Samples
    • .NET

      • using System;
        using System.Text.Json;
        
        namespace RapydApiRequestSample
        {
            class Program
            {
                static void Main(string[] args)
                {
                    try
                    {
                        var requestObj = new
                        {
                            currency = "USD",
                            customer = "cus_b3b8ad0174f4c415c663b35bcf542192",
                            metadata = new
                            {
                                merchant_defined = true
                            },
                            amount = 10
                        };
        
                        string request = JsonSerializer.Serialize(requestObj);
                        string result = RapydApiRequestSample.Utilities.MakeRequest("POST", "/v1/checkout", request);
                        Console.WriteLine(result);
                    }
                    catch (Exception e)
                    {
                        Console.WriteLine("Error completing request: " + e.Message);
                    }
                }
            }
        }
        
    • JavaScript

      • const makeRequest = require('<path-to-your-utility-file>/utilities').makeRequest;
        
        async function main() {
          try {
            const body = {
              currency: 'USD',
              customer: 'cus_b3b8ad0174f4c415c663b35bcf542192',
              metadata: {
                merchant_defined: true
              },
              amount: 10
            };
            const result = await makeRequest('POST', '/v1/checkout', body);
        
            console.log(result);
          } catch (error) {
            console.error('Error completing request', error);
          }
        }
        
    • PHP

      • <?php
        $path .= "/<path-to-your-utility-file>/utilities.php";
        $body = [
          "currency" => "USD"
          "customer" => "cus_b3b8ad0174f4c415c663b35bcf542192",
          "amount" => 10   
        ];
        
        try {
            $object = make_request('post', '/v1/checkout', $body);
            var_dump($object);
        } catch(Exception $e) {
            echo "Error => $e";
        }
        ?>
    • Python

      • from pprint import pprint
        
        from utilities import make_request
        
        checkout_page = {
            "amount": 100,
            "complete_payment_url": "http://example.com/complete",
            "country": "SG",
            "currency": "SGD",
            "customer": "cus_9761efaa881b6edeab25e9fbfec1ddf5",
            "error_payment_url": "http://example.com/error",
            "merchant_reference_id": "0912-2021",
            "language": "en",
            "metadata": {
                "merchant_defined": True
            },
            "expiration": 1632027189,
            "payment_method_types_include": [
                "sg_grabpay_ewallet"
            ]
        }
        result = make_request(method='post', path='/v1/checkout', body=checkout_page)
        pprint(result)
  • /v1/checkout

  • Create Checkout Page for customer

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "amount": 100,
        "complete_payment_url": "http://example.com/complete",
        "country": "SG",
        "currency": "SGD",
        "customer": "cus_9761efaa881b6edeab25e9fbfec1ddf5",
        "error_payment_url": "http://example.com/error",
        "merchant_reference_id": "0912-2021",
        "language": "en",
        "metadata": {
            "merchant_defined": true
        },
        "payment_method_types_include": [
            "sg_grabpay_ewallet"
        ],
        "expiration": 1632027189
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "b8f3e180-c7ea-4ac3-86f1-c47d93117cce"
        },
        "data": {
            "id": "checkout_b1284339d1dd677c8163bcea1c9cfcf2",
            "status": "NEW",
            "language": "en",
            "merchant_color": "323fff",
            "merchant_logo": null,
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {},
            "merchant_alias": "Rapyd",
            "merchant_terms": null,
            "merchant_privacy_policy": null,
            "page_expiration": 1632645328,
            "redirect_url": "https://sandboxcheckout.rapyd.net?token=checkout_b1284339d1dd677c8163bcea1c9cfcf2",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "https://rapyd.net",
            "complete_checkout_url": "https://rapyd.net",
            "country": "SG",
            "currency": "SGD",
            "amount": 100,
            "payment": {
                "id": null,
                "amount": 100,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "SGD",
                "country_code": "SG",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": "0912-2021",
                "customer_token": "cus_9761efaa881b6edeab25e9fbfec1ddf5",
                "payment_method_data": {},
                "expiration": 1632027189,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": "http://example.com/complete",
                "error_payment_url": "http://example.com/error",
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": {
                    "merchant_defined": true
                },
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": null,
                "merchant_requested_currency": null,
                "merchant_requested_amount": null,
                "fixed_side": null,
                "payment_fees": null,
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": null,
            "payment_method_type_categories": null,
            "payment_method_types_include": [
                "sg_grabpay_ewallet"
            ],
            "payment_method_types_exclude": null,
            "customer": "cus_9761efaa881b6edeab25e9fbfec1ddf5",
            "custom_elements": {
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": false
            },
            "timestamp": 1631435728,
            "payment_expiration": null,
            "cart_items": [],
            "escrow": null,
            "escrow_release_days": null
        }
    }
  • Create Checkout Page for guest

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "amount": 123.45,
        "complete_payment_url": "http://example.com/complete",
        "country": "SG",
        "currency": "SGD",
        "error_payment_url": "http://example.com/error",
        "merchant_reference_id": "0912-2021",
        "language": "en",
        "metadata": {
            "merchant_defined": true
        },
        "payment_method_types_include": [
            "sg_grabpay_ewallet"
        ],
        "expiration": 1632027189
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "4482961e-7732-49dc-8d0a-2c79491210a3"
        },
        "data": {
            "id": "checkout_408606a46b1e1e60507a2b2fc578143c",
            "status": "NEW",
            "language": "en",
            "merchant_color": "323fff",
            "merchant_logo": null,
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {},
            "merchant_alias": "Rapyd",
            "merchant_terms": null,
            "merchant_privacy_policy": null,
            "page_expiration": 1632643036,
            "redirect_url": "https://sandboxcheckout.rapyd.net?token=checkout_408606a46b1e1e60507a2b2fc578143c",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "https://rapyd.net",
            "complete_checkout_url": "https://rapyd.net",
            "country": "SG",
            "currency": "SGD",
            "amount": 123.45,
            "payment": {
                "id": null,
                "amount": 123.45,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "SGD",
                "country_code": "SG",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": "0912-2021",
                "customer_token": null,
                "payment_method_data": {},
                "expiration": 1632027189,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": "http://example.com/complete",
                "error_payment_url": "http://example.com/error",
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": {
                    "merchant_defined": true
                },
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": null,
                "merchant_requested_currency": null,
                "merchant_requested_amount": null,
                "fixed_side": null,
                "payment_fees": null,
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": null,
            "payment_method_type_categories": null,
            "payment_method_types_include": [
                "sg_grabpay_ewallet"
            ],
            "payment_method_types_exclude": null,
            "customer": null,
            "custom_elements": {
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": false
            },
            "timestamp": 1631433436,
            "payment_expiration": null,
            "cart_items": [],
            "escrow": null,
            "escrow_release_days": null
        }
    }
  • Create Checkout Page using categories

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "amount": 100,
        "complete_payment_url": "http://example.com/complete",
        "country": "SG",
        "currency": "SGD",
        "error_payment_url": "http://example.com/error",
        "merchant_reference_id": "0912-2021",
        "language": "en",
        "metadata": {
            "merchant_defined": true
        },
        "payment_method_type_categories": [
            "card",
            "cash"
        ]
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "b8c00798-8b17-4b8b-8d93-d8fc487eba2b"
        },
        "data": {
            "id": "checkout_bf9648075ed09a2b793e288e659df17d",
            "status": "NEW",
            "language": "en",
            "merchant_color": "323fff",
            "merchant_logo": null,
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {},
            "merchant_alias": "Rapyd",
            "merchant_terms": null,
            "merchant_privacy_policy": null,
            "page_expiration": 1632645913,
            "redirect_url": "https://sandboxcheckout.rapyd.net?token=checkout_bf9648075ed09a2b793e288e659df17d",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "https://rapyd.net",
            "complete_checkout_url": "https://rapyd.net",
            "country": "SG",
            "currency": "SGD",
            "amount": 100,
            "payment": {
                "id": null,
                "amount": 100,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "SGD",
                "country_code": "SG",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": "0912-2021",
                "customer_token": null,
                "payment_method_data": {},
                "expiration": 0,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": "http://example.com/complete",
                "error_payment_url": "http://example.com/error",
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": {
                    "merchant_defined": true
                },
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": null,
                "merchant_requested_currency": null,
                "merchant_requested_amount": null,
                "fixed_side": null,
                "payment_fees": null,
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": null,
            "payment_method_type_categories": [
                "card",
                "cash"
            ],
            "payment_method_types_include": null,
            "payment_method_types_exclude": null,
            "customer": null,
            "custom_elements": {
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": false
            },
            "timestamp": 1631436313,
            "payment_expiration": null,
            "cart_items": [],
            "escrow": null,
            "escrow_release_days": null
        }
    }
  • Create Checkout Page with additional fees

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "amount": 128.45,
        "complete_payment_url": "http://example.net/complete",
        "country": "SG",
        "currency": "SGD",
        "error_payment_url": "http://example.net/error",
        "merchant_reference_id": "0912-2021",
        "language": "en",
        "requested_currency": "USD",
        "metadata": {
            "merchant_defined": true
        },
        "payment_method_type_categories": [
            "card"
        ],
        "payment_fees": {
            "transaction_fee": {
                "calc_type": "gross",
                "value": 10,
                "fee_type": "percentage"
            },
            "fx_fee": {
                "calc_type": "gross",
                "value": 2
            }
        }
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "b01d9001-e17a-4af7-b868-8d9bd83534ad"
        },
        "data": {
            "id": "checkout_46a632d38fe469a2962e7bd6b637baff",
            "status": "NEW",
            "language": "en",
            "merchant_color": "323fff",
            "merchant_logo": null,
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {},
            "merchant_alias": "Rapyd",
            "merchant_terms": null,
            "merchant_privacy_policy": null,
            "page_expiration": 1632646186,
            "redirect_url": "https://sandboxcheckout.rapyd.net?token=checkout_46a632d38fe469a2962e7bd6b637baff",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "https://rapyd.net",
            "complete_checkout_url": "https://rapyd.net",
            "country": "SG",
            "currency": "SGD",
            "amount": 128.45,
            "payment": {
                "id": null,
                "amount": 128.45,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "SGD",
                "country_code": "SG",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": "0912-2021",
                "customer_token": null,
                "payment_method_data": {},
                "expiration": 0,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": "http://example.net/complete",
                "error_payment_url": "http://example.net/error",
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": {
                    "merchant_defined": true
                },
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": 1.301492,
                "merchant_requested_currency": "USD",
                "merchant_requested_amount": 110.53,
                "fixed_side": "buy",
                "payment_fees": {
                    "fx_fee": {
                        "value": 2,
                        "calc_type": "gross"
                    },
                    "net_fees": null,
                    "gross_fees": null,
                    "transaction_fee": {
                        "value": 10,
                        "fee_type": "percentage",
                        "calc_type": "gross"
                    }
                },
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": null,
            "payment_method_type_categories": [
                "card"
            ],
            "payment_method_types_include": null,
            "payment_method_types_exclude": null,
            "customer": null,
            "custom_elements": {
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": false
            },
            "timestamp": 1631436586,
            "payment_expiration": null,
            "cart_items": [],
            "escrow": null,
            "escrow_release_days": null
        }
    }
  • Create Checkout Page with Complete and Cancel URLs

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "amount": 223.48,
        "complete_payment_url": "http://example.net/complete",
        "complete_checkout_url": "http://example.net/complete_checkout",
        "cancel_checkout_url": "http://example.net/cancel_checkout",
        "country": "SG",
        "currency": "SGD",
        "error_payment_url": "http://example.net/error",
        "merchant_reference_id": "0912-2021",
        "language": "en",
        "metadata": {
            "merchant_defined": true
        },
        "payment_method_type_categories": [
            "card"
        ]
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "8fc0771e-f522-4b13-8ef2-90eddb075e2b"
        },
        "data": {
            "id": "checkout_38294f69e0b783fce134d9a1060beab2",
            "status": "NEW",
            "language": "en",
            "merchant_color": "323fff",
            "merchant_logo": null,
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {},
            "merchant_alias": "Rapyd",
            "merchant_terms": null,
            "merchant_privacy_policy": null,
            "page_expiration": 1632647945,
            "redirect_url": "https://sandboxcheckout.rapyd.net?token=checkout_38294f69e0b783fce134d9a1060beab2",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "http://example.net/cancel_checkout",
            "complete_checkout_url": "http://example.net/complete_checkout",
            "country": "SG",
            "currency": "SGD",
            "amount": 223.48,
            "payment": {
                "id": null,
                "amount": 223.48,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "SGD",
                "country_code": "SG",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": "0912-2021",
                "customer_token": null,
                "payment_method_data": {},
                "expiration": 0,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": "http://example.net/complete",
                "error_payment_url": "http://example.net/error",
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": {
                    "merchant_defined": true
                },
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": null,
                "merchant_requested_currency": null,
                "merchant_requested_amount": null,
                "fixed_side": null,
                "payment_fees": null,
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": null,
            "payment_method_type_categories": [
                "card"
            ],
            "payment_method_types_include": null,
            "payment_method_types_exclude": null,
            "customer": null,
            "custom_elements": {
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": false
            },
            "timestamp": 1631438345,
            "payment_expiration": null,
            "cart_items": [],
            "escrow": null,
            "escrow_release_days": null
        }
    }s
  • Create Checkout Page with custom elements

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "amount": 127.95,
        "complete_payment_url": "http://example.com/complete",
        "country": "SG",
        "currency": "SGD",
        "error_payment_url": "http://example.com/error",
        "merchant_reference_id": "0912-2021",
        "language": "en",
        "metadata": {
            "merchant_defined": true
        },
        "custom_elements": {
            "billing_address_collect": true,
            "cardholder_name": "John Doe"
        }
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "032d687c-c6f7-47af-b6d1-d7ce178d4d4a"
        },
        "data": {
            "id": "checkout_fd7dbfb7fb8bcfe0414de4222a12cf3f",
            "status": "NEW",
            "language": "en",
            "merchant_color": "323fff",
            "merchant_logo": null,
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {},
            "merchant_alias": "Doc Team",
            "merchant_terms": null,
            "merchant_privacy_policy": null,
            "page_expiration": 1657546131,
            "redirect_url": "https://sandboxcheckout.rapyd.net?token=checkout_fd7dbfb7fb8bcfe0414de4222a12cf3f",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "https://rapyd.net",
            "complete_checkout_url": "https://rapyd.net",
            "country": "SG",
            "currency": "SGD",
            "amount": 127.95,
            "payment": {
                "id": null,
                "amount": 127.95,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "SGD",
                "country_code": "SG",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": "0912-2021",
                "customer_token": null,
                "payment_method": null,
                "payment_method_data": {},
                "expiration": 0,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": "http://example.com/complete",
                "error_payment_url": "http://example.com/error",
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": {
                    "merchant_defined": true
                },
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": null,
                "merchant_requested_currency": null,
                "merchant_requested_amount": null,
                "fixed_side": null,
                "payment_fees": null,
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": null,
            "payment_method_type_categories": null,
            "payment_method_types_include": null,
            "payment_method_types_exclude": null,
            "customer": null,
            "custom_elements": {
                "cardholder_name": "John Doe",
              	"save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": true,
                "dynamic_currency_conversion": false
            },
            "timestamp": 1656336531,
            "payment_expiration": null,
            "cart_items": [],
            "escrow": null,
            "escrow_release_days": null
        }
    }
  • Create Checkout Page with cart items

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "complete_payment_url": "http://example.com/complete",
        "country": "SG",
        "currency": "SGD",
        "customer": "cus_9761efaa881b6edeab25e9fbfec1ddf5",
        "error_payment_url": "http://example.com/error",
        "merchant_reference_id": "0912-2021",
        "language": "en",
        "metadata": {
            "merchant_defined": true
        },
        "payment_method_types_include": [
            "sg_grabpay_ewallet"
        ],
        "expiration": 1632027189,
        "cart_items": [
            {
                "name": "Bluetooth speaker model SJ-8097",
                "amount": 120.00,
                "quantity": 2
            },
            {
                "name": "Pack of rechargeable batteries model 90-P",
                "amount": 3.45,
                "quantity": 1
            }
        ]
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "b5a58241-2b77-4b79-b453-c9b380721653"
        },
        "data": {
            "id": "checkout_01ba616956f2bd23eb07d0cd9a8a9e67",
            "status": "NEW",
            "language": "en",
            "merchant_color": "323fff",
            "merchant_logo": null,
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {},
            "merchant_alias": "Rapyd",
            "merchant_terms": null,
            "merchant_privacy_policy": null,
            "page_expiration": 1632648394,
            "redirect_url": "https://sandboxcheckout.rapyd.net?token=checkout_01ba616956f2bd23eb07d0cd9a8a9e67",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "https://rapyd.net",
            "complete_checkout_url": "https://rapyd.net",
            "country": "SG",
            "currency": "SGD",
            "amount": 243.45,
            "payment": {
                "id": null,
                "amount": 243.45,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "SGD",
                "country_code": "SG",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": "0912-2021",
                "customer_token": "cus_9761efaa881b6edeab25e9fbfec1ddf5",
                "payment_method_data": {},
                "expiration": 1632027189,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": "http://example.com/complete",
                "error_payment_url": "http://example.com/error",
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": {
                    "merchant_defined": true
                },
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": null,
                "merchant_requested_currency": null,
                "merchant_requested_amount": null,
                "fixed_side": null,
                "payment_fees": null,
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": null,
            "payment_method_type_categories": null,
            "payment_method_types_include": [
                "sg_grabpay_ewallet"
            ],
            "payment_method_types_exclude": null,
            "customer": "cus_9761efaa881b6edeab25e9fbfec1ddf5",
            "custom_elements": {
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": false
            },
            "timestamp": 1631438795,
            "payment_expiration": null,
            "cart_items": [
                {
                    "name": "Bluetooth speaker model SJ-8097",
                    "amount": 120,
                    "quantity": 2,
                    "image": null
                },
                {
                    "name": "Pack of rechargeable batteries model 90-P",
                    "amount": 3.45,
                    "quantity": 1,
                    "image": null
                }
            ],
            "escrow": null,
            "escrow_release_days": null
        }
    }
  • Create Checkout Page with FX - fixed side buy

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "amount": 100,
        "complete_payment_url": "http://example.com/complete",
        "country": "SG",
        "currency": "SGD",
        "error_payment_url": "http://example.com/error",
        "merchant_reference_id": "0912-2021",
        "language": "en",
        "requested_currency": "USD",
        "fixed_side": "buy",
        "metadata": {
            "merchant_defined": true
        }
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "c22d5662-08fc-4192-b035-06a54af5e82f"
        },
        "data": {
            "id": "checkout_0b84fee952f2c488364a5c1397a67054",
            "status": "NEW",
            "language": "en",
            "merchant_color": "323fff",
            "merchant_logo": null,
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {},
            "merchant_alias": "Rapyd",
            "merchant_terms": null,
            "merchant_privacy_policy": null,
            "page_expiration": 1632653516,
            "redirect_url": "https://sandboxcheckout.rapyd.net?token=checkout_0b84fee952f2c488364a5c1397a67054",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "https://rapyd.net",
            "complete_checkout_url": "https://rapyd.net",
            "country": "SG",
            "currency": "SGD",
            "amount": 100,
            "payment": {
                "id": null,
                "amount": 100,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "SGD",
                "country_code": "SG",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": "0912-2021",
                "customer_token": null,
                "payment_method_data": {},
                "expiration": 0,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": "http://example.com/complete",
                "error_payment_url": "http://example.com/error",
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": {
                    "merchant_defined": true
                },
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": 1.301492,
                "merchant_requested_currency": "USD",
                "merchant_requested_amount": 76.83,
                "fixed_side": "buy",
                "payment_fees": null,
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": null,
            "payment_method_type_categories": null,
            "payment_method_types_include": null,
            "payment_method_types_exclude": null,
            "customer": null,
            "custom_elements": {
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": false
            },
            "timestamp": 1631443916,
            "payment_expiration": null,
            "cart_items": [],
            "escrow": null,
            "escrow_release_days": null
        }
    }
  • Create Checkout Page with dynamic currency conversion

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "amount": 123.45,
        "complete_payment_url": "http://example.com/complete",
        "country": "SG",
        "currency": "SGD",
        "requested_currency": "USD",
        "error_payment_url": "http://example.com/error",
        "merchant_reference_id": "0912-2021",
        "language": "en",
        "metadata": {
            "merchant_defined": true
        },
        "payment_method_type_categories": [
            "card"
        ],
        "custom_elements": {
            "dynamic_currency_conversion": true
        }
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "5c49bd5b-2183-4478-aeb3-3ed35aad434d"
        },
        "data": {
            "id": "checkout_05d0cd0426f3aeee744ad389606237ce",
            "status": "NEW",
            "language": "en",
            "merchant_color": "323fff",
            "merchant_logo": null,
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {},
            "merchant_alias": "Rapyd",
            "merchant_terms": null,
            "merchant_privacy_policy": null,
            "page_expiration": 1632653843,
            "redirect_url": "https://sandboxcheckout.rapyd.net?token=checkout_05d0cd0426f3aeee744ad389606237ce",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "https://rapyd.net",
            "complete_checkout_url": "https://rapyd.net",
            "country": "SG",
            "currency": "SGD",
            "amount": 123.45,
            "payment": {
                "id": null,
                "amount": 123.45,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "SGD",
                "country_code": "SG",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": "0912-2021",
                "customer_token": null,
                "payment_method_data": {},
                "expiration": 0,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": "http://example.com/complete",
                "error_payment_url": "http://example.com/error",
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": {
                    "merchant_defined": true
                },
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": 1.301492,
                "merchant_requested_currency": "USD",
                "merchant_requested_amount": 94.85,
                "fixed_side": "buy",
                "payment_fees": null,
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": null,
            "payment_method_type_categories": [
                "card"
            ],
            "payment_method_types_include": null,
            "payment_method_types_exclude": null,
            "customer": null,
            "custom_elements": {
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": true
            },
            "timestamp": 1631444243,
            "payment_expiration": null,
            "cart_items": [],
            "escrow": null,
            "escrow_release_days": null
        }
    }
  • Create Checkout Page using payment method type

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "amount": 100,
        "complete_payment_url": "http://example.com/complete",
        "country": "SG",
        "currency": "SGD",
        "customer": "cus_9761efaa881b6edeab25e9fbfec1ddf5",
        "error_payment_url": "http://example.com/error",
        "merchant_reference_id": "0912-2021",
        "language": "en",
        "metadata": {
            "merchant_defined": true
        },
        "payment_method_type": "sg_grabpay_ewallet"
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "9925fcbc-1be5-4ebd-a676-c1919ed93ee7"
        },
        "data": {
            "id": "checkout_f01e66e29d482641026fc73756364f45",
            "status": "NEW",
            "language": "en",
            "merchant_color": "323fff",
            "merchant_logo": null,
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {},
            "merchant_alias": "Rapyd",
            "merchant_terms": null,
            "merchant_privacy_policy": null,
            "page_expiration": 1632654049,
            "redirect_url": "https://sandboxcheckout.rapyd.net?token=checkout_f01e66e29d482641026fc73756364f45",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "https://rapyd.net",
            "complete_checkout_url": "https://rapyd.net",
            "country": "SG",
            "currency": "SGD",
            "amount": 100,
            "payment": {
                "id": null,
                "amount": 100,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "SGD",
                "country_code": "SG",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": "0912-2021",
                "customer_token": "cus_9761efaa881b6edeab25e9fbfec1ddf5",
                "payment_method_data": {},
                "expiration": 0,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": "http://example.com/complete",
                "error_payment_url": "http://example.com/error",
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": {
                    "merchant_defined": true
                },
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": null,
                "merchant_requested_currency": null,
                "merchant_requested_amount": null,
                "fixed_side": null,
                "payment_fees": null,
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": "sg_grabpay_ewallet",
            "payment_method_type_categories": null,
            "payment_method_types_include": null,
            "payment_method_types_exclude": null,
            "customer": "cus_9761efaa881b6edeab25e9fbfec1ddf5",
            "custom_elements": {
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": false
            },
            "timestamp": 1631444449,
            "payment_expiration": null,
            "cart_items": [],
            "escrow": null,
            "escrow_release_days": null
        }
    }
  • Create Checkout Page with 'payment_method_types_exclude'

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "amount": 100,
        "complete_payment_url": "http://example.com/complete",
        "country": "SG",
        "currency": "SGD",
        "customer": "cus_9761efaa881b6edeab25e9fbfec1ddf5",
        "error_payment_url": "http://example.com/error",
        "merchant_reference_id": "0912-2021",
        "language": "en",
        "metadata": {
            "merchant_defined": true
        },
        "payment_method_types_exclude": [
            "sg_grabpay_ewallet"
        ]
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "6d64996a-37f5-464f-8e50-d6867e55d702"
        },
        "data": {
            "id": "checkout_ec71384b612dce403fc171e35ea40b92",
            "status": "NEW",
            "language": "en",
            "merchant_color": "323fff",
            "merchant_logo": null,
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {},
            "merchant_alias": "Rapyd",
            "merchant_terms": null,
            "merchant_privacy_policy": null,
            "page_expiration": 1632654242,
            "redirect_url": "https://sandboxcheckout.rapyd.net?token=checkout_ec71384b612dce403fc171e35ea40b92",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "https://rapyd.net",
            "complete_checkout_url": "https://rapyd.net",
            "country": "SG",
            "currency": "SGD",
            "amount": 100,
            "payment": {
                "id": null,
                "amount": 100,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "SGD",
                "country_code": "SG",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": "0912-2021",
                "customer_token": "cus_9761efaa881b6edeab25e9fbfec1ddf5",
                "payment_method_data": {},
                "expiration": 0,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": "http://example.com/complete",
                "error_payment_url": "http://example.com/error",
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": {
                    "merchant_defined": true
                },
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": null,
                "merchant_requested_currency": null,
                "merchant_requested_amount": null,
                "fixed_side": null,
                "payment_fees": null,
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": null,
            "payment_method_type_categories": null,
            "payment_method_types_include": null,
            "payment_method_types_exclude": [
                "sg_grabpay_ewallet"
            ],
            "customer": "cus_9761efaa881b6edeab25e9fbfec1ddf5",
            "custom_elements": {
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": false
            },
            "timestamp": 1631444642,
            "payment_expiration": null,
            "cart_items": [],
            "escrow": null,
            "escrow_release_days": null
        }
    }
  • Create Checkout Page with escrow

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "amount": 110.45,
        "complete_payment_url": "http://example.com/complete",
        "country": "US",
        "currency": "USD",
        "error_payment_url": "http://example.com/error",
        "merchant_reference_id": "0912-2021",
        "payment_method_type": "us_mastercard_card",
        "ewallets": [
            {
                "ewallet": "ewallet_c1943cfeda5f98247ab117e5d2648861"
            }
        ],
        "escrow": true,
        "escrow_release_days": "5",
        "metadata": {
            "merchant_defined": "true"
        }
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "7c5d0335-8bfe-4fe3-818d-8d327b6a84ee"
        },
        "data": {
            "id": "checkout_36bee8cd84a2ca9a45ac1ff255816069",
            "status": "NEW",
            "language": null,
            "merchant_color": "323fff",
            "merchant_logo": null,
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {},
            "merchant_alias": "Rapyd",
            "merchant_terms": null,
            "merchant_privacy_policy": null,
            "page_expiration": 1632654594,
            "redirect_url": "https://sandboxcheckout.rapyd.net?token=checkout_36bee8cd84a2ca9a45ac1ff255816069",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "https://rapyd.net",
            "complete_checkout_url": "https://rapyd.net",
            "country": "US",
            "currency": "USD",
            "amount": 110.45,
            "payment": {
                "id": null,
                "amount": 110.45,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "USD",
                "country_code": "US",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": "0912-2021",
                "customer_token": null,
                "payment_method_data": {},
                "expiration": 0,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": "http://example.com/complete",
                "error_payment_url": "http://example.com/error",
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": {
                    "merchant_defined": "true"
                },
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallets": [
                    {
                        "ewallet": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                        "amount": 110.45,
                        "percent": 100
                    }
                ],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": null,
                "merchant_requested_currency": null,
                "merchant_requested_amount": null,
                "fixed_side": null,
                "payment_fees": null,
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": "us_mastercard_card",
            "payment_method_type_categories": null,
            "payment_method_types_include": null,
            "payment_method_types_exclude": null,
            "customer": null,
            "custom_elements": {
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": false
            },
            "timestamp": 1631444994,
            "payment_expiration": null,
            "cart_items": [],
            "escrow": true,
            "escrow_release_days": 5
        }
    }
  • Create Checkout Page - authorization only

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "amount": 123.45,
        "complete_payment_url": "http://example.com/complete",
        "country": "BR",
        "currency": "BRL",
        "error_payment_url": "http://example.com/error",
        "merchant_reference_id": "0912-2021",
        "metadata": {
            "merchant_defined": true
        },
        "payment_method_type": "br_credit_hipercard_card",
        "capture": false
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "66aa1041-1057-4476-acdd-f879fc4a889c"
        },
        "data": {
            "id": "checkout_f731deff32b343b26de22ae70ef6f0d2",
            "status": "NEW",
            "language": null,
            "merchant_color": "323fff",
            "merchant_logo": null,
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {},
            "merchant_alias": "Rapyd",
            "merchant_terms": null,
            "merchant_privacy_policy": null,
            "page_expiration": 1632654991,
            "redirect_url": "https://sandboxcheckout.rapyd.net?token=checkout_f731deff32b343b26de22ae70ef6f0d2",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "https://rapyd.net",
            "complete_checkout_url": "https://rapyd.net",
            "country": "BR",
            "currency": "BRL",
            "amount": 123.45,
            "payment": {
                "id": null,
                "amount": 123.45,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "BRL",
                "country_code": "BR",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": "0912-2021",
                "customer_token": null,
                "payment_method_data": {},
                "expiration": 0,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": "http://example.com/complete",
                "error_payment_url": "http://example.com/error",
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": {
                    "merchant_defined": true
                },
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": null,
                "merchant_requested_currency": null,
                "merchant_requested_amount": null,
                "fixed_side": null,
                "payment_fees": null,
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": "br_credit_hipercard_card",
            "payment_method_type_categories": null,
            "payment_method_types_include": null,
            "payment_method_types_exclude": null,
            "customer": null,
            "custom_elements": {
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": false
            },
            "timestamp": 1631445391,
            "payment_expiration": null,
            "cart_items": [],
            "escrow": null,
            "escrow_release_days": null
        }
    }
  • Create Checkout Page split by amount

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "amount": 250,
        "complete_payment_url": "http://example.com/complete",
        "country": "US",
        "currency": "USD",
        "error_payment_url": "http://example.com/error",
        "merchant_reference_id": "0209-2023",
        "metadata": {
            "merchant_defined": true
        },
        "payment_method_type": "us_debit_visa_card",
        "ewallets": [
            {
                "ewallet": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                "amount": 200
            },
            {
                "ewallet": "ewallet_3cd928611934717f283df049a2c7c17e",
                "amount": 50
            }
        ]
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "57a5f28f-70cd-4a8b-9848-b463dff67480"
        },
        "data": {
            "id": "checkout_eb40b93a667e85c6bae5c4f71a270161",
            "status": "NEW",
            "language": null,
            "org_id": "153e08b8-4bf3-4cb9-bb03-79d405eaed2a",
            "merchant_color": "323fff",
            "merchant_logo": null,
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {},
            "merchant_alias": "Doc Team",
            "merchant_terms": null,
            "merchant_privacy_policy": null,
            "page_expiration": 1677161917,
            "redirect_url": "https://sandboxcheckout.rapyd.net?token=checkout_eb40b93a667e85c6bae5c4f71a270161",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "https://rapyd.net",
            "complete_checkout_url": "https://rapyd.net",
            "country": "US",
            "currency": "USD",
            "amount": 250,
            "payment": {
                "id": null,
                "amount": 250,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "USD",
                "country_code": "US",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": "0209-2023",
                "customer_token": null,
                "payment_method": null,
                "payment_method_data": {},
                "expiration": 0,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": "http://example.com/complete",
                "error_payment_url": "http://example.com/error",
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": {
                    "merchant_defined": true
                },
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [
                    {
                        "ewallet": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                        "amount": 200,
                        "percent": 80
                    },
                    {
                        "ewallet": "ewallet_755b0fd11fd22b33328fff7d30f3ce30",
                        "amount": 50,
                        "percent": 20
                    }
                ],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": null,
                "merchant_requested_currency": null,
                "merchant_requested_amount": null,
                "fixed_side": null,
                "payment_fees": null,
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": "us_debit_visa_card",
            "payment_method_type_categories": null,
            "payment_method_types_include": null,
            "payment_method_types_exclude": null,
            "account_funding_transaction": null,
            "customer": null,
            "custom_elements": {
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": false
            },
            "timestamp": 1675952317,
            "payment_expiration": null,
            "cart_items": [],
            "escrow": null,
            "escrow_release_days": null
        }
    }
  • Create Checkout Page split by percentage

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "amount": 20.00,
        "complete_payment_url": "http://example.com/complete",
        "country": "US",
        "currency": "USD",
        "error_payment_url": "http://example.com/error",
        "merchant_reference_id": "0912-2021",
        "metadata": {
            "merchant_defined": true
        },
        "payment_method_type": "us_visa_card",
        "ewallets": [
            {
                "ewallet": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                "percentage": 12.05
            },
            {
                "ewallet": "ewallet_3801e782955b29955445586a2405a5db",
                "percentage": 25
            },
            {
                "ewallet": "ewallet_3cd928611934717f283df049a2c7c17e",
                "percentage": null
            }
        ]
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "5872a459-e4be-4277-8ea1-70caa6bf8561"
        },
        "data": {
            "id": "checkout_7665538188563c9d987a2a7770b8c6db",
            "status": "NEW",
            "language": null,
            "merchant_color": "323fff",
            "merchant_logo": null,
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {},
            "merchant_alias": "Rapyd",
            "merchant_terms": null,
            "merchant_privacy_policy": null,
            "page_expiration": 1632655648,
            "redirect_url": "https://sandboxcheckout.rapyd.net?token=checkout_7665538188563c9d987a2a7770b8c6db",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "https://rapyd.net",
            "complete_checkout_url": "https://rapyd.net",
            "country": "US",
            "currency": "USD",
            "amount": 20,
            "payment": {
                "id": null,
                "amount": 20,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "USD",
                "country_code": "US",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": "0912-2021",
                "customer_token": null,
                "payment_method_data": {},
                "expiration": 0,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": "http://example.com/complete",
                "error_payment_url": "http://example.com/error",
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": {
                    "merchant_defined": true
                },
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [
                    {
                        "ewallet": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                        "amount": 2.41,
                        "percent": 12.05
                    },
                    {
                        "ewallet": "ewallet_3801e782955b29955445586a2405a5db",
                        "amount": 5,
                        "percent": 25
                    },
                    {
                        "ewallet": "ewallet_3cd928611934717f283df049a2c7c17e",
                        "amount": 12.59,
                        "percent": 62.95
                    }
                ],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": null,
                "merchant_requested_currency": null,
                "merchant_requested_amount": null,
                "fixed_side": null,
                "payment_fees": null,
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": "us_visa_card",
            "payment_method_type_categories": null,
            "payment_method_types_include": null,
            "payment_method_types_exclude": null,
            "customer": null,
            "custom_elements": {
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": false
            },
            "timestamp": 1631446048,
            "payment_expiration": null,
            "cart_items": [],
            "escrow": null,
            "escrow_release_days": null
        }
    }
  • Create Checkout Page with FX - fixed side sell

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "amount": 100,
        "complete_payment_url": "http://example.com/complete",
        "country": "SG",
        "currency": "SGD",
        "error_payment_url": "http://example.com/error",
        "merchant_reference_id": "0912-2021",
        "language": "en",
        "requested_currency": "USD",
        "fixed_side": "sell",
        "metadata": {
            "merchant_defined": true
        }
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "79608b10-b34c-479b-bb19-fe142fc42135"
        },
        "data": {
            "id": "checkout_402f993b81c304fda4a0e36567705eed",
            "status": "NEW",
            "language": "en",
            "merchant_color": "323fff",
            "merchant_logo": null,
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {},
            "merchant_alias": "Rapyd",
            "merchant_terms": null,
            "merchant_privacy_policy": null,
            "page_expiration": 1632653693,
            "redirect_url": "https://sandboxcheckout.rapyd.net?token=checkout_402f993b81c304fda4a0e36567705eed",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "https://rapyd.net",
            "complete_checkout_url": "https://rapyd.net",
            "country": "SG",
            "currency": "SGD",
            "amount": 100,
            "payment": {
                "id": null,
                "amount": 100,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "SGD",
                "country_code": "SG",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": "0912-2021",
                "customer_token": null,
                "payment_method_data": {},
                "expiration": 0,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": "http://example.com/complete",
                "error_payment_url": "http://example.com/error",
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": {
                    "merchant_defined": true
                },
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": 0.722939,
                "merchant_requested_currency": "USD",
                "merchant_requested_amount": 100,
                "fixed_side": "sell",
                "payment_fees": null,
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": null,
            "payment_method_type_categories": null,
            "payment_method_types_include": null,
            "payment_method_types_exclude": null,
            "customer": null,
            "custom_elements": {
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": false
            },
            "timestamp": 1631444093,
            "payment_expiration": null,
            "cart_items": [],
            "escrow": null,
            "escrow_release_days": null
        }
    }
  • Create Checkout Page with page expiration

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "amount": 100,
        "complete_payment_url": "http://example.com/complete",
        "country": "SG",
        "currency": "SGD",
        "error_payment_url": "http://example.com/error",
        "merchant_reference_id": "0912-2021",
        "metadata": {
            "merchant_defined": true
        },
        "page_expiration": 1632027189
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "8556381b-b946-4d1f-bfd5-169fbe5bb9c7"
        },
        "data": {
            "id": "checkout_39941080d6ccb872616b76a034bcf1a1",
            "status": "NEW",
            "language": null,
            "merchant_color": "323fff",
            "merchant_logo": null,
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {},
            "merchant_alias": "Rapyd",
            "merchant_terms": null,
            "merchant_privacy_policy": null,
            "page_expiration": 1632027189,
            "redirect_url": "https://sandboxcheckout.rapyd.net?token=checkout_39941080d6ccb872616b76a034bcf1a1",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "https://rapyd.net",
            "complete_checkout_url": "https://rapyd.net",
            "country": "SG",
            "currency": "SGD",
            "amount": 100,
            "payment": {
                "id": null,
                "amount": 100,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "SGD",
                "country_code": "SG",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": "0912-2021",
                "customer_token": null,
                "payment_method_data": {},
                "expiration": 0,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": "http://example.com/complete",
                "error_payment_url": "http://example.com/error",
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": {
                    "merchant_defined": true
                },
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": null,
                "merchant_requested_currency": null,
                "merchant_requested_amount": null,
                "fixed_side": null,
                "payment_fees": null,
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": null,
            "payment_method_type_categories": null,
            "payment_method_types_include": null,
            "payment_method_types_exclude": null,
            "customer": null,
            "custom_elements": {
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": false
            },
            "timestamp": 1631446556,
            "payment_expiration": null,
            "cart_items": [],
            "escrow": null,
            "escrow_release_days": null
        }
    }
  • Create Checkout Page with payment expiration

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "amount": 100,
        "complete_payment_url": "http://example.com/complete",
        "country": "SG",
        "currency": "SGD",
        "error_payment_url": "http://example.com/error",
        "merchant_reference_id": "0912-2021",
        "metadata": {
            "merchant_defined": true
        },
        "payment_expiration": 604800
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "d3eb0d10-d3ee-424e-8bd1-f568b00238bc"
        },
        "data": {
            "id": "checkout_1f659e4cce61e1d8c881e6bb5a8e1ffc",
            "status": "NEW",
            "language": null,
            "merchant_color": "323fff",
            "merchant_logo": null,
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {},
            "merchant_alias": "Rapyd",
            "merchant_terms": null,
            "merchant_privacy_policy": null,
            "page_expiration": 1632656479,
            "redirect_url": "https://sandboxcheckout.rapyd.net?token=checkout_1f659e4cce61e1d8c881e6bb5a8e1ffc",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "https://rapyd.net",
            "complete_checkout_url": "https://rapyd.net",
            "country": "SG",
            "currency": "SGD",
            "amount": 100,
            "payment": {
                "id": null,
                "amount": 100,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "SGD",
                "country_code": "SG",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": "0912-2021",
                "customer_token": null,
                "payment_method_data": {},
                "expiration": 0,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": "http://example.com/complete",
                "error_payment_url": "http://example.com/error",
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": {
                    "merchant_defined": true
                },
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": null,
                "merchant_requested_currency": null,
                "merchant_requested_amount": null,
                "fixed_side": null,
                "payment_fees": null,
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": null,
            "payment_method_type_categories": null,
            "payment_method_types_include": null,
            "payment_method_types_exclude": null,
            "customer": null,
            "custom_elements": {
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": false
            },
            "timestamp": 1631446879,
            "payment_expiration": 604800,
            "cart_items": [],
            "escrow": null,
            "escrow_release_days": null
        }
    }
  • Create Checkout Page - Card with requested currency

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "amount": 100.00,
        "complete_payment_url": "http://example.com/complete",
        "country": "SG",
        "currency": "SGD",
        "error_payment_url": "http://example.com/error",
        "merchant_reference_id": "1003-2021",
        "requested_currency": "USD",
        "metadata": {
            "merchant_defined": true
        },
        "payment_method_type_categories": [
            "card"
        ]
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "6e8b51b2-411c-4a24-bc5a-e99c9ffcc274"
        },
        "data": {
            "id": "checkout_407c08def4a3e234bb5496c96a60ba6d",
            "status": "NEW",
            "language": null,
            "merchant_color": "323fff",
            "merchant_logo": null,
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {},
            "merchant_alias": "Rapyd",
            "merchant_terms": null,
            "merchant_privacy_policy": null,
            "page_expiration": 1634476018,
            "redirect_url": "https://sandboxcheckout.rapyd.net?token=checkout_407c08def4a3e234bb5496c96a60ba6d",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "https://rapyd.net",
            "complete_checkout_url": "https://rapyd.net",
            "country": "SG",
            "currency": "SGD",
            "amount": 100,
            "payment": {
                "id": null,
                "amount": 100,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "SGD",
                "country_code": "SG",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": "1003-2021",
                "customer_token": null,
                "payment_method_data": {},
                "expiration": 0,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": "http://example.com/complete",
                "error_payment_url": "http://example.com/error",
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": {
                    "merchant_defined": true
                },
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": 1.317332,
                "merchant_requested_currency": "USD",
                "merchant_requested_amount": 75.91,
                "fixed_side": "buy",
                "payment_fees": null,
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": null,
            "payment_method_type_categories": [
                "card"
            ],
            "payment_method_types_include": null,
            "payment_method_types_exclude": null,
            "customer": null,
            "custom_elements": {
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": false
            },
            "timestamp": 1633266418,
            "payment_expiration": null,
            "cart_items": [],
            "escrow": null,
            "escrow_release_days": null
        }
    }
  • Create Checkout Page - Card with requested currency and fees

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "amount": 100,
        "complete_payment_url": "http://example.com/complete",
        "country": "SG",
        "currency": "SGD",
        "error_payment_url": "http://example.com/error",
        "merchant_reference_id": "1007-2021",
        "requested_currency": "USD",
        "metadata": {
            "merchant_defined": true
        },
        "payment_method_type_categories": [
            "card"
        ],
        "payment_fees": {
            "transaction_fee": {
                "calc_type": "gross",
                "value": 10,
                "fee_type": "percentage"
            },
            "fx_fee": {
                "calc_type": "gross",
                "value": 2
            }
        }
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "8c23f60a-969e-414b-a995-5a2e5a574426"
        },
        "data": {
            "id": "checkout_5c4313c6b51fd9e7e77dc1a8555329d1",
            "status": "NEW",
            "language": null,
            "merchant_color": "323fff",
            "merchant_logo": null,
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {},
            "merchant_alias": "Rapyd",
            "merchant_terms": null,
            "merchant_privacy_policy": null,
            "page_expiration": 1634811166,
            "redirect_url": "https://sandboxcheckout.rapyd.net?token=checkout_5c4313c6b51fd9e7e77dc1a8555329d1",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "https://rapyd.net",
            "complete_checkout_url": "https://rapyd.net",
            "country": "SG",
            "currency": "SGD",
            "amount": 100,
            "payment": {
                "id": null,
                "amount": 100,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "SGD",
                "country_code": "SG",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": "1007-2021",
                "customer_token": null,
                "payment_method_data": {},
                "expiration": 0,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": "http://example.com/complete",
                "error_payment_url": "http://example.com/error",
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": {
                    "merchant_defined": true
                },
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": 1.3182,
                "merchant_requested_currency": "USD",
                "merchant_requested_amount": 84.96,
                "fixed_side": "buy",
                "payment_fees": {
                    "fx_fee": {
                        "value": 2,
                        "calc_type": "gross"
                    },
                    "net_fees": null,
                    "gross_fees": null,
                    "transaction_fee": {
                        "value": 10,
                        "fee_type": "percentage",
                        "calc_type": "gross"
                    }
                },
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": null,
            "payment_method_type_categories": [
                "card"
            ],
            "payment_method_types_include": null,
            "payment_method_types_exclude": null,
            "customer": null,
            "custom_elements": {
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": false
            },
            "timestamp": 1633601566,
            "payment_expiration": null,
            "cart_items": [],
            "escrow": null,
            "escrow_release_days": null
        }
    }
  • Create Checkout Page with multiple payment method categories

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "amount": 123.45,
        "complete_payment_url": "http://example.com/complete",
        "country": "SG",
        "currency": "SGD",
        "error_payment_url": "http://example.com/error",
        "merchant_reference_id": "1007-2021",
        "metadata": {
            "merchant_defined": true
        },
        "payment_method_type_categories": [
            "cash",
            "card",
            "ewallet"
        ]
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "4ade4b47-79ef-4190-bba6-ec0b790ecaeb"
        },
        "data": {
            "id": "checkout_117e89c8b0cfba65e70e34396156cb01",
            "status": "NEW",
            "language": null,
            "merchant_color": "323fff",
            "merchant_logo": null,
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {},
            "merchant_alias": "Rapyd",
            "merchant_terms": null,
            "merchant_privacy_policy": null,
            "page_expiration": 1634813300,
            "redirect_url": "https://sandboxcheckout.rapyd.net?token=checkout_117e89c8b0cfba65e70e34396156cb01",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "https://rapyd.net",
            "complete_checkout_url": "https://rapyd.net",
            "country": "SG",
            "currency": "SGD",
            "amount": 123.45,
            "payment": {
                "id": null,
                "amount": 123.45,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "SGD",
                "country_code": "SG",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": "1007-2021",
                "customer_token": null,
                "payment_method_data": {},
                "expiration": 0,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": "http://example.com/complete",
                "error_payment_url": "http://example.com/error",
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": {
                    "merchant_defined": true
                },
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": null,
                "merchant_requested_currency": null,
                "merchant_requested_amount": null,
                "fixed_side": null,
                "payment_fees": null,
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": null,
            "payment_method_type_categories": [
                "cash",
                "card",
                "ewallet"
            ],
            "payment_method_types_include": null,
            "payment_method_types_exclude": null,
            "customer": null,
            "custom_elements": {
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": false
            },
            "timestamp": 1633603700,
            "payment_expiration": null,
            "cart_items": [],
            "escrow": null,
            "escrow_release_days": null
        }
    }
  • Create Checkout Page with merchant fields

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "amount": 10,
        "currency": "COP",
        "country": "CO",
        "merchant_fields": {
            "co_cash_cash": {
                "required_fields": {
                    "tax": 7,
                    "documentnumber": "654987575"
                },
                "payment_method_options": {}
            }
        }
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "38d78b3f-fa37-46a2-84e8-e195c57fcb28"
        },
        "data": {
            "id": "checkout_57b1366b899d01f02964874512ba555a",
            "status": "NEW",
            "language": null,
            "merchant_color": "e8dcff",
            "merchant_logo": "https://iconslib.rapyd.net/merchant-logos/ohpc_bc12.png",
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {
                "url": "https://rapyd.net",
                "email": "johndoe@rapyd.net",
                "phone_number": "555555555"
            },
            "merchant_alias": "Rapyd",
            "merchant_terms": "https://rapyd.net",
            "merchant_privacy_policy": "https://rapyd.net",
            "page_expiration": 1668606927,
            "redirect_url": "https://checkout.rapyd.net?token=checkout_57b1366b899d01f02964874512ba555a",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "https://rapyd.net",
            "complete_checkout_url": "https://rapyd.net",
            "country": "CO",
            "currency": "COP",
            "amount": 10,
            "payment": {
                "id": null,
                "amount": 10,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "COP",
                "country_code": "CO",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": null,
                "customer_token": null,
                "payment_method": null,
                "payment_method_data": {},
                "expiration": 0,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": null,
                "error_payment_url": null,
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": null,
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": null,
                "merchant_requested_currency": null,
                "merchant_requested_amount": null,
                "fixed_side": null,
                "payment_fees": null,
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": null,
            "payment_method_type_categories": null,
            "payment_method_types_include": null,
            "payment_method_types_exclude": null,
            "account_funding_transaction": null,
            "customer": null,
            "custom_elements": {
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": false
            },
            "timestamp": 1667397328,
            "payment_expiration": null,
            "cart_items": [],
            "escrow": null,
            "escrow_release_days": null
        }
    }
  • Create Checkout Page - Account Funding Transaction - 'person' wallet

  • curl -X post
    https://sandboxapi.rapyd.net/v1/checkout
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "country": "AT",
        "currency": "EUR",
        "amount": "100",
        "account_funding_transaction": {
            "ewallet": "ewallet_d2ab10025f4da04a5442ea264fd98f53",
            "payment_method_types": ["at_mastercard_card"]
        }
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "cdee23c4-6a06-45b9-a1e5-28e30a78ae89"
        },
        "data": {
            "id": "checkout_b8f18ef475ad1934d896770b0fb85c65",
            "status": "NEW",
            "language": null,
            "org_id": "29635db3-9e24-4cae-9016-5be932cf2961",
            "merchant_color": "e8dcff",
            "merchant_logo": "https://iconslib.rapyd.net/merchant-logos/ohpc_8df12e51102d26bdc7e2321201120.jpg",
            "merchant_website": "https://rapyd.net",
            "merchant_customer_support": {
                "url": "https://www.rapyd.com",
                "email": "johndoe@rapyd.net",
                "phone_number": "55555555555"
            },
            "merchant_alias": "rapyd",
            "merchant_terms": "https://www.termsfeed.com/terms-conditions-generator/",
            "merchant_privacy_policy": "https://www.privacypolicies.com/blog/privacy-policy-template/",
            "page_expiration": 1668597423,
            "redirect_url": "https://sboxcheckout.rapyd.net?token=checkout_b8f18ef475ad1934d896770b0fb85c65",
            "merchant_main_button": "place_your_order",
            "cancel_checkout_url": "https://rapyd.net",
            "complete_checkout_url": "https://rapyd.net",
            "country": "AT",
            "currency": "EUR",
            "amount": 100,
            "payment": {
                "id": null,
                "amount": 100,
                "original_amount": 0,
                "is_partial": false,
                "currency_code": "EUR",
                "country_code": "AT",
                "status": null,
                "description": "Payment via Checkout",
                "merchant_reference_id": null,
                "customer_token": null,
                "payment_method": null,
                "payment_method_data": {},
                "expiration": 0,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": null,
                "redirect_url": null,
                "complete_payment_url": null,
                "error_payment_url": null,
                "receipt_number": null,
                "flow_type": null,
                "address": null,
                "statement_descriptor": null,
                "transaction_id": null,
                "created_at": 0,
                "updated_at": 0,
                "metadata": null,
                "failure_code": null,
                "failure_message": null,
                "paid": false,
                "paid_at": 0,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": {},
                "ewallet_id": null,
                "ewallets": [],
                "payment_method_options": {},
                "payment_method_type": null,
                "payment_method_type_category": null,
                "fx_rate": null,
                "merchant_requested_currency": null,
                "merchant_requested_amount": null,
                "fixed_side": null,
                "payment_fees": null,
                "invoice": null,
                "escrow": null,
                "group_payment": null,
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": null,
                "next_action": "not_applicable"
            },
            "payment_method_type": null,
            "payment_method_type_categories": null,
            "payment_method_types_include": null,
            "payment_method_types_exclude": null,
            "account_funding_transaction": {
             	"ewallet": "ewallet_d2ab10025f4da04a5442ea264fd98f53",
            	"payment_method_types": ["at_mastercard_card"]
            },
            "customer": null,
            "custom_elements": {
                "save_card_default": false,
                "display_description": false,
                "payment_fees_display": true,
                "merchant_currency_only": false,
                "billing_address_collect": false,
                "dynamic_currency_conversion": false
            },
            "timestamp": 1667387823,
            "payment_expiration": null,
            "cart_items": [],
            "escrow": null,
            "escrow_release_days": null
        }
    }