Skip to main content

Documentation

Create Payment

Create a payment to collect money into a Rapyd Wallet.

Use this method in the following situations:

  • To collect money immediately for a one-time charge.

  • To fund one or more Rapyd Wallets.

  • To replace a failed payment in a group payment. You can replace all or part of the portion that failed.

If the payment_method is not specified, Rapyd collects the funds from the default_payment_method of the customer object. The default payment method must be tokenizable.

For card payments, Rapyd saves the card payment method to the customer if you set save_payment_method to true. If you do not want Rapyd to save the card payment method to the customer, set save_payment_method to false. The default is false.

When Rapyd does not save the card payment method to the customer, the values of payment_method and payment_method_data.id in the response are null.

In production, you cannot save a card payment method for a telephone order.

Some card payment methods require payment_method.fields.recurrence_type to specify the primary intended purpose of a saved payment method. See Saving a European Card While Creating a Payment. One of the following values:

  • recurring - Regular payments for an indefinite period.

  • installment - Regular payments for a defined number of payment cycles.

  • unscheduled - Individual unrelated payments. This is the default.

The payment method might also require initiation_type for each payment. See Creating a Payment with a European Card on File.

This method triggers Payment Succeeded Webhook. This webhook contains the same information as the response. If the action of a third party is not required, the Payment Completed Webhook is also triggered.

The following asynchronous webhooks provide information about later changes to the payment object:

In the sandbox:

  • To simulate completion of a payment method that requires the action of a third party, you must run Complete Payment.

  • To simulate completion of a payment that requires 3DS authentication, see Simulating 3DS Authentication. Relevant where the payment method type is card.

  • To simulate a cardholder dispute, create a payment using a specific, reserved card number. Set payment_method_options.3d_required to false. See Simulating Cardholder Disputes.

Note

  • Only clients with PCI certification can handle personal identifying information for cards. Clients that are not PCI-certified can use Rapyd Checkout to collect money from a card. See Checkout Page.

  • If you create a payment that is split by amount and the total of the identified wallets is less than the amount of the payment, the remainder is paid into the client wallet.

  • For a split payment, you must choose amount for all wallets or percentage for all wallets. You cannot mix these options.

  • Before you create a payment with a tokenized payment method, verify that the value of is_tokenizable is true.

  • When you create a card payment, a zero-amount transaction is processed.

  • Transactions with 3DS authentication must be authenticated within 15 minutes.

  • Requests for very small amounts are rounded down to zero, are not processed, and throw an error. This can occur in payments that are split among two or more wallets, or in payments with FX.

  • Use this method to create a network reference ID for a recurring card payment. You also can create a network reference ID when you add a payment method to a customer. See Add Payment Method to Customer.

  • A SEPA (Single Euro Payments Area) bank transfer can be disputed for 13 months after the payment is created.

Account funding transaction (AFT). You can transfer funds from a card directly to the cardholder’s own wallet. You can also transfer the funds indirectly through the company wallet of a licensed business entity that manages the customer’s wallet. The business forwards the funds to the customer’s wallet. Relevant to payment method types that support this feature.

  • Set payment_method_options.aft to true.

  • complete_payment_url and error_payment_url are required.

  • To transfer funds directly, set the ID of the cardholder’s person wallet. The wallet contact must include first name, last name, country, and the address object, which must contain street (line_1), city, and zip. The cardholder’s first name, last name, and country must match the values of the wallet contact.

  • To transfer funds indirectly, set the ID of the customer. The address in the customer profile must include phone number, street (line_1), city, country, and zip.

  • The AFT feature is in beta testing. To enable this feature, contact Rapyd Client Support.

Cryptocurrency transactions. The purchase of cryptocurrency is considered a high risk activity by card networks. For cryptocurrency transactions, card networks require additional monitoring and risk controls to improve security and compliance with anti-money laundering (AML) regulations.

Each cryptocurrency purchase transaction in Rapyd requires a special indicator and additional required fields related to the cardholder. These requirements apply both when cryptocurrency is purchased directly and when the wallet is topped up for later purchase of cryptocurrency.

Relevant to payment method types that support this feature.

  • Set payment_method_options.special_condition_indicator to cryptocurrency.

  • complete_payment_url and error_payment_url are required.

  • To transfer cryptocurrency directly to the cardholder’s own wallet, set the ID of the cardholder’s person wallet. The wallet contact must include first name, last name, country, and the address object, which must contain street (line_1), city, and zip. The cardholder’s first name, last name, and country must match the values of the wallet contact.

  • To transfer cryptocurrency indirectly through the company wallet of a licensed business entity that manages the customer’s wallet, set the ID of the customer. The address in the customer profile must include phone number, street (line_1), city, country, and zip. The business forwards the cryptocurrency to the customer’s wallet.

  • The cryptocurrency feature is in beta testing. To enable this feature, contact Rapyd Client Support.

Prerequisites

    • amount

    • The amount of the payment, in units of the currency defined in currency. Decimal, including the correct number of decimal places for the currency exponent, as defined in ISO 4217:2015. To verify a card, set to 0.

    • currency

    • In transactions without FX, defines the currency of the transaction. Three-letter ISO 4217 code.

      In FX transactions:

      • When fixed_side is buy, it is the currency received in the Rapyd wallet.

      • When fixed_side is sell, it is the currency charged to the buyer.

      See also fixed_side and requested_currency fields.

    • customer

    • String or object describing the customer. Required if payment_method is blank.

      • string - ID of the customer who is making the payment. String starting with cus_.

      • object - Contains all fields required for the customer. See Create Customer.

    • description

    • Description of the payment transaction.

    • escrow

    • Determines whether the payment is held in escrow for later release.

      false

    • escrow_release_days

    • Determines the number of days after creation of the payment that funds are released from escrow. Funds are released at 5:00 pm GMT on the day indicated.

      Integer, range: 1-90.

      90

    • fixed_side

    • Indicates whether the FX rate is fixed for the buy side (seller) or for the sell side (buyer).

      • buy - The currency that the Rapyd Wallet receives for goods or services. Fixed side buy relates to the seller (merchant) funds. For example, a US-based merchant wants to charge 100 USD. The buyer (customer) pays the amount in MXN that converts to 100 USD.

      • sell - The currency that the buyer is charged for purchasing goods or services. Fixed side sell relates to the buyer (customer) funds. For example, a US-based merchant wants to charge a buyer 2,000 MXN and will accept whatever amount in USD that is converted from 2,000 MXN.

      buy

      See also requested_currency.

    • group_payment

    • ID of the group payment. String starting with gp_.

      Relevant when the payment is part of a group payment.

    • initiation_type

    • Indicates how the transaction was initiated. One of the following:

      • customer_present - The transaction was initiated by the customer.

      • installment - The transaction was initiated by a subscription where there is a fixed number of installments.

      • moto - The transaction was initiated by the merchant or Rapyd client for a mail order or telephone order.

        Note

        To enable moto in the production environment, contact Rapyd Client Support.

      • recurring - The transaction was initiated by a subscription where charges are made at regular intervals and there is no end date.

      • unscheduled - The transaction is a top-up transaction that was previously authorized by the cardholder and was initiated by the merchant or Rapyd client.

      customer_present

    • requested_currency

    • Currency for one side of an FX transaction. Three-letter ISO 4217 code.

      • When fixed_side is sell, it is the currency received in the Rapyd Wallet.

      • When fixed_side is buy, it is the currency charged to the buyer (customer).

      Relevant to payments with FX.

      See also currency and fixed_side fields.

    • save_payment_method

    • Relevant to card payment methods when the request includes full card details. Determines whether Rapyd saves the payment method for future use.

      • true - Save the payment method for future use.

      • false - Do not save the payment method.

      false

  • /v1/payments

  • Payment by payment method ID

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments/
    -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": 101,
        "currency": "USD",
        "description": "Payment method token",
        "payment_method": "other_7f991f72a4c14c5cd79627ebc21241de",
        "ewallets": [{
                "ewallet": "ewallet_1290eef66d0b84ece177a3f5bd8fb0c8",
                "percentage": 100
            }
        ],
        "metadata": {
            "merchant_defined": true
        }
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "798fe30d-e3a6-4b1a-8fd6-3210aa6f8001"
        },
        "data": {
            "id": "payment_5c72dce7526e486e0fac5a2a4cfaf9e1",
            "amount": 0,
            "original_amount": 101,
            "is_partial": false,
            "currency_code": "USD",
            "country_code": "US",
            "status": "ACT",
            "description": "Payment method token",
            "merchant_reference_id": "",
            "customer_token": "cus_261e500e1d0217bcac3d2e3345d4a7c3",
            "payment_method": "other_7f991f72a4c14c5cd79627ebc21241de",
            "payment_method_data": {
                "id": "other_7f991f72a4c14c5cd79627ebc21241de",
                "type": "us_stopngo_cash",
                "category": "cash",
                "metadata": {
                    "merchant_defined": true
                },
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable"
            },
            "auth_code": null,
            "expiration": 1664790865,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1663581265,
            "metadata": {
                "merchant_defined": true
            },
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {
                "code": "451296602858399965035514290412"
            },
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": "Please visit any one of your nearest participating Stop-N-Go stores.",
                            "step2": "Present your barcode to be scanned at the register and the exact $ amount for which the barcode was generated.",
                            "step3": "Provide cash to complete your payment.",
                            "step4": "Keep your receipt as proof of payment."
                        }
                    ]
                }
            ],
            "ewallet_id": "ewallet_1290eef66d0b84ece177a3f5bd8fb0c8",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_1290eef66d0b84ece177a3f5bd8fb0c8",
                    "amount": 101,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "us_stopngo_cash",
            "payment_method_type_category": "cash",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "pending_confirmation",
            "error_code": "",
            "remitter_information": {}
        }
    }
  • Default payment method

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments
    -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": 45.00,
    	"currency": "USD",
    	"customer": "cus_e02329423b13bcd88a2c558fadfd1de9",
    	"description": "Payment by customer's default payment method" 
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "1fce9528-9aa2-45b0-8d01-893c407aeac8"
        },
        "data": {
            "id": "payment_8f2a9e81664b5a4f6725353fd05e8116",
            "amount": 0,
            "original_amount": 45,
            "is_partial": false,
            "currency_code": "USD",
            "country_code": "US",
            "status": "ACT",
            "description": "Payment by customer's default payment method",
            "merchant_reference_id": "",
            "customer_token": "cus_e02329423b13bcd88a2c558fadfd1de9",
            "payment_method": "other_7f991f72a4c14c5cd79627ebc21241de",
            "payment_method_data": {
                "id": "other_7f991f72a4c14c5cd79627ebc21241de",
                "type": "us_stopngo_cash",
                "category": "cash",
                "metadata": {
                    "merchant_defined": "Prime customer"
                },
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable"
            },
            "auth_code": null,
            "expiration": 1664793698,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1663584098,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {
                "code": "824169043858275843928850407863"
            },
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": "Please visit any one of your nearest participating Stop-N-Go stores.",
                            "step2": "Present your barcode to be scanned at the register and the exact $ amount for which the barcode was generated.",
                            "step3": "Provide cash to complete your payment.",
                            "step4": "Keep your receipt as proof of payment."
                        }
                    ]
                }
            ],
            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "amount": 45,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "us_stopngo_cash",
            "payment_method_type_category": "cash",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "pending_confirmation",
            "error_code": "",
            "remitter_information": {}
        }
    }
  • Payment by card

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments
    -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,
        "payment_method": {
            "type": "it_visa_card",
            "fields": {
                "number": "4111111111111111",
                "expiration_month": "12",
                "expiration_year": "24",
                "cvv": "566",
                "name": "Auto Test"
            }
        },
        "currency": "USD",
        "payment_method_options": {
            "3d_required": true
        },
        "ewallet": "ewallet_6a6669f4febd8b2eb9c5d77e7161a679",
        "capture": false,
        "expiration": 1689859548,
        "error_payment_url": "https://support.rapyd.net/hc/en-us",
        "complete_payment_url": "https://www.rapyd.net",
        "description": "testing"
    }'
    
  • {
        {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "c3d1ac9d-139b-4c55-8da4-b1c32cf88fa9"
        }, {
            "id": "payment_56f3eb8ec543a3962ce112b4f03da9ae",
            "amount": 0,
            "original_amount": 10,
            "is_partial": false,
            "currency_code": "USD",
            "country_code": "IT",
            "status": "ACT",
            "description": "testing",
            "merchant_reference_id": "",
            "customer_token": "cus_0335a29669a3f4337317d6e1441df763",
            "payment_method": "card_27a4c2f05d9ebd1700f5338e155c1ced",
            "payment_method_data": {
                "id": "card_27a4c2f05d9ebd1700f5338e155c1ced",
                "type": "it_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "3d_verification",
                "name": "Auto Test",
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "type": "CREDIT",
                    "brand": "VISA",
                    "level": null,
                    "issuer": "JPMORGAN CHASE BANK, N.A.",
                    "country": "US",
                    "bin_number": "411111"
                },
                "expiration_year": "24",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_11ECFC396977BB4E81220EC01B2F2B1B"
            },
            "auth_code": null,
            "expiration": 1689859548,
            "captured": false,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "https://qacheckout.rapyd.net/3ds-payment?token=payment_56f3eb8ec543a3962ce112b4f03da9ae",
            "complete_payment_url": "https://www.rapyd.net",
            "error_payment_url": "https://support.rapyd.net/hc/en-us",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "card_tokenization_with",
            "transaction_id": "",
            "created_at": 1689859010,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [],
            "ewallet_id": "ewallet_6a6669f4febd8b2eb9c5d77e7161a679",
            "ewallets": [{
                    "ewallet_id": "ewallet_6a6669f4febd8b2eb9c5d77e7161a679",
                    "amount": 10,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {
                "3d_required": true
            },
            "payment_method_type": "it_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "3d_verification",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": true
        }
    }
  • Payment by card - save payment method

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments
    -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": "GBP",
        "capture": true,
        "description": "Save payment method",
        "payment_method": {
            "type": "gb_visa_card",
            "fields": {
                "recurrence_type": "installment",
                "name": "John Doe",
                "number": "4111111111111111",
                "expiration_month": "05",
                "expiration_year": "25",
                "cvv": "111"
            }
        },
        "payment_method_options": {},
        "complete_payment_url": "https://complete.rapyd.net",
        "error_payment_url": "https://error.rapyd.net",
        "customer": "cus_b7b470e9fa4c16362cea2e8ff6b61f08",
        "save_payment_method": true,
        "initiation_type": "customer_present",
        "metadata": {
            "merchant_defined": true
        }
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "bff27497-fc37-4d33-9c7a-629e667be997"
        },
        "data": {
            "id": "payment_dbefc88aacfd2b5af1bc53b0dddb9295",
            "amount": 10,
            "original_amount": 10,
            "is_partial": false,
            "currency_code": "GBP",
            "country_code": "GB",
            "status": "CLO",
            "description": "Save payment method",
            "merchant_reference_id": "",
            "customer_token": "cus_b7b470e9fa4c16362cea2e8ff6b61f08",
            "payment_method": "card_0d4b0a0439d31144d261d766e4e53962",
            "payment_method_data": {
                "id": "card_0d4b0a0439d31144d261d766e4e53962",
                "type": "gb_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "name": "John Doe",
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "type": "CREDIT",
                    "brand": "VISA",
                    "level": null,
                    "issuer": "JPMORGAN CHASE BANK, N.A.",
                    "country": "US",
                    "bin_number": "411111"
                },
                "expiration_year": "25",
                "recurrence_type": "installment",
                "expiration_month": "05",
                "fingerprint_token": "ocfp_99795b7a947e95d98c337bcc3aa0bd72"
            },
            "auth_code": null,
            "expiration": 1707742560,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "https://complete.rapyd.net",
            "error_payment_url": "https://error.rapyd.net",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "N/A",
            "transaction_id": "",
            "created_at": 1707137760,
            "metadata": {
                "merchant_defined": true
            },
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1707137761,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [],
            "ewallet_id": "ewallet_bcad4157ffae36fd13e44c57a4dcafeb",
            "ewallets": [{
                    "ewallet_id": "ewallet_bcad4157ffae36fd13e44c57a4dcafeb",
                    "amount": 10,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "gb_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "not_applicable",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": true
        }
    }
    
  • Payment by card - Use saved payment method

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments
    -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": 1000,
        "currency": "ISK",
        "capture": true,	
        "description": "Use saved payment method",
        "payment_method": "card_117e7a8d31c6ce3157444508307665db",
        "customer": "cus_aef17346c688529788a0d327fa5a343d",
        "initiation_type": "recurring",
        "complete_payment_url": "https://complete.rapyd.net",
        "error_payment_url": "https://error.rapyd.net",
        "save_payment_method": false
    }
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "7b5d53a4-dcea-473b-b3b2-d5699ddab74d"
        },
        "data": {
            "id": "payment_dc72b4c6576f3c18ee6de18ae03da469",
            "amount": 1000,
            "original_amount": 1000,
            "is_partial": false,
            "currency_code": "ISK",
            "country_code": "IS",
            "status": "CLO",
            "description": "Use saved payment method",
            "merchant_reference_id": "",
            "customer_token": "cus_aef17346c688529788a0d327fa5a343d",
            "payment_method": "card_117e7a8d31c6ce3157444508307665db",
            "payment_method_data": {
                "id": "card_117e7a8d31c6ce3157444508307665db",
                "type": "is_valitor_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "name": "John Doe",
                "last4": "1111",
                "acs_check": "pass",
                "cvv_check": "unchecked",
                "bin_details": {
                    "type": "CREDIT",
                    "brand": "MASTERCARD",
                    "level": "ACQUIRER ONLY",
                    "issuer": "MASTERCARD",
                    "country": "US",
                    "bin_number": "411111"
                },
                "expiration_year": "25",
                "expiration_month": "05",
                "fingerprint_token": "ocfp_ffb07b154b9e552b0573b2f3be0c3f4b",
                "network_reference_id": "ABC6700610516"
            },
            "auth_code": "831311",
            "expiration": 1716460138,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "https://complete.rapyd.net",
            "error_payment_url": "https://error.rapyd.net",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1715855338,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1715855340,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [],
            "ewallet_id": "ewallet_6f288d7c178f545ebb56be8990ff0ff2",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_6f288d7c178f545ebb56be8990ff0ff2",
                    "amount": 1000,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "is_valitor_card",
            "payment_method_type_category": "card",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "recurring",
            "mid": "mid_1ab3788e7e7e423ea990a48073d8b2b1",
            "next_action": "not_applicable",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": false
        }
    }
    
  • Payment by card - do not save payment method

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments
    -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": "EUR",
        "capture": true,
        "description": "Card not saved",
        "customer": "cus_5bee14584a78638ba717e746be62ee01",
        "payment_method": {
            "type": "gb_visa_card",
            "fields": {
                "name": "John Doe",
                "number": "4111111111111111",
                "expiration_month": "05",
                "expiration_year": "25",
                "cvv": "111"
            }
        },
        "payment_method_options": {},
        "save_payment_method": false,
        "complete_payment_url": "https://complete.rapyd.net",
        "error_payment_url": "https://error.rapyd.net"
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "63184b1f-d516-4701-9944-25269ee312db"
        },
        "data": {
            "id": "payment_a19b9f72f135ada8a6e5a4cdd4ec1a56",
            "amount": 10,
            "original_amount": 10,
            "is_partial": false,
            "currency_code": "EUR",
            "country_code": "GB",
            "status": "CLO",
            "description": "Card not saved",
            "merchant_reference_id": "",
            "customer_token": "cus_5bee14584a78638ba717e746be62ee01",
            "payment_method": null,
            "payment_method_data": {
                "id": null,
                "type": "gb_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "name": "John Doe",
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "type": "DEBIT",
                    "brand": "VISA",
                    "level": "CREDIT",
                    "issuer": "JPMORGAN CHASE BANK, N.A.",
                    "country": "US",
                    "bin_number": "411111"
                },
                "expiration_year": "25",
                "expiration_month": "05",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "123456"
            },
            "auth_code": null,
            "expiration": 1716793533,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "https://complete.rapyd.net",
            "error_payment_url": "https://error.rapyd.net",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1716188733,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1716188733,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [],
            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "amount": 10,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "gb_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "not_applicable",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": false
        }
    }
    
  • Payment by card - authorization only

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments
    -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": "EUR",
        "capture": false,
        "description": "payment by card",
        "customer": "cus_5bee14584a78638ba717e746be62ee01",
        "payment_method": {
            "type": "gb_visa_card",
            "fields": {
                "name": "John Doe",
                "number": "4111111111111111",
                "expiration_month": "05",
                "expiration_year": "25",
                "cvv": "111"
            }
        },
        "payment_method_options": {},
        "save_payment_method": true,
        "complete_payment_url": "https://complete.rapyd.net",
        "error_payment_url": "https://error.rapyd.net"
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "137ce58a-6ea1-4594-9fb8-79005966fcd3"
        },
        "data": {
            "id": "payment_a1f8b993484b7d92c6b1f96f2f59da0a",
            "amount": 0,
            "original_amount": 10,
            "is_partial": false,
            "currency_code": "EUR",
            "country_code": "GB",
            "status": "ACT",
            "description": "payment by card",
            "merchant_reference_id": "",
            "customer_token": "cus_5bee14584a78638ba717e746be62ee01",
            "payment_method": "card_f8fd4586847b28955d19b8af57e39e75",
            "payment_method_data": {
                "id": "card_f8fd4586847b28955d19b8af57e39e75",
                "type": "gb_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "name": "John Doe",
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "type": null,
                    "brand": null,
                    "level": null,
                    "country": null,
                    "bin_number": "411111"
                },
                "expiration_year": "25",
                "expiration_month": "05",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "123456"
            },
            "auth_code": null,
            "expiration": 1676469016,
            "captured": false,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "https://complete.rapyd.net",
            "error_payment_url": "https://error.rapyd.net",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1675864216,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [],
            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "amount": 10,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "gb_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "pending_capture",
            "error_code": "",
            "remitter_information": {},
    		"save_payment_method": true
        }
    }
  • Payment by card - CVV required on subsequent payment

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments/
    -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,
        "currency": "ISK",	
        "payment_method": "card_679681841478c99eaa51f85f17eda5d1",
        "customer": "cus_1a85aa5efc5054a34e7cf5100ae08a55",
        "payment_method_options": {
            "cvv": "123"
        },
        "complete_payment_url": "https://complete.rapyd.net",
        "error_payment_url": "https://error.rapyd.net",
        "metadata": {
            "merchant_defined": "created"
        }
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "09e45923-a2c8-4eca-8d98-e1e6ab7122ab"
        },
        "data": {
            "id": "payment_784174fe67814bacc860097c30869238",
            "amount": 100,
            "original_amount": 100,
            "is_partial": false,
            "currency_code": "ISK",
            "country_code": "IS",
            "status": "CLO",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_1a85aa5efc5054a34e7cf5100ae08a55",
            "payment_method": "card_679681841478c99eaa51f85f17eda5d1",
            "payment_method_data": {
                "id": "card_679681841478c99eaa51f85f17eda5d1",
                "type": "is_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "name": "Auto Test",
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "type": "DEBIT",
                    "brand": "VISA",
                    "level": "CREDIT",
                    "issuer": "JPMORGAN CHASE BANK, N.A.",
                    "country": "US",
                    "bin_number": "411111"
                },
                "expiration_year": "24",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": 260750
            },
            "auth_code": null,
            "expiration": 1720436807,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "https://complete.rapyd.net",
            "error_payment_url": "https://error.rapyd.net",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1719832007,
            "metadata": {
                "merchant_defined": "created"
            },
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1719832007,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": ""
                        }
                    ]
                }
            ],
            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "amount": 100,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "is_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "not_applicable",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": false
        }
    }   
  • Verify card - amount set to zero

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments
    -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": 0,
        "currency": "EUR",
        "capture": false,
        "description": "Verify card",
        "customer": "cus_5bee14584a78638ba717e746be62ee01",
        "payment_method": {
            "type": "gb_visa_card",
            "fields": {
                "name": "John Doe",
                "number": "4111111111111111",
                "expiration_month": "05",
                "expiration_year": "25",
                "cvv": "111"
            }
        },
        "payment_method_options": {},
        "save_payment_method": true,
        "complete_payment_url": "https://complete.rapyd.net",
        "error_payment_url": "https://error.rapyd.net"
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "47e3bb96-5c48-4653-887e-40609865f6b6"
        },
        "data": {
            "id": "payment_6b7d7430e86628751ac86a775a27b4a2",
            "amount": 0,
            "original_amount": 0,
            "is_partial": false,
            "currency_code": "EUR",
            "country_code": "GB",
            "status": "ACT",
            "description": "Verify card",
            "merchant_reference_id": "",
            "customer_token": "cus_5bee14584a78638ba717e746be62ee01",
            "payment_method": "card_e101960b0bbc463adb024317109ef464",
            "payment_method_data": {
                "id": "card_e101960b0bbc463adb024317109ef464",
                "type": "gb_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "3d_verification",
                "name": "John Doe",
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "type": null,
                    "brand": null,
                    "level": null,
                    "country": null,
                    "bin_number": "411111"
                },
                "expiration_year": "25",
                "expiration_month": "05",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": 834382
            },
            "auth_code": null,
            "expiration": 1676470543,
            "captured": false,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "https://sandboxcheckout.rapyd.net/3ds-payment?token=payment_6b7d7430e86628751ac86a775a27b4a2",
            "complete_payment_url": "https://complete.rapyd.net",
            "error_payment_url": "https://error.rapyd.net",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1675865743,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "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": "gb_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "3d_verification",
            "error_code": "",
            "remitter_information": {}
    		"save_payment_method": true
        }
    }
  • Cancelable payment

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments
    -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": 101,
    	"currency": "PHP",
    	"description": "Cancelable payment",
    	"payment_method": {
    		"type": "ph_bankatmotc_cash",
    		"fields": {}
    	},
    	"ewallets": [
    		{
    			"ewallet": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
    			"percentage": 100
    		}
    	],
    	"metadata": {
    		"merchant_defined": true
    	}
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "fc585cf4-8f73-42d1-afb6-4882b3781d70"
        },
        "data": {
            "id": "payment_00778be57b9087180596678817973e61",
            "amount": 0,
            "original_amount": 101,
            "is_partial": false,
            "currency_code": "PHP",
            "country_code": "PH",
            "status": "ACT",
            "description": "Cancelable payment",
            "merchant_reference_id": "",
            "customer_token": "cus_907dc0e443fde54d2bbbdde8915a3417",
            "payment_method": "other_cb92f8c4370e36cb1b9f75a30b5ebe61",
            "payment_method_data": {
                "id": "other_cb92f8c4370e36cb1b9f75a30b5ebe61",
                "type": "ph_bankatmotc_cash",
                "category": "cash",
                "metadata": {},
                "image": "",
                "authentication_url": "",
                "webhook_url": "",
                "supporting_documentation": ""
            },
            "expiration": 1623073515,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Rapyd",
            "transaction_id": "",
            "created_at": 1621863915,
            "metadata": {
                "merchant_defined": true
            },
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {
                "code": "8765433177018479"
            },
            "instructions": [],
            "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                    "amount": 101,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "ph_bankatmotc_cash",
            "payment_method_type_category": "cash",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "pending_confirmation"
        }
    }
  • Payment by cash

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments
    -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": "USD",
        "payment_method": {
            "type": "us_duanereade_cash",
            "fields": {
                "first_name": "John",
                "last_name": "Doe"
            }
        },
        "ewallets": [
            {
                "ewallet": "ewallet_07c869a30f93ef0997a60b7efdd8551b",
                "percentage": 100
            }
        ],
        "metadata": {
            "merchant_defined": true
        }
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "1794da93-a720-4020-bde4-c023081bb779"
        },
        "data": {
            "id": "payment_2c05c7d32c42c46e17279b09f6800a58",
            "amount": 0,
            "original_amount": 10,
            "is_partial": false,
            "currency_code": "USD",
            "country_code": "US",
            "status": "ACT",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_925645e7ac6e502f478941aec306808b",
            "payment_method": "other_55a1c0e0115c92730c55ae46b5dcadfd",
            "payment_method_data": {
                "id": "other_55a1c0e0115c92730c55ae46b5dcadfd",
                "type": "us_duanereade_cash",
                "category": "cash",
                "metadata": {},
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "last_name": "Doe",
                "first_name": "John"
            },
            "auth_code": null,
            "expiration": 1705501062,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "N/A",
            "transaction_id": "",
            "created_at": 1704291462,
            "metadata": {
                "merchant_defined": true
            },
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {
                "code": "8765438184374646"
            },
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": "Please visit any one of your nearest participating Duane Reade® stores.",
                            "step2": "Present your barcode to be scanned at the register and the exact $ amount for which the barcode was generated.",
                            "step3": "Provide cash to complete your payment.",
                            "step4": "Keep your receipt as proof of payment."
                        }
                    ]
                }
            ],
            "ewallet_id": "ewallet_07c869a30f93ef0997a60b7efdd8551b",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_07c869a30f93ef0997a60b7efdd8551b",
                    "amount": 10,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "us_duanereade_cash",
            "payment_method_type_category": "cash",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "pending_confirmation",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": true
        }
    }
  • Payment by bank transfer

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments
    -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,
        "currency": "MXN",
        "description": "Payment by bank transfer",
        "payment_method": {
            "type": "mx_spei_bank"
        },
        "ewallets": [
    	{
                "ewallet": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                "percentage": 100
            }
        ],
        "metadata": {
            "merchant_defined": true
        }
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "c088d0f5-43b8-462c-9b03-08ca39718318"
        },
        "data": {
            "id": "payment_e5f67f64269e79bc27a4e29e24970742",
            "amount": 0,
            "original_amount": 100,
            "is_partial": false,
            "currency_code": "MXN",
            "country_code": "mx",
            "status": "ACT",
            "description": "Payment by bank transfer",
            "merchant_reference_id": "",
            "customer_token": "cus_2fc481c596480e0b45f20beb4e7139af",
            "payment_method": "other_7bd131704089d8b8ba867f6ed37457a1",
            "payment_method_data": {
                "id": "other_7bd131704089d8b8ba867f6ed37457a1",
                "type": "mx_spei_bank",
                "category": "bank_transfer",
                "metadata": {},
                "image": "",
                "authentication_url": "",
                "webhook_url": "",
                "supporting_documentation": ""
            },
            "expiration": 1623073903,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Rapyd",
            "transaction_id": "",
            "created_at": 1621864303,
            "metadata": {
                "merchant_defined": true
            },
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {
                "payCode": "100723147534680380"
            },
            "textual_codes": {},
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": "Direct the end-user to make payment to the CLABE provided."
                        }
                    ]
                }
            ],
            "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                    "amount": 100,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "mx_spei_bank",
            "payment_method_type_category": "bank_transfer",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "pending_confirmation"
        }
    }
  • Payment by bank redirect

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments
    -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": 11,
        "currency": "AUD",
        "description": "Payment by bank redirect",
        "payment_method": {
            "type": "au_melbourne_bank",
            "fields": {}
        },
        "capture": null,
        "metadata": {
            "merchant_defined": true
        }
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "df021e55-be21-4224-b091-0e561a9be831"
        },
        "data": {
            "id": "payment_f9000a7a51888e654151c04e6d62caa4",
            "amount": 9,
            "original_amount": 9,
            "is_partial": false,
            "currency_code": "EUR",
            "country_code": "fi",
            "status": "CLO",
            "description": "Payment by bank redirect",
            "merchant_reference_id": "",
            "customer_token": "cus_c25843e1feb5692df6838b64b69f57bc",
            "payment_method": "other_e1c5d34df2125607ca08978929c3dd8f",
            "payment_method_data": {
                "id": "other_e1c5d34df2125607ca08978929c3dd8f",
                "type": "fi_sepadirectdebit_bank",
                "category": "bank_redirect",
                "metadata": {
                    "merchant_defined": true
                },
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "bic_swift": "ABCDEFG1234",
                "account_last4": "6283",
                "language": "es"
            },
            "expiration": 1659081611,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "https://complete.rapyd.net",
            "error_payment_url": "https://error.rapyd.net",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Rapyd",
            "transaction_id": "",
            "created_at": 1653897621,
            "metadata": {
                "merchant_defined": true
            },
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 1653897625,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": {
                "name": "instructions",
                "steps": [{
                        "step1": "The URL can be used for redirecting the user or to forward it to the consumer for signing. This link expires in 60 days or after its first use, whichever comes first."
                    }
                ]
            },
            "ewallet_id": "ewallet_09d9ea7a1ca0a04b8da327905158dc12",
            "ewallets": [{
                    "ewallet_id": "ewallet_09d9ea7a1ca0a04b8da327905158dc12",
                    "amount": 9,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "fi_sepadirectdebit_bank",
            "payment_method_type_category": "bank_redirect",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "not_applicable",
            "error_code": "",
            "remitter_information": {}
        }
    }
  • Payment by local eWallet

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments
    -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": 1000,
    	"currency": "RUB",
    	"payment_method": {
    		"type": "ru_qiwimobile_ewallet",
    		"fields": {}
    	},
    	"ewallets": [
    		{
    			"ewallet": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
    			"percentage": 100
    		}
    	],
    	"metadata": {
    		"merchant_defined": true
    	}
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "9fee0430-7032-4c9b-a3c3-4a9163bd67c7"
        },
        "data": {
            "id": "payment_bebddc4b4139d5a0f13cdcd4046cf2c1",
            "amount": 0,
            "original_amount": 1000,
            "is_partial": false,
            "currency_code": "RUB",
            "country_code": "ru",
            "status": "ACT",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_84806e121d2d8d08b30a5f99822243de",
            "payment_method": "other_75b307d4fc3713e5ca87f1434e9c30cc",
            "payment_method_data": {
                "id": "other_75b307d4fc3713e5ca87f1434e9c30cc",
                "type": "ru_qiwimobile_ewallet",
                "category": "ewallet",
                "metadata": {},
                "image": "",
                "authentication_url": "",
                "webhook_url": "",
                "supporting_documentation": ""
            },
            "expiration": 1623074321,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Rapyd",
            "transaction_id": "",
            "created_at": 1621864721,
            "metadata": {
                "merchant_defined": true
            },
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {
                "code": "paygw_65d788c95eefe636ab45fff9ae81c38d"
            },
            "instructions": [],
            "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                    "amount": 1000,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "ru_qiwimobile_ewallet",
            "payment_method_type_category": "ewallet",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "pending_confirmation"
        }
    }
  • Payment split by amount

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments
    -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,
        "currency": "USD",
        "payment_method": {
            "type": "us_debit_visa_card",
            "fields": {
                "number": "4111111111111111",
                "expiration_month": "10",
                "expiration_year": "23",
                "cvv": "123"
            }
        },
        "description": "Split payment to 2 wallets",
        "capture": true,
        "ewallets": [
            {
                "ewallet": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                "amount": 200
            }, 
            {
                "ewallet": "ewallet_3cd928611934717f283df049a2c7c17e",
                "amount": 50
            }
        ],
        "metadata": {
            "merchant_defined": true
        }
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "db7ba1e8-06fd-4756-a065-29afeeedb030"
        },
        "data": {
            "id": "payment_c3510bde69b860397cd2c2f22c6be9ce",
            "amount": 250,
            "original_amount": 250,
            "is_partial": false,
            "currency_code": "USD",
            "country_code": "US",
            "status": "CLO",
            "description": "Split payment to 2 wallets",
            "merchant_reference_id": "",
            "customer_token": "cus_b1e3cd57eef6cdffb2eeff6492815f06",
            "payment_method": "card_a138f815e322d0651813b62572e8c8ea",
            "payment_method_data": {
                "id": "card_a138f815e322d0651813b62572e8c8ea",
                "type": "us_debit_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "name": null,
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "type": null,
                    "brand": null,
                    "level": null,
                    "country": null,
                    "bin_number": "411111"
                },
                "expiration_year": "23",
                "expiration_month": "10",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "123456"
            },
            "auth_code": null,
            "expiration": 1664198517,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1663593717,
            "metadata": {
                "merchant_defined": true
            },
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1663593717,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [],
            "ewallet_id": null,
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                    "amount": 200,
                    "percent": 80,
                    "refunded_amount": 0
                },
                {
                    "ewallet_id": "ewallet_3cd928611934717f283df049a2c7c17e",
                    "amount": 50,
                    "percent": 20,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "us_debit_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "not_applicable",
            "error_code": "",
            "remitter_information": {}
        }
    }
  • Payment split by percentage

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments
    -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,
        "currency": "USD",
        "payment_method": {
            "type": "us_debit_visa_card",
            "fields": {
                "number": "4111111111111111",
                "expiration_month": "11",
                "expiration_year": "23",
                "cvv": "123",
                "name": "John Doe"
            }
        },
        "description": "Split payment example",
        "ewallets": [
            {
                "ewallet": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                "percentage": 12.05
            },
            {
                "ewallet": "ewallet_3801e782955b29955445586a2405a5db",
                "percentage": 25
            },
            {
                "ewallet": "ewallet_3cd928611934717f283df049a2c7c17e",
                "percentage": null
            }
        ],
        "metadata": {
            "merchant_defined": true
        }
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "c26ed4df-4075-4a8d-84d0-45174de12716"
        },
        "data": {
            "id": "payment_d82a31cf2d82b379cfb3602b1490e6cd",
            "amount": 20,
            "original_amount": 20,
            "is_partial": false,
            "currency_code": "USD",
            "country_code": "US",
            "status": "CLO",
            "description": "Split payment example",
            "merchant_reference_id": "",
            "customer_token": "cus_ceacb689d6e13d200cc99516ba74854e",
            "payment_method": "card_d21748e4504f59900c850579bc7afd4f",
            "payment_method_data": {
                "id": "card_d21748e4504f59900c850579bc7afd4f",
                "type": "us_debit_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "name": "John Doe",
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "type": null,
                    "brand": null,
                    "level": null,
                    "country": null,
                    "bin_number": "411111"
                },
                "expiration_year": "23",
                "expiration_month": "11",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "123456"
            },
            "auth_code": null,
            "expiration": 1664277244,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1663672444,
            "metadata": {
                "merchant_defined": true
            },
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1663672445,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [],
            "ewallet_id": null,
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                    "amount": 2.41,
                    "percent": 12.05,
                    "refunded_amount": 0
                },
                {
                    "ewallet_id": "ewallet_3cd928611934717f283df049a2c7c17e",
                    "amount": 12.59,
                    "percent": 62.95,
                    "refunded_amount": 0
                },
                {
                    "ewallet_id": "ewallet_3801e782955b29955445586a2405a5db",
                    "amount": 5,
                    "percent": 25,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "us_debit_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "not_applicable",
            "error_code": "",
            "remitter_information": {}
        }
    }
  • Payment with payment method options

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments
    -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 '{
        "payment_method": {
            "type": "us_debit_visa_card",
            "fields": {
                "number": "4111111111111111",
                "expiration_month": "10",
                "expiration_year": "23",
                "cvv": "123",
                "name": "John Doe"
            }
        },
        "customer": "cus_0ab3c4c22ad1b8f47bcf89a5d66b2e98",
        "payment_method_options": {
            "3d_required": true
        },
        "metadata": {
            "merchant_defined": "created"
        },
        "amount": 23,
        "ewallet": "ewallet_3cd928611934717f283df049a2c7c17e",
        "currency": "USD"
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "16d0ce2e-213e-459e-a531-ba32543e4bb6"
        },
        "data": {
            "id": "payment_cc7b3500122ba485a3298903931f84d7",
            "amount": 0,
            "original_amount": 23,
            "is_partial": false,
            "currency_code": "USD",
            "country_code": "US",
            "status": "ACT",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_0ab3c4c22ad1b8f47bcf89a5d66b2e98",
            "payment_method": "card_7dbc3831e93fd3ecc72172969a27b693",
            "payment_method_data": {
                "id": "card_7dbc3831e93fd3ecc72172969a27b693",
                "type": "us_debit_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "3d_verification",
                "name": "John Doe",
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "type": null,
                    "brand": null,
                    "level": null,
                    "country": null,
                    "bin_number": "411111"
                },
                "expiration_year": "23",
                "expiration_month": "10",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467"
            },
            "auth_code": null,
            "expiration": 1664277328,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "https://sandboxcheckout.rapyd.net/3ds-payment?token=payment_cc7b3500122ba485a3298903931f84d7",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1663672528,
            "metadata": {
                "merchant_defined": "created"
            },
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [],
            "ewallet_id": "ewallet_3cd928611934717f283df049a2c7c17e",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_3cd928611934717f283df049a2c7c17e",
                    "amount": 23,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {
                "3d_required": true
            },
            "payment_method_type": "us_debit_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "3d_verification",
            "error_code": "",
            "remitter_information": {}
        }
    }
  • Create payment with escrow

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments
    -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": 12,
        "payment_method": {
            "type": "mx_banorte_bank",
            "fields": {}
        },
        "currency": "MXN",
        "error_payment_url": "https://error.example.net",
        "complete_payment_url": "https://complete.example.net",
        "escrow": true,
        "ewallets": [
            {
                "ewallet": "ewallet_93eae39b654ffd2d87a983e7b8e915f4",
                "amount": 12
            }
        ]
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "d21e6b53-355a-4196-86a8-9238136bf687"
        },
        "data": {
            "id": "payment_47095e052bbe16080a402af937f377d3",
            "amount": 0,
            "original_amount": 12,
            "is_partial": false,
            "currency_code": "MXN",
            "country_code": "MX",
            "status": "ACT",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_f9c459ad12ea563475db19e67329f141",
            "payment_method": "other_05b6f2b21b88c56ecb001c8431558a23",
            "payment_method_data": {
                "id": "other_05b6f2b21b88c56ecb001c8431558a23",
                "type": "mx_banorte_bank",
                "category": "bank_redirect",
                "metadata": {},
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "bic_swift": "",
                "account_last4": ""
            },
            "expiration": 1654151194,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "http://sboxredirect.rapyd.net/rdct/r?token=BFm1g0K6PUh",
            "complete_payment_url": "https://complete.example.net",
            "error_payment_url": "https://error.example.net",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Rapyd",
            "transaction_id": "",
            "created_at": 1654064794,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": {
                "name": "instructions",
                "steps": [
                    {
                        "step1": "You will be redirected to a bank payment page to complete the payment"
                    }
                ]
            },
            "ewallet_id": "ewallet_93eae39b654ffd2d87a983e7b8e915f4",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_93eae39b654ffd2d87a983e7b8e915f4",
                    "amount": 12,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "mx_banorte_bank",
            "payment_method_type_category": "bank_redirect",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": {
                "id": "escrow_df0a95af70e696947706cb59bd53d46f",
                "payment": "payment_47095e052bbe16080a402af937f377d3",
                "currency": "MXN",
                "amount_on_hold": 0,
                "total_amount_released": 0,
                "status": "pending",
                "escrow_release_days": null,
                "created_at": 1654064794,
                "updated_at": 1654064794,
                "last_payment_completion": null
            },
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "pending_confirmation",
            "error_code": "",
            "remitter_information": {}
        }
    }
  • Group payment - replace payment

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments
    -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": 30,
        "currency": "EUR",
        "group_payment": "gp_0fdd0950660ed4eaeb130fa6d0297851",
        "metadata": {
            "merchant_defined": "true"
        },
        "payment_method": {
            "type": "de_girogate_bank"
        }
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "ebcb46df-ab74-4dac-abcd-4f4d876d177e"
        },
        "data": {
            "id": "payment_a01bea383e7f81b41e4651bc12db18e9",
            "amount": 0,
            "original_amount": 30,
            "is_partial": false,
            "currency_code": "EUR",
            "country_code": "de",
            "status": "ACT",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_b41b355084d033d1e2e993ae632472c9",
            "payment_method": "other_4b8d02ce749b38cca5a259a270945c88",
            "expiration": 0,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "https://sandbox-gateway.safetypay.com/Express4/Checkout/index?TokenID=eaee17d8-c052-4cd5-8e11-d3f048af87bf&ChannelID=ONLINE&CountryID=DEU",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "",
            "transaction_id": "",
            "created_at": 1574943107,
            "metadata": {
          		"merchant_defined": "true"
        		},
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                      {
                       "step1": "You will be redirected to a bank payment page to complete the payment"
                      }
                    ]
                }
            ],
            "ewallet_id": null,
            "ewallets": [],
            "payment_method_options": {},
            "payment_method_type": "de_girogate_bank",
            "payment_method_type_category": "bank_redirect",
            "fx_rate": "",
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "gp_0fdd0950660ed4eaeb130fa6d0297851"
        }
    }
  • Funding Wallet with FX - fixed side buy

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments
    -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": 400,
        "currency": "EUR",
        "payment_method": {
    		    "type": "mx_spei_bank"
    	  },
        "ewallets": [
        	  {
                "ewallet": "ewallet_3801e782955b29955445586a2405a5db",
                "percentage": 100
            }
        ],
        "expiration": 1626531390,
        "fixed_side": "buy",
        "metadata": {
            "merchant_defined": true
        },
        "requested_currency": "MXN"
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "37a83b8d-7806-495f-9925-20b6f2bc5df7"
        },
        "data": {
            "id": "payment_9745a695dcb17354d1769692712da957",
            "amount": 0,
            "original_amount": 10062.99,
            "is_partial": false,
            "currency_code": "MXN",
            "country_code": "mx",
            "status": "ACT",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_a8ae675d47d861633d902188c01d35f3",
            "payment_method": "other_433780b1e6329525e335c0e04a750db4",
            "payment_method_data": {
                "id": "other_433780b1e6329525e335c0e04a750db4",
                "type": "mx_spei_bank",
                "category": "bank_transfer",
                "metadata": {},
                "image": "",
                "authentication_url": "",
                "webhook_url": "",
                "supporting_documentation": ""
            },
            "expiration": 1623239909,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Rapyd",
            "transaction_id": "",
            "created_at": 1622030309,
            "metadata": {
                "merchant_defined": true
            },
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {
                "payCode": "749648645982463715"
            },
            "textual_codes": {},
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": "Direct the end-user to make payment to the CLABE provided."
                        }
                    ]
                }
            ],
            "ewallet_id": "ewallet_3801e782955b29955445586a2405a5db",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_3801e782955b29955445586a2405a5db",
                    "amount": 400,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "mx_spei_bank",
            "payment_method_type_category": "bank_transfer",
            "fx_rate": 0.03974963,
            "merchant_requested_currency": "EUR",
            "merchant_requested_amount": 400,
            "fixed_side": "buy",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "pending_confirmation"
        }
    }
  • Funding wallet with FX - fixed side sell

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments
    -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": 496,
        "currency": "EUR",
        "ewallets": [
        	  {
                "ewallet": "ewallet_3801e782955b29955445586a2405a5db",
                "percentage": 100
            }
        ],
        "expiration": 1661850500,
        "fixed_side": "sell",
        "metadata": {
            "merchant_defined": true
        },
        "payment_method": {
            "type": "de_visa_card",
            "fields": {
                "number": "4111111111111111",
                "expiration_month": "10",
                "expiration_year": "23",
                "cvv": "123",
                "name": "John Doe"
            }
        },
        "requested_currency": "PHP"
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "cae91cec-6111-4ad5-b895-d289b7ebafc5"
        },
        "data": {
            "id": "payment_c1cda2a0652e57db1a6ad55e34b73a80",
            "amount": 496,
            "original_amount": 496,
            "is_partial": false,
            "currency_code": "EUR",
            "country_code": "de",
            "status": "CLO",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_4a312ec36f5cc51af273884d31375996",
            "payment_method": "card_be0868450fb8f21088def59720ff50ae",
            "payment_method_data": {
                "id": "card_be0868450fb8f21088def59720ff50ae",
                "type": "de_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "authentication_url": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "name": "John Doe",
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "brand": null,
                    "bin_number": "411111"
                },
                "expiration_year": "23",
                "expiration_month": "10",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467"
            },
            "expiration": 1622635369,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Rapyd",
            "transaction_id": "",
            "created_at": 1622030569,
            "metadata": {
                "merchant_defined": true
            },
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1622030569,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": {},
            "ewallet_id": "ewallet_3801e782955b29955445586a2405a5db",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_3801e782955b29955445586a2405a5db",
                    "amount": 28357.74,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "de_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 57.172867,
            "merchant_requested_currency": "PHP",
            "merchant_requested_amount": 28357.74,
            "fixed_side": "sell",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "not_applicable"
        }
    }
  • Payment with initiation type set

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments
    -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": 101,
        "currency": "USD",
        "description": "Payment method token",
        "initiation_type": "moto",
        "payment_method": "other_7f991f72a4c14c5cd79627ebc21241de",
        "ewallets": [
            {
                "ewallet": "ewallet_1290eef66d0b84ece177a3f5bd8fb0c8",
                "percentage": 100
            }
        ],
        "metadata": {
            "merchant_defined": true
        }
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "9f3831a1-3e05-4c20-ae7b-c3a6de8f66a5"
        },
        "data": {
            "id": "payment_c8e22a6116f7c83bab1a081ac4a3e5cd",
            "amount": 0,
            "original_amount": 101,
            "is_partial": false,
            "currency_code": "USD",
            "country_code": "US",
            "status": "ACT",
            "description": "Payment method token",
            "merchant_reference_id": "",
            "customer_token": "cus_bbba43edfcb8bd0ace84fbb1e5b15a73",
            "payment_method": "other_7f991f72a4c14c5cd79627ebc21241de",
            "payment_method_data": {
                "id": "other_7f991f72a4c14c5cd79627ebc21241de",
                "type": "us_stopngo_cash",
                "category": "cash",
                "metadata": {
                    "merchant_defined": "Prime customer"
                },
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable"
            },
            "auth_code": null,
            "expiration": 1664882380,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1663672780,
            "metadata": {
                "merchant_defined": true
            },
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {
                "code": "922635458845940138395842040252"
            },
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": "Please visit any one of your nearest participating Stop-N-Go stores.",
                            "step2": "Present your barcode to be scanned at the register and the exact $ amount for which the barcode was generated.",
                            "step3": "Provide cash to complete your payment.",
                            "step4": "Keep your receipt as proof of payment."
                        }
                    ]
                }
            ],
            "ewallet_id": "ewallet_1290eef66d0b84ece177a3f5bd8fb0c8",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_1290eef66d0b84ece177a3f5bd8fb0c8",
                    "amount": 101,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "us_stopngo_cash",
            "payment_method_type_category": "cash",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "moto",
            "mid": "",
            "next_action": "pending_confirmation",
            "error_code": "",
            "remitter_information": {}
        }
    }
  • Split payment with FX - fixed side buy

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments/
    -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,
        "currency": "EUR",
        "payment_method": {
            "type": "fr_visa_card",
            "fields": {
                "name": "John Doe",
                "number": "4111111111111111",
                "expiration_month": "10",
                "expiration_year": "23",
                "cvv": "123"
            }
        },
        "description": "Split payment with FX - fixed side buy",
        "capture": true,
        "ewallets": [{
                "ewallet": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                "amount": 200
            }, {
                "ewallet": "ewallet_755b0fd11fd22b33328fff7d30f3ce30",
                "amount": 50
            }
        ],
        "expiration": 1626531390,
        "fixed_side": "buy",
        "requested_currency": "USD",
        "metadata": {
            "merchant_defined": true
        }
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "6e7f4f34-e35d-48fd-8136-f79dd6534f06"
        },
        "data": {
            "id": "payment_7baa84f72514e949bce1fd53d0edeac9",
            "amount": 314.87,
            "original_amount": 314.87,
            "is_partial": false,
            "currency_code": "USD",
            "country_code": "fr",
            "status": "CLO",
            "description": "Split payment with FX - fixed side buy",
            "merchant_reference_id": "",
            "customer_token": "cus_8e796469f41b59a20a979d62b2209838",
            "payment_method": "card_e9f7493d18029ec5f2b8be086ae459ce",
            "payment_method_data": {
                "id": "card_e9f7493d18029ec5f2b8be086ae459ce",
                "type": "fr_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "authentication_url": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "name": "John Doe",
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "brand": null,
                    "bin_number": "411111"
                },
                "expiration_year": "23",
                "expiration_month": "10",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467"
            },
            "expiration": 1622544155,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Rapyd",
            "transaction_id": "",
            "created_at": 1621939355,
            "metadata": {
                "merchant_defined": true
            },
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1621939355,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": {},
            "ewallet_id": null,
            "ewallets": [
                {
                    "ewallet_id": "ewallet_755b0fd11fd22b33328fff7d30f3ce30",
                    "amount": 50,
                    "percent": 20,
                    "refunded_amount": 0
                },
                {
                    "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                    "amount": 200,
                    "percent": 80,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "fr_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 0.79397895,
            "merchant_requested_currency": "EUR",
            "merchant_requested_amount": 250,
            "fixed_side": "buy",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "not_applicable"
        }
    }
  • Split payment with FX - fixed side sell

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments/
    -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,
        "currency": "EUR",
        "payment_method": {
            "type": "fr_visa_card",
            "fields": {
                "name": "John Doe",
                "number": "4111111111111111",
                "expiration_month": "10",
                "expiration_year": "23",
                "cvv": "123"
            }
        },
        "description": "Split payment with FX - fixed side sell",
        "capture": true,
        "ewallets": [{
                "ewallet": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                "amount": 200
            }, {
                "ewallet": "ewallet_755b0fd11fd22b33328fff7d30f3ce30",
                "amount": 50
            }
        ],
        "expiration": 1626531790,
        "fixed_side": "sell",
        "requested_currency": "USD",
        "metadata": {
            "merchant_defined": true
        }
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "0b0213b3-62eb-41ca-807f-56943f2e60a6"
        },
        "data": {
            "id": "payment_8bfd0a5c2ab4deafd55f81f73429e063",
            "amount": 250,
            "original_amount": 250,
            "is_partial": false,
            "currency_code": "EUR",
            "country_code": "fr",
            "status": "CLO",
            "description": "Split payment with FX - fixed side sell",
            "merchant_reference_id": "",
            "customer_token": "cus_9bfee226939603040491bac6a2bc868b",
            "payment_method": "card_97d94e4c6dd64b2c010bddc3257c1e5f",
            "payment_method_data": {
                "id": "card_97d94e4c6dd64b2c010bddc3257c1e5f",
                "type": "fr_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "authentication_url": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "name": "John Doe",
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "brand": null,
                    "bin_number": "411111"
                },
                "expiration_year": "23",
                "expiration_month": "10",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467"
            },
            "expiration": 1622544309,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Rapyd",
            "transaction_id": "",
            "created_at": 1621939510,
            "metadata": {
                "merchant_defined": true
            },
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1621939510,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": {},
            "ewallet_id": null,
            "ewallets": [
                {
                    "ewallet_id": "ewallet_755b0fd11fd22b33328fff7d30f3ce30",
                    "amount": 59.25,
                    "percent": 20,
                    "refunded_amount": 0
                },
                {
                    "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                    "amount": 237.01,
                    "percent": 80,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "fr_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 1.18504415,
            "merchant_requested_currency": "USD",
            "merchant_requested_amount": 296.26,
            "fixed_side": "sell",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "not_applicable"
        }
    }
  • Payment with FX - fixed side buy - gross absolute fees

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments/
    -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,
        "currency": "USD",
        "requested_currency": "SGD",
        "fixed_side": "buy",
        "expiration": 1667194081,
        "ewallets": [{
                "ewallet": "ewallet_b329cbcd77c93a0513f83734fa661ec8",
                "percentage": 100
            }
        ],
        "payment_fees": {
            "transaction_fee": {
                "calc_type": "gross",
                "fee_type": "absolute",
                "value": 2
            },
            "fx_fee": {
                "calc_type": "gross",
                "fee_type": "percentage",
                "value": 2.5
            }
        },
        "payment_method": {
            "type": "sg_paynow_bank"
        }
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "1a016ab4-7d48-4383-bee4-be874a29efd2"
        },
        "data": {
            "id": "payment_7c7b9c33885f613ca48c080c8384cb60",
            "amount": 0,
            "original_amount": 152.59,
            "is_partial": false,
            "currency_code": "SGD",
            "country_code": "SG",
            "status": "ACT",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_e32e0a3ed8d6f6420b8837a535e0961e",
            "payment_method": "other_e021373849f7fe18c2c084b554b34d2a",
            "payment_method_data": {
                "id": "other_e021373849f7fe18c2c084b554b34d2a",
                "type": "sg_paynow_bank",
                "category": "bank_transfer",
                "metadata": {},
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "bic_swift": "",
                "account_last4": ""
            },
            "auth_code": null,
            "expiration": 1667194081,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Rapyd",
            "transaction_id": "",
            "created_at": 1667117523,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {
                "PayNow QR": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAe8=="
            },
            "textual_codes": {
                "Payee Name": "Rapyd"
            },
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": "Please scan the QR Code above with your PayNow App, or enter the Paynow ID of the merchant to pay without scanning the code in PayNow support mobile banking application. Please do quote the Payment Reference otherwise there could be delays matching your payment against your transaction."
                        }
                    ]
                }
            ],
            "ewallet_id": null,
            "ewallets": [
                {
                    "ewallet_id": "ewallet_b329cbcd77c93a0513f83734fa661ec8",
                    "amount": 100,
                    "percent": 100,
                    "refunded_amount": 0
                },
                {
                    "ewallet_id": "ewallet_be4ba8f13da40caa59a7e03022a8acfe",
                    "amount": 4.5,
                    "percent": 4.5,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "sg_paynow_bank",
            "payment_method_type_category": "bank_transfer",
            "fx_rate": 0.68483455,
            "merchant_requested_currency": "USD",
            "merchant_requested_amount": 104.5,
            "fixed_side": "buy",
            "payment_fees": {
                "transaction_fee": {
                    "calc_type": "gross",
                    "value": 2,
                    "fee_type": "absolute"
                },
                "fx_fee": {
                    "calc_type": "gross",
                    "value": 2.5
                },
                "gross_fees": 4.5,
                "net_fees": 0,
                "total_merchant_fees": 4.5
            },
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "mid_ac448ec843ffeb1b4639c235d9f933e2",
            "next_action": "pending_confirmation",
            "error_code": "",
            "remitter_information": {}
        }
    }
  • Payment with FX - fixed side buy - net absolute fees

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments/
    -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,
        "currency": "USD",
        "requested_currency": "SGD",
        "fixed_side": "buy",
        "expiration": 1667194081,
        "ewallets": [
        	  {
                "ewallet": "ewallet_b329cbcd77c93a0513f83734fa661ec8",
                "percentage": 100
            }
        ],
      "payment_fees": {
            "transaction_fee": {
                "calc_type": "net",
                "fee_type": "absolute",
                "value": 2
            },
            "fx_fee": {
                "calc_type": "net",
                "fee_type": "percentage",
                "value": 2.5
            }
        },
            "payment_method": {
    		"type": "sg_paynow_bank"
    	}
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "e43586d1-5d38-46ce-980a-2180ad5744ee"
        },
        "data": {
            "id": "payment_0ddf6492ed43c8bfa653ceb4e2e4ec1a",
            "amount": 0,
            "original_amount": 146.02,
            "is_partial": false,
            "currency_code": "SGD",
            "country_code": "SG",
            "status": "ACT",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_f576b8862e97477d032171bb124c49b6",
            "payment_method": "other_169fe3bf7a197af6d0a3913f19d130d8",
            "payment_method_data": {
                "id": "other_169fe3bf7a197af6d0a3913f19d130d8",
                "type": "sg_paynow_bank",
                "category": "bank_transfer",
                "metadata": {},
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "bic_swift": "",
                "account_last4": ""
            },
            "auth_code": null,
            "expiration": 1667194081,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Rapyd",
            "transaction_id": "",
            "created_at": 1667118321,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {
                "PayNow QR": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAe=="
            },
            "textual_codes": {
                "Payee Name": "Rapyd"
            },
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": "Please scan the QR Code above with your PayNow App, or enter the Paynow ID of the merchant to pay without scanning the code in PayNow support mobile banking application. Please do quote the Payment Reference otherwise there could be delays matching your payment against your transaction."
                        }
                    ]
                }
            ],
            "ewallet_id": null,
            "ewallets": [
                {
                    "ewallet_id": "ewallet_b329cbcd77c93a0513f83734fa661ec8",
                    "amount": 95.5,
                    "percent": 95.5,
                    "refunded_amount": 0
                },
                {
                    "ewallet_id": "ewallet_be4ba8f13da40caa59a7e03022a8acfe",
                    "amount": 4.5,
                    "percent": 4.5,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "sg_paynow_bank",
            "payment_method_type_category": "bank_transfer",
            "fx_rate": 0.68483455,
            "merchant_requested_currency": "USD",
            "merchant_requested_amount": 100,
            "fixed_side": "buy",
            "payment_fees": {
                "transaction_fee": {
                    "calc_type": "net",
                    "value": 2,
                    "fee_type": "absolute"
                },
                "fx_fee": {
                    "calc_type": "net",
                    "value": 2.5
                },
                "gross_fees": 0,
                "net_fees": 4.5,
                "total_merchant_fees": 4.5
            },
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "mid_ac448ec843ffeb1b4639c235d9f933e2",
            "next_action": "pending_confirmation",
            "error_code": "",
            "remitter_information": {}
        }
    }
  • Payment with FX - fixed side sell - gross absolute fees

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments/
    -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",
        "currency": "SGD",
        "requested_currency": "USD",
        "fixed_side": "sell",
        "expiration": 1667194081,
        "ewallets": [
            {
                "ewallet": "ewallet_b329cbcd77c93a0513f83734fa661ec8",
                "percentage": 100
            }
        ],
        "payment_fees": {
            "transaction_fee": {
                "calc_type": "gross",
                "fee_type": "absolute",
                "value": 2
            },
            "fx_fee": {
                "calc_type": "gross",
                "fee_type": "percentage",
                "value": 2.5
            }
        },
        "payment_method": {
            "type": "sg_paynow_bank"
        }
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "30d6abc3-2a0d-423a-9046-1f063a0f2cf9"
        },
        "data": {
            "id": "payment_ad4195adfd803334096040cb517a381b",
            "amount": 0,
            "original_amount": 104.5,
            "is_partial": false,
            "currency_code": "SGD",
            "country_code": "SG",
            "status": "ACT",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_64cd6b6a72ea5176b7812a8ec5b9fb41",
            "payment_method": "other_2a98cd03cafb3b54416da8f66d4ebb60",
            "payment_method_data": {
                "id": "other_2a98cd03cafb3b54416da8f66d4ebb60",
                "type": "sg_paynow_bank",
                "category": "bank_transfer",
                "metadata": {},
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "bic_swift": "",
                "account_last4": ""
            },
            "auth_code": null,
            "expiration": 1667194081,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Rapyd",
            "transaction_id": "",
            "created_at": 1667119989,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {
                "PayNow QR": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAe8AA=="
            },
            "textual_codes": {
                "Payee Name": "Rapyd"
            },
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": "Please scan the QR Code above with your PayNow App, or enter the Paynow ID of the merchant to pay without scanning the code in PayNow support mobile banking application. Please do quote the Payment Reference otherwise there could be delays matching your payment against your transaction."
                        }
                    ]
                }
            ],
            "ewallet_id": null,
            "ewallets": [
                {
                    "ewallet_id": "ewallet_b329cbcd77c93a0513f83734fa661ec8",
                    "amount": 68.48,
                    "percent": 100,
                    "refunded_amount": 0
                },
                {
                    "ewallet_id": "ewallet_be4ba8f13da40caa59a7e03022a8acfe",
                    "amount": 3.08,
                    "percent": 4.5,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "sg_paynow_bank",
            "payment_method_type_category": "bank_transfer",
            "fx_rate": 0.68483455,
            "merchant_requested_currency": "USD",
            "merchant_requested_amount": 71.56,
            "fixed_side": "sell",
            "payment_fees": {
                "transaction_fee": {
                    "calc_type": "gross",
                    "value": 2,
                    "fee_type": "absolute"
                },
                "fx_fee": {
                    "calc_type": "gross",
                    "value": 2.5
                },
                "gross_fees": 4.5,
                "net_fees": 0,
                "total_merchant_fees": 3.08
            },
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "mid_ac448ec843ffeb1b4639c235d9f933e2",
            "next_action": "pending_confirmation",
            "error_code": "",
            "remitter_information": {}
        }
    }
  • Payment with FX - fixed side sell - net absolute fees

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments/
    -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": 136,
        "currency": "SGD",
        "requested_currency": "USD",
        "fixed_side": "sell",
        "expiration": 1667194081,
        "ewallets": [
            {
                "ewallet": "ewallet_b329cbcd77c93a0513f83734fa661ec8",
                "percentage": 100
            }
        ],
        "payment_fees": {
            "transaction_fee": {
                "calc_type": "net",
                "fee_type": "absolute",
                "value": 2
            },
            "fx_fee": {
                "calc_type": "net",
                "fee_type": "percentage",
                "value": 2.5
            }
        },
        "payment_method": {
            "type": "sg_paynow_bank"
        }
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "eab14217-e85a-4334-bd8c-aafdfa069187"
        },
        "data": {
            "id": "payment_5329f760190327f73fa257ad122d2e4a",
            "amount": 0,
            "original_amount": 136,
            "is_partial": false,
            "currency_code": "SGD",
            "country_code": "SG",
            "status": "ACT",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_cd2eef1d1e5749150afc448033b4c8f5",
            "payment_method": "other_4b0b3baddc3f56709765bfb91c219465",
            "payment_method_data": {
                "id": "other_4b0b3baddc3f56709765bfb91c219465",
                "type": "sg_paynow_bank",
                "category": "bank_transfer",
                "metadata": {},
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "bic_swift": "",
                "account_last4": ""
            },
            "auth_code": null,
            "expiration": 1667194081,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Rapyd",
            "transaction_id": "",
            "created_at": 1667120561,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {
                "PayNow QR": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAe=="
            },
            "textual_codes": {
                "Payee Name": "Rapyd"
            },
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": "Please scan the QR Code above with your PayNow App, or enter the Paynow ID of the merchant to pay without scanning the code in PayNow support mobile banking application. Please do quote the Payment Reference otherwise there could be delays matching your payment against your transaction."
                        }
                    ]
                }
            ],
            "ewallet_id": null,
            "ewallets": [
                {
                    "ewallet_id": "ewallet_b329cbcd77c93a0513f83734fa661ec8",
                    "amount": 89.44,
                    "percent": 96.03,
                    "refunded_amount": 0
                },
                {
                    "ewallet_id": "ewallet_be4ba8f13da40caa59a7e03022a8acfe",
                    "amount": 3.7,
                    "percent": 3.97,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "sg_paynow_bank",
            "payment_method_type_category": "bank_transfer",
            "fx_rate": 0.68483455,
            "merchant_requested_currency": "USD",
            "merchant_requested_amount": 93.14,
            "fixed_side": "sell",
            "payment_fees": {
                "transaction_fee": {
                    "calc_type": "net",
                    "value": 2,
                    "fee_type": "absolute"
                },
                "fx_fee": {
                    "calc_type": "net",
                    "value": 2.5
                },
                "gross_fees": 0,
                "net_fees": 5.4,
                "total_merchant_fees": 3.7
            },
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "mid_ac448ec843ffeb1b4639c235d9f933e2",
            "next_action": "pending_confirmation",
            "error_code": "",
            "remitter_information": {}
        }
    }
  • Payment by card - 3DS required

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments/
    -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 '{
        "payment_method": {
            "type": "us_debit_visa_card",
            "fields": {
                "number": "4111111111111111",
                "expiration_month": "11",
                "expiration_year": "23",
                "cvv": "123",
                "name": "John Doe"
            }
        },
        "customer": "cus_0ab3c4c22ad1b8f47bcf89a5d66b2e98",
        "payment_method_options": {
            "3d_required": true
        },
        "metadata": {
            "merchant_defined": "created"
        },
        "amount": 23,
        "ewallet": "ewallet_3cd928611934717f283df049a2c7c17e",
        "currency": "USD"
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "b3ef6f28-c7d0-405f-a43e-ad610410acf3"
        },
        "data": {
            "id": "payment_ef108534486afc4916b905ed7836d766",
            "amount": 0,
            "original_amount": 23,
            "is_partial": false,
            "currency_code": "USD",
            "country_code": "US",
            "status": "ACT",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_0ab3c4c22ad1b8f47bcf89a5d66b2e98",
            "payment_method": "card_3f394ef0df47ee2cd1d11e459e2fbdff",
            "payment_method_data": {
                "id": "card_3f394ef0df47ee2cd1d11e459e2fbdff",
                "type": "us_debit_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "3d_verification",
                "name": "John Doe",
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "type": null,
                    "brand": null,
                    "level": null,
                    "country": null,
                    "bin_number": "411111"
                },
                "expiration_year": "23",
                "expiration_month": "11",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467"
            },
            "auth_code": null,
            "expiration": 1664277810,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "https://sandboxcheckout.rapyd.net/3ds-payment?token=payment_ef108534486afc4916b905ed7836d766",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1663673010,
            "metadata": {
                "merchant_defined": "created"
            },
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [],
            "ewallet_id": "ewallet_3cd928611934717f283df049a2c7c17e",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_3cd928611934717f283df049a2c7c17e",
                    "amount": 23,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {
                "3d_required": true
            },
            "payment_method_type": "us_debit_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "3d_verification",
            "error_code": "",
            "remitter_information": {}
        }
    }
  • Client Details for 3DS

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments/
    -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": 12.73,
        "currency": "USD",
        "payment_method": {
            "type": "us_debit_visa_card",
            "fields": {
                "number": "4111111111111111",
                "expiration_month": "12",
                "expiration_year": "23",
                "cvv": "345",
                "name": "John Doe"
            }
        },
        "ewallets": [
            {
                "ewallet": "ewallet_e67c8ad63200d781470a04107fbd7c59",
                "percentage": 100
            }
        ],
        "metadata": {
            "merchant_defined": "created"
        },
        "client_details": {
            "time_zone_offset": 300,
            "language": "en-US",
            "java_enabled": true,
            "java_script_enabled": true,
            "screen_color_depth": 16,
            "screen_height": 768,
            "screen_width": 1024,
            "accept_header": "text/html",
            "ip_address": "162.162.162.162"
        }
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "c1914605-61d7-45ab-b663-82e7655937ff"
        },
        "data": {
            "id": "payment_b2aeabdca8722a68025e582f4c191cec",
            "amount": 12.73,
            "original_amount": 12.73,
            "is_partial": false,
            "currency_code": "USD",
            "country_code": "US",
            "status": "CLO",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_4e71af7edfc8a12f9a69dc71a88dfafc",
            "payment_method": "card_defadbfa66837ae05d257850e5897943",
            "payment_method_data": {
                "id": "card_defadbfa66837ae05d257850e5897943",
                "type": "us_debit_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "name": "John Doe",
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "type": null,
                    "brand": null,
                    "level": null,
                    "country": null,
                    "bin_number": "411111"
                },
                "expiration_year": "23",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "123456"
            },
            "auth_code": null,
            "expiration": 1664278061,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1663673261,
            "metadata": {
                "merchant_defined": "created"
            },
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1663673261,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [],
            "ewallet_id": "ewallet_e67c8ad63200d781470a04107fbd7c59",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_e67c8ad63200d781470a04107fbd7c59",
                    "amount": 12.73,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "us_debit_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "not_applicable",
            "error_code": "",
            "remitter_information": {}
        }
    }
  • Payment - Customer Object

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments/
    -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": 36,
        "currency": "BOB",
        "customer": {
            "name": "John Doe"
        },
        "payment_method": {
            "type": "bo_express_cash"
        },
        "metadata": {
            "merchant_defined": "created"
        }
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "a5026930-962d-4831-90d1-8132984c140e"
        },
        "data": {
            "id": "payment_d1c3f5d84eb3458b5e7add265e5ce4fb",
            "amount": 0,
            "original_amount": 36,
            "is_partial": false,
            "currency_code": "BOB",
            "country_code": "BO",
            "status": "ACT",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_20375da56d207592a81d19252ffeebc0",
            "payment_method": "other_ab22fdec36d645323259b21eb0fd4e5b",
            "payment_method_data": {
                "id": "other_ab22fdec36d645323259b21eb0fd4e5b",
                "type": "bo_express_cash",
                "category": "cash",
                "metadata": {},
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable"
            },
            "auth_code": null,
            "expiration": 0,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Rapyd",
            "transaction_id": "",
            "created_at": 1667384655,
            "metadata": {
                "merchant_defined": "created"
            },
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {
                "paycode": "9068126232569512"
            },
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": "Write down the Agreement Code “Pago Express - Servicios en Linea para Rapyd” and your Payment Reference",
                            "step2": "Visit the nearest Pago Express location",
                            "step3": "Tell the agent you want to make a payment for “Pago Express - Servicios en Linea para Rapyd”",
                            "step4": "Provide your Payment Reference to the agent",
                            "step5": "Provide your payment in cash",
                            "step6": "Receive your receipt, and done!"
                        }
                    ]
                },
                {
                    "name": "instrucciones",
                    "steps": [
                        {
                            "step1": "Apunta el convenio del servicio (“Pago Express - Servicios en Linea para Rapyd”) y tu número de referencia (Payment Reference)",
                            "step2": "Visitar el punto de pago más cercano de Pago Express",
                            "step3": "Informarle al agente de Pago Express que deseas hacer un pago de “Pago Express - Servicios en Linea para Rapyd”",
                            "step4": "Compartir tu número de referencia (Payment Reference) con el agente",
                            "step5": "Entregarle el efectivo",
                            "step6": "Recibir tu recibo, y listo!"
                        }
                    ]
                }
            ],
            "ewallet_id": "ewallet_be4ba8f13da40caa59a7e03022a8acfe",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_be4ba8f13da40caa59a7e03022a8acfe",
                    "amount": 36,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "bo_express_cash",
            "payment_method_type_category": "cash",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "pending_confirmation",
            "error_code": "",
            "remitter_information": {}
        }
    }
  • Account funding transaction - 'person' wallet

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments/
    -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": 1.07,
        "currency": "EUR",
        "description": "Account Funding Transaction",
        "capture": true,
        "ewallet": "ewallet_4d4b74f67ddf7cd8fd9ea33bf72aa3bd",
        "complete_payment_url": "https://complete.example.net",
        "error_payment_url": "https://error.example.net",
        "payment_method": {
            "type": "nl_visa_card",
            "fields": {
                "number": "4111111111111111",
                "expiration_month": "11",
                "expiration_year": "23",
                "cvv": "123",
                "name": "John Doe"
            }
        },
        "payment_method_options": {
            "aft": true
        }
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "851d1197-b7b0-43b2-a3c1-1353e227cf75"
        },
        "data": {
            "id": "payment_bafcc78a0542ef64f3bbd145c130690c",
            "amount": 1.07,
            "original_amount": 1.07,
            "is_partial": false,
            "currency_code": "EUR",
            "country_code": "NL",
            "status": "CLO",
            "description": "Account Funding Transaction",
            "merchant_reference_id": "",
            "customer_token": "cus_77dbcd9f07c1d78a7702a46a3d8c1d4e",
            "payment_method": "card_38f74ed0a42211b2c9a08aa945074875",
            "payment_method_data": {
                "id": "card_38f74ed0a42211b2c9a08aa945074875",
                "type": "nl_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "name": "John Doe",
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "type": "CREDIT",
                    "brand": "VISA",
                    "level": "CLASSIC",
                    "country": "NL",
                    "bin_number": "411111"
                },
                "expiration_year": "23",
                "expiration_month": "11",
                "fingerprint_token": "ocfp_c6abbccb3440fcb0fc34ae14126607fa"
            },
            "auth_code": "003603",
            "expiration": 1676218030,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "https://complete.example.net",
            "error_payment_url": "https://error.example.net",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1675613230,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1675613232,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": ""
                        }
                    ]
                }
            ],
            "ewallet_id": "ewallet_4d4b74f67ddf7cd8fd9ea33bf72aa3bd",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_4d4b74f67ddf7cd8fd9ea33bf72aa3bd",
                    "amount": 1.07,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {
                "aft": true
            },
            "payment_method_type": "nl_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "mid_7b624b32f161313347d554138d81858",
            "next_action": "not_applicable",
            "error_code": "",
            "remitter_information": {}
        }
    }
  • Cryptocurrency transaction - 'person' wallet

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments/
    -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": 1.07,
        "currency": "EUR",
        "description": "Cryptocurrency Transaction - Person Wallet",
        "capture": true,
        "ewallet": "ewallet_4d4b74f67ddf7cd8fd9ea33bf72aa3bd",
        "complete_payment_url": "https://complete.example.net",
        "error_payment_url": "https://error.example.net",
        "payment_method": {
            "type": "nl_visa_card",
            "fields": {
                "number": "4111111111111111",
                "expiration_month": "11",
                "expiration_year": "27",
                "cvv": "123",
                "name": "John Doe"
            }
        },
        "payment_method_options": {
            "special_condition_indicator": "cryptocurrency"
        }
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "a0fb4d99-5b6f-4d25-83c7-6ab228752706"
        },
        "data": {
            "id": "payment_cf70d29bad2a0f97e079518e3533964c",
            "amount": 1.07,
            "original_amount": 1.07,
            "is_partial": false,
            "currency_code": "EUR",
            "country_code": "NL",
            "status": "CLO",
            "description": "Cryptocurrency Transaction - Person Wallet",
            "merchant_reference_id": "",
            "customer_token": "cus_77dbcd9f07c1d78a7702a46a3d8c1d4e",
    		"payment_method": "card_49a46de5c81124c4a1b63cc254253412",
            "payment_method_data": {
                "id": "card_49a46de5c81124c4a1b63cc254253412",
                "type": "nl_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "name": "John Doe",
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "type": "CREDIT",
                    "brand": "VISA",
                    "level": "CLASSIC",
                    "country": "NL",
                    "bin_number": "411111"
                },
                "expiration_year": "27",
                "expiration_month": "11",
                "fingerprint_token": "ocfp_c6abbccb3440fcb0fc34ae14126607fa"
            },
            "auth_code": "003603",
            "expiration": 1728211544,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "https://complete.example.net",
            "error_payment_url": "https://error.example.net",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1727606745,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1727606747,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": ""
                        }
                    ]
                }
            ],
            "ewallet_id": "ewallet_4d4b74f67ddf7cd8fd9ea33bf72aa3bd",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_4d4b74f67ddf7cd8fd9ea33bf72aa3bd",
                    "amount": 1.07,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {
                "aft": true,
                "special_condition_indicator": "cryptocurrency"
            },
            "payment_method_type": "nl_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "mid_7b624b32f161313347d554138d81858",
            "next_action": "not_applicable",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": false		
        }
    }
  • Payment with network reference ID

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments
    -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": 11.0,
        "currency": "GBP",
        "payment_method": {
            "type": "at_visa_card",
            "fields": {
                "number": "4111111111111111",
                "expiration_month": "12",
                "expiration_year": "23",
                "network_reference_id": "123456",
                "name": "John Doe"
            }
        },
        "metadata": {
            "merchant_defined": "true"
        }
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "e544f263-adbf-4c47-bf05-e521eef9a059"
        },
        "data": {
            "id": "payment_8d0bb8de9c6b0d30772ffc217533301e",
            "amount": 11,
            "original_amount": 11,
            "is_partial": false,
            "currency_code": "GBP",
            "country_code": "is",
            "status": "CLO",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_7592e2618a6eff2b84c25f2bc4ea0b44",
            "payment_method": "card_61bd781a57774deadbb9d67334420703",
            "payment_method_data": {
                "id": "card_61bd781a57774deadbb9d67334420703",
                "type": "at_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "name": "John Doe",
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "type": null,
                    "brand": null,
                    "country": null,
                    "bin_number": "411111"
                },
                "expiration_year": "26",
                "expiration_month": "11",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": 343474
            },
            "auth_code": null,
            "expiration": 1672735073,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1672130273,
            "metadata": {
                "merchant_defined": "true"
            },
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1672130273,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": {},
            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "amount": 11,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "at_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "not_applicable",
            "error_code": "",
            "remitter_information": {}
        }
    }
  • Account funding transaction via business

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments/
    -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": 1.04,
        "currency": "EUR",
        "customer": "cus_77dbcd9f07c1d78a7702a46a3d8c1d4e",
        "description": "Account Funding Transaction - Business",
        "capture": true,
        "complete_payment_url": "https://complete.example.net",
        "error_payment_url": "https://error.example.net",
        "payment_method": {
            "type": "nl_visa_card",
            "fields": {
                "number": "4111111111111111",
                "expiration_month": "11",
                "expiration_year": "23",
                "cvv": "456",
                "name": "John Doe"
            }
        },
        "payment_method_options": {
            "aft": true
        }
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "c719720b-7d8d-45a1-90fd-43ac806c5f81"
        },
        "data": {
            "id": "payment_f26869f8a6f37f81811bed9128d9e099",
            "amount": 1.04,
            "original_amount": 1.04,
            "is_partial": false,
            "currency_code": "EUR",
            "country_code": "NL",
            "status": "CLO",
            "description": "Account Funding Transaction - Business",
            "merchant_reference_id": "",
            "customer_token": "cus_77dbcd9f07c1d78a7702a46a3d8c1d4e",
            "payment_method": "card_7dee1547b8e5d636c0ff125f4e42224f",
            "payment_method_data": {
                "id": "card_7dee1547b8e5d636c0ff125f4e42224f",
                "type": "nl_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "name": "John Doe",
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "type": "CREDIT",
                    "brand": "VISA",
                    "level": "CLASSIC",
                    "country": "NL",
                    "bin_number": "411111"
                },
                "expiration_year": "23",
                "expiration_month": "11",
                "fingerprint_token": "ocfp_b15e327899e8442532224577126e24b4"
            },
            "auth_code": "032059",
            "expiration": 1676208274,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "https://complete.example.net",
            "error_payment_url": "https://error.example.net",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1675603474,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1675603475,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": ""
                        }
                    ]
                }
            ],
            "ewallet_id": "ewallet_20becfae6ed603c94fe7306103bcc5c5",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_20becfae6ed603c94fe7306103bcc5c5",
                    "amount": 1.04,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {
                "aft": true
            },
            "payment_method_type": "nl_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "mid_6a713a21f050402258d663049d919847",
            "next_action": "not_applicable",
            "error_code": "",
            "remitter_information": {}
        }
    }
  • Cryptocurrency transaction via business

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments/
    -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": 1.04,
        "currency": "EUR",
        "customer": "cus_77dbcd9f07c1d78a7702a46a3d8c1d4e",
        "description": "Cryptocurrency Transaction - Business",
        "capture": true,
        "complete_payment_url": "https://complete.example.net",
        "error_payment_url": "https://error.example.net",
        "payment_method": {
            "type": "nl_visa_card",
            "fields": {
                "number": "4111111111111111",
                "expiration_month": "11",
                "expiration_year": "27",
                "cvv": "456",
                "name": "John Doe"
            }
        },
        "payment_method_options": {
            "special_condition_indicator": "cryptocurrency"
        }
    }
    '
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "cc3b696c-5dbf-499c-86c2-be5d514556c6"
        },
        "data": {
            "id": "payment_56f3eb8ec543a3962ce112b4f03da9ae",
            "amount": 1.04,
            "original_amount": 1.04,
            "is_partial": false,
            "currency_code": "EUR",
            "country_code": "NL",
            "status": "CLO",
            "description": "Cryptocurrency Transaction - Business",
            "merchant_reference_id": "",
            "customer_token": "cus_77dbcd9f07c1d78a7702a46a3d8c1d4e",
            "payment_method": "card_27a4c2f05d9ebd1700f5338e155c1ced",
            "payment_method_data": {
                "id": "card_27a4c2f05d9ebd1700f5338e155c1ced",
                "type": "nl_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "name": "John Doe",
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "type": "CREDIT",
                    "brand": "VISA",
                    "level": "CLASSIC",
                    "country": "NL",
                    "bin_number": "411111"
                },
                "expiration_year": "27",
                "expiration_month": "11",
                "fingerprint_token": "ocfp_b15e327899e8442532224577126e24b4"
            },
            "auth_code": "032059",
            "expiration": 1728211544,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "https://complete.example.net",
            "error_payment_url": "https://error.example.net",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1727606745,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1727606747,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": ""
                        }
                    ]
                }
            ],
            "ewallet_id": "ewallet_20becfae6ed603c94fe7306103bcc5c5",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_20becfae6ed603c94fe7306103bcc5c5",
                    "amount": 1.04,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {
                "aft": true,
                "special_condition_indicator": "cryptocurrency"
            },
            "payment_method_type": "nl_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "mid_6a713a21f050402258d663049d919847",
            "next_action": "not_applicable",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": false		
        }
    }
  • Payment with TAVV

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments/
    -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,
        "currency": "USD",
        "capture": true,
        "save_payment_method": true,
        "payment_method": {
            "type": "it_visa_card",
            "fields": {
                "name": "John Doe",
                "number": "4111111111111111",
                "expiration_month": "12",
                "expiration_year": "30",
                "cvv": "123",
                "number_type": "TPAN"
            }
        },
        "payment_method_options": {
            "tavv": "ACSczA=="
        }
    }
    '
  •  {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "7d74d9ad-aa1d-48d1-9b08-b87072a5419e"
        },
        "data": {
            "id": "payment_ca8a05a2711ae9abc92efda4002d270a",
            "amount": 250,
            "original_amount": 250,
            "is_partial": false,
            "currency_code": "USD",
            "country_code": "it",
            "status": "CLO",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_f0530667898889be024a95f850ca89e1",
            "payment_method": "card_1f689621c68fadf72f2cea0bba48cae2",
            "payment_method_data": {
                "id": "card_1f689621c68fadf72f2cea0bba48cae2",
                "type": "it_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "name": "John Doe",
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "type": "CREDIT",
                    "brand": "VISA",
                    "level": null,
                    "issuer": "JPMORGAN CHASE BANK, N.A.",
                    "country": "US",
                    "bin_number": "411111"
                },
                "number_type": "TPAN",
                "expiration_year": "30",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_99795b7a947e95d98c337bcc3aa0bd72"
            },
            "auth_code": null,
            "expiration": 1707743274,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "N/A",
            "transaction_id": "",
            "created_at": 1707138474,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1707138475,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": {},
            "ewallet_id": "ewallet_bcad4157ffae36fd13e44c57a4dcafeb",
            "ewallets": [{
                    "ewallet_id": "ewallet_bcad4157ffae36fd13e44c57a4dcafeb",
                    "amount": 250,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "it_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "not_applicable",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": true
        }
    }
    
     
    
  • Payment with External 3DS Provider

  • curl -X post
    https://sandboxapi.rapyd.net/v1/payments/
    -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": "EUR",
        "capture": false,
        "description": "payment by card",
        "customer": "cus_5bee14584a78638ba717e746be62ee01",
        "payment_method": {
            "type": "is_visa_card",
            "fields": {
                "name": "John Doe",
                "number": "4111111111111111",
                "expiration_month": "05",
                "expiration_year": "25",
                "cvv": "111"
            }
        },
        "payment_method_options": {
            "3d_version": "2.2.0",
            "cavv": "BwABBYcyOCdlg0QChDI4EHUURgE",
            "eci": "05",       
            "ds_trans_id": "1b20b229-8676-5812-8000-000000617fbb"
        },
        "save_payment_method": true,
        "complete_payment_url": "https://complete.rapyd.net",
        "error_payment_url": "https://error.rapyd.net"
    }
    '
  •  {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "1f1159b0-6f64-49fa-9691-06db0a25bcca"
        },
        "data": {
            "id": "payment_7b8bed939df382e1fe61472387bc638c",
            "amount": 0,
            "original_amount": 10,
            "is_partial": false,
            "currency_code": "EUR",
            "country_code": "IS",
            "status": "ACT",
            "description": "payment by card",
            "merchant_reference_id": "",
            "customer_token": "cus_5bee14584a78638ba717e746be62ee01",
            "payment_method": "card_81d6b21911eab794cda8541213dec10d",
            "payment_method_data": {
                "id": "card_81d6b21911eab794cda8541213dec10d",
                "type": "is_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "name": "John Doe",
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "type": "DEBIT",
                    "brand": "VISA",
                    "level": "CREDIT",
                    "issuer": "JPMORGAN CHASE BANK, N.A.",
                    "country": "US",
                    "bin_number": "411111"
                },
                "expiration_year": "25",
                "expiration_month": "05",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "123456"
            },
            "auth_code": null,
            "expiration": 1709025524,
            "captured": false,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "",
            "complete_payment_url": "https://complete.rapyd.net",
            "error_payment_url": "https://error.rapyd.net",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1708420724,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": ""
                        }
                    ]
                }
            ],
            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "amount": 10,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {
                "eci": "05",
                "cavv": "BwABBYcyOCdlg0QChDI4EHUURgE",
                "3d_version": "2.2.0",
                "ds_trans_id": "1b20b229-8676-5812-8000-000000617fbb"
            },
            "payment_method_type": "is_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 1,
            "merchant_requested_currency": null,
            "merchant_requested_amount": null,
            "fixed_side": "",
            "payment_fees": null,
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "pending_capture",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": true
        }
    }