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.

Payment Facilitator (PayFac) Card payments: As a PayFac, your sub-merchant can collect funds from a card payment, and you can direct the funds to your client wallet. The collected funds are settled via the PayFac’s client wallet. See the sample 'Payment with Merchant Wallet' on this page and the Creating a Card Payment workflow.

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.

Prerequisites

Response Errors

For error examples, see Create Payment Error Examples.

For more information on errors, refer to the following pages:

Related Information

    • 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

    • merchant_ewallet

    • The sub-merchant’s ewallet ID. For the ewallet parameter, you can either provide the ewallet ID of your Payment Facilitator (PayFac) client wallet, or omit it from the payment request. See also the sample 'Payment with Merchant Wallet'.

      Relevant and required for a PayFac. As a PayFac, you can create a card payment and direct the funds that the sub-merchant collects to your client wallet.

    • 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.

      Note

      In the sandbox, card details are removed after six months.

      • true - Save the payment method for future use.

      • false - Do not save the payment method.

      false

  • /v1/payments

  • 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' \
    --data-raw '{
    	"amount": 45.00,
    	"currency": "E",
    	"customer": "cus_4e25112ac20e144ad073a614dc46934b",
    	"description": "Payment by customer's default payment method" 
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "5e81e0ba-2495-4a7f-babc-5b6e820db572"
        },
        "data": {
            "id": "payment_d31d3ca850419ab5e2f9f1a33f9c6eea",
            "amount": 45,
            "original_amount": 45,
            "is_partial": false,
            "currency_code": "EUR",
            "country_code": "GB",
            "status": "CLO",
            "description": "Payment by customer's default payment method",
            "merchant_reference_id": "",
            "customer_token": "cus_4e25112ac20e144ad073a614dc46934b",
            "payment_method": null,
            "payment_method_data": {
                "id": null,
                "type": "gb_visa_card",
                "category": "card",
                "metadata": {},
                "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": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "expiration_year": "35",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "507150",
                "payment_account_reference": "V00180MCW82MN270KDRQO8AJNBBMJ"
            },
            "auth_code": null,
            "expiration": 1756896871,
            "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": 1756292071,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1756292071,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [],
            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "amount": 45,
                    "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,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "amount": 101,
        "currency": "USD",
        "description": "Payment method ID",
        "payment_method": "card_b9548d9b53a565b2315fecdc6c87f158"
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "9a5cbd17-7034-4146-bb4f-c1aa67641a69"
        },
        "data": {
            "id": "payment_5b8372a7ea0e4a1b5f40013f06ce0c2e",
            "amount": 101,
            "original_amount": 101,
            "is_partial": false,
            "currency_code": "USD",
            "country_code": "GB",
            "status": "CLO",
            "description": "Payment method ID",
            "merchant_reference_id": "",
            "customer_token": "cus_4e25112ac20e144ad073a614dc46934b",
            "payment_method": null,
            "payment_method_data": {
                "id": null,
                "type": "gb_visa_card",
                "category": "card",
                "metadata": {},
                "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": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "expiration_year": "35",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "507150",
                "payment_account_reference": "V001H302ZOJ8ZHQO5U9LTVFOHI1MF"
            },
            "auth_code": null,
            "expiration": 1761571693,
            "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": 1760966893,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1760966894,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [],
            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "amount": 101,
                    "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,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "amount": 100,
        "currency": "EUR",
        "customer": "cus_a97ac31867f1e2e9903fc2cb936241a7",
        "payment_method": {
            "type": "au_visa_card",
            "fields": {
                "number": "4111111111111111",
                "expiration_month": "12",
                "expiration_year": "29",
                "name": "John Doe",
                "cvv": "345",
                "date_of_birth": "12/25/1960"
            }
        }
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "0a0549f8-6cd0-4120-beeb-a475485a4d67"
        },
        "data": {
            "id": "payment_0793a55c14f73cd4898b403f542aab85",
            "amount": 100,
            "original_amount": 100,
            "is_partial": false,
            "currency_code": "EUR",
            "country_code": "au",
            "status": "CLO",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_a97ac31867f1e2e9903fc2cb936241a7",
            "payment_method": null,
            "payment_method_data": {
                "id": null,
                "type": "au_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": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "date_of_birth": "12/25/1960",
                "expiration_year": "29",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "123456",
                "payment_account_reference": "V0011ABFUQ72WJTXWAJRLT9KHXDAM"
            },
            "auth_code": null,
            "expiration": 1755697998,
            "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": 1755093198,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1755093199,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [],
            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "amount": 100,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "au_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,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' /
    --data-raw '{
        "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": "12",
                "expiration_year": "30",
                "cvv": "111"
            }
        },
        "payment_method_options": {},
        "complete_payment_url": "https://complete.rapyd.net",
        "error_payment_url": "https://error.rapyd.net",
        "customer": "cus_4e25112ac20e144ad073a614dc46934b",
        "save_payment_method": true,
        "initiation_type": "customer_present"
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "26f33e0b-d540-45d0-9da1-02fb3600e40f"
        },
        "data": {
            "id": "payment_8f486badb0600445e8501a1117913aab",
            "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_4e25112ac20e144ad073a614dc46934b",
            "payment_method": "card_7df57df7ba27b8e5442c1b8362dd8c4a",
            "payment_method_data": {
                "id": "card_7df57df7ba27b8e5442c1b8362dd8c4a",
                "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": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "expiration_year": "30",
                "recurrence_type": "installment",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "123456",
                "payment_account_reference": "V001IO6MP4LYWPSMQJKSU376SJVP8"
            },
            "auth_code": null,
            "expiration": 1761571984,
            "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": 1760967183,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1760967184,
            "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": true,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "amount": 1000,
        "currency": "ISK",
        "capture": true,	
        "description": "Use saved payment method",
        "payment_method": "card_b9548d9b53a565b2315fecdc6c87f158",
        "customer": "cus_4e25112ac20e144ad073a614dc46934b",
        "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": "9797053a-4ed7-48c8-a010-9829eaadd373"
        },
        "data": {
            "id": "payment_d42b0eba249e8779bd19fca3f136b4bf",
            "amount": 1000,
            "original_amount": 1000,
            "is_partial": false,
            "currency_code": "ISK",
            "country_code": "GB",
            "status": "CLO",
            "description": "Use saved payment method",
            "merchant_reference_id": "",
            "customer_token": "cus_4e25112ac20e144ad073a614dc46934b",
            "payment_method": null,
            "payment_method_data": {
                "id": null,
                "type": "gb_visa_card",
                "category": "card",
                "metadata": {},
                "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": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "expiration_year": "35",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "507150",
                "payment_account_reference": "V001R7EI1NNF3C1PNV6EJ27UT2IFF"
            },
            "auth_code": null,
            "expiration": 1761572326,
            "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": 1760967526,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1760967526,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [],
            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "amount": 1000,
                    "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": "recurring",
            "mid": "",
            "next_action": "not_applicable",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": false,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "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": "101c050e-a57d-4b77-b62e-cc7e27e2cc40"
        },
        "data": {
            "id": "payment_dcdfd5e8b50105995a2a20f886e76896",
            "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": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "expiration_year": "30",
                "expiration_month": "05",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "123456",
                "payment_account_reference": "V001L2NFT7238QXAY976FD35LV0E7"
            },
            "auth_code": null,
            "expiration": 1755700958,
            "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": 1755096158,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1755096158,
            "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,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "amount": 10,
        "currency": "EUR",
        "capture": false,
        "description": "payment by card",
        "customer": "cus_4e25112ac20e144ad073a614dc46934b",
        "payment_method": {
            "type": "gb_visa_card",
            "fields": {
                "name": "John Doe",
                "number": "4111111111111111",
                "expiration_month": "05",
                "expiration_year": "30",
                "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": "ae837c95-db07-4141-a181-762c4f3d68ba"
        },
        "data": {
            "id": "payment_8f7974b9fa8a3518e15ac2719b99bf72",
            "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_4e25112ac20e144ad073a614dc46934b",
            "payment_method": "card_59b2438d5c603dd5bc4374a25421399c",
            "payment_method_data": {
                "id": "card_59b2438d5c603dd5bc4374a25421399c",
                "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": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "expiration_year": "30",
                "expiration_month": "05",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "123456"
            },
            "auth_code": null,
            "expiration": 1761572536,
            "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": 1760967736,
            "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,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "amount": 100,
        "currency": "ISK",	
        "payment_method": "card_b9548d9b53a565b2315fecdc6c87f158",
        "customer": "cus_4e25112ac20e144ad073a614dc46934b",
        "payment_method_options": {
            "cvv": "123"
        },
        "complete_payment_url": "https://complete.rapyd.net",
        "error_payment_url": "https://error.rapyd.net"
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "52887c3e-7820-4d22-988c-bfacb6170b5b"
        },
        "data": {
            "id": "payment_0528e3c662b8e75e32b02aa2c36136ec",
            "amount": 100,
            "original_amount": 100,
            "is_partial": false,
            "currency_code": "ISK",
            "country_code": "GB",
            "status": "CLO",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_4e25112ac20e144ad073a614dc46934b",
            "payment_method": null,
            "payment_method_data": {
                "id": null,
                "type": "gb_visa_card",
                "category": "card",
                "metadata": {},
                "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": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "expiration_year": "35",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "507150",
                "payment_account_reference": "V001W9RBI5BF1FT1D3D8TJNZ7QQW3"
            },
            "auth_code": null,
            "expiration": 1761572661,
            "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": 1760967861,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1760967862,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [],
            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "amount": 100,
                    "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,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • Payment by card - merchant advice in response

  • 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' \
    --data-raw '{
        "amount": 15,
        "currency": "ISK",
        "capture": true,
        "description": "Merchant Advice",
        "payment_method": {
            "type": "gb_mastercard_card",
            "fields": {
                "number": "4111111111111111",
                "expiration_month": "12",
                "expiration_year": "30",
                "cvv": "111",
                "name": "John Doe"
            }
        },
        "payment_method_options": {
            "3d_required": true
        },
        "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": "8b263aba-c111-4cbf-885c-cbd90ac42503"
        },
        "data": {
            "id": "payment_318dfb3b60912e7706b7643742af5804",
            "amount": 0,
            "original_amount": 15,
            "is_partial": false,
            "currency_code": "ISK",
            "country_code": "GB",
            "status": "ACT",
            "description": "Merchant Advice",
            "merchant_reference_id": "",
            "customer_token": "cus_32befb4da17552376fa6bd6b51bca001",
            "payment_method": null,
            "payment_method_data": {
                "id": null,
                "type": "gb_mastercard_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": "DEBIT",
                    "brand": "VISA",
                    "level": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "expiration_year": "30",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "payment_account_reference": "V001VW8O890ECBPBDQDCX8BUYOH28",
                "network_reference_id": "853100"
            },
            "auth_code": null,
            "expiration": 1761466717,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "https://sandboxcheckout.rapyd.net/3ds-payment?token=payment_318dfb3b60912e7706b7643742af5804",
            "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": 1760861917,
            "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": 15,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {
                "3d_required": true
            },
            "payment_method_type": "gb_mastercard_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": false,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "authentication_result": {
                "eci": null,
                "result": "R",
                "version": "2.2.0",
                "cardholder_info": null
            },
            "transaction_link_id": null
        }
    }
  • Verify card with ANI - 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' \
    --data-raw '{
        "amount": 0,
        "currency": "GBP",
        "capture": false,
        "save_payment_method": true,
        "customer": {
            "name": "John",
            "email": "johndoe@rapyd.net"
        },
        "payment_method": {
            "type": "gb_visa_card",
            "full_name": {
                "first_name": "John",
                "middle_name": "Johnson",
                "last_name": "Doe"
            },
            "fields": {
                "number": "4111111111111111",
                "expiration_month": "02",
                "expiration_year": "27",
                "name": "John Doe",
                "cvv": "345"
            }
        }
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "f3097094-df3f-4f19-a19c-d07156ec40de"
        },
        "data": {
            "id": "payment_5a32b5989155ba3b75454edba4f52401",
            "amount": 0,
            "original_amount": 0,
            "is_partial": false,
            "currency_code": "GBP",
            "country_code": "GB",
            "status": "ACT",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_c14579755a7f069a7a8ffa7245aa17cf",
            "payment_method": null,
            "payment_method_data": {
                "id": null,
                "type": "gb_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "3d_verification",
                "full_name": {
                    "first_name": "John",
                    "middle_name": "Johnson",
                    "last_name": "Doe"
                },
                "account_name_inquiry": {
                    "account_name_inquiry_result": "not_performed",
                    "account_name_inquiry_details": {
                        "last_name": null,
                        "first_name": null,
                        "middle_name": null
                    }
                },
                "name": "John Doe",
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "type": "DEBIT",
                    "brand": "VISA",
                    "level": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "expiration_year": "27",
                "expiration_month": "02",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "payment_account_reference": "V00173Z6DA132UM78105DND4YLZMU",
                "network_reference_id": "828761"
            },
            "auth_code": null,
            "expiration": 1761572794,
            "captured": false,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "https://sandboxcheckout.rapyd.net/3ds-payment?token=payment_5a32b5989155ba3b75454edba4f52401",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1760967994,
            "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,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "authentication_result": {
                "eci": null,
                "result": "R",
                "version": "2.2.0",
                "cardholder_info": null
            },
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
    	"amount": 101,
    	"currency": "PHP",
    	"description": "Cancelable payment",
    	"customer": "cus_4e25112ac20e144ad073a614dc46934b",
    	"payment_method": {
    		"type": "ph_general_fsm_ewallet",
    		"fields": {}
    	}
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "1bd54073-4207-428e-971f-108230838372"
        },
        "data": {
            "id": "payment_4fb5a4f6c82eb1c5dea943ab9b450f5d",
            "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_4e25112ac20e144ad073a614dc46934b",
            "payment_method": "other_320dcc4bb4b962f442f602f4a7a2afec",
            "payment_method_data": {
                "id": "other_320dcc4bb4b962f442f602f4a7a2afec",
                "type": "ph_general_fsm_ewallet",
                "category": "ewallet",
                "metadata": {},
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "bic_swift": "",
                "account_last4": ""
            },
            "auth_code": null,
            "expiration": 1762178312,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "https://sandboxcheckout.rapyd.net/complete-bank-payment?token=payment_4fb5a4f6c82eb1c5dea943ab9b450f5d",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1760968712,
            "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": 101,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "ph_general_fsm_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",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": false,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "amount": 100,
        "currency": "MXN",
        "customer": "cus_4e25112ac20e144ad073a614dc46934b",
        "description": "Payment by cash",
        "payment_method": {
            "type": "mx_spei_bank"
        }
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "8c01bd8d-8cc2-40cd-9b7d-50151b53bb6f"
        },
        "data": {
            "id": "payment_8f76c41fa45b3016b46f714b27ef47fe",
            "amount": 0,
            "original_amount": 100,
            "is_partial": false,
            "currency_code": "MXN",
            "country_code": "MX",
            "status": "ACT",
            "description": "Payment by cash",
            "merchant_reference_id": "",
            "customer_token": "cus_4e25112ac20e144ad073a614dc46934b",
            "payment_method": "other_2f64289cbce38467f45720f146302860",
            "payment_method_data": {
                "id": "other_2f64289cbce38467f45720f146302860",
                "type": "mx_spei_bank",
                "category": "bank_transfer",
                "metadata": {},
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "bic_swift": "",
                "account_last4": ""
            },
            "auth_code": null,
            "expiration": 1762178900,
            "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": 1760969300,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {
                "payCode": "459270824744130595"
            },
            "textual_codes": {},
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": "Direct the end-user to make payment to the CLABE provided."
                        }
                    ]
                }
            ],
            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "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",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": false,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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"
        }
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "fd8f3b20-c5e8-42bf-82a5-74df4445d2f1"
        },
        "data": {
            "id": "payment_6db1a89314cdd7ff8665070a6755534a",
            "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_4e25112ac20e144ad073a614dc46934b",
            "payment_method": "other_3b39d0b9d3018b52377270f0e6f82826",
            "payment_method_data": {
                "id": "other_3b39d0b9d3018b52377270f0e6f82826",
                "type": "mx_spei_bank",
                "category": "bank_transfer",
                "metadata": {},
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "bic_swift": "",
                "account_last4": ""
            },
            "auth_code": null,
            "expiration": 1762179734,
            "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": 1760970134,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {
                "payCode": "326743511987408013"
            },
            "textual_codes": {},
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": "Direct the end-user to make payment to the CLABE provided."
                        }
                    ]
                }
            ],
            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "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",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": false,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "amount": 1100,
        "currency": "COP",
        "description": "Payment by bank redirect",
        "payment_method": {
            "type": "co_bancodebogota_bank",
            "fields": {}
        }
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "d664359e-2274-452a-b442-7988721e368b"
        },
        "data": {
            "id": "payment_9b640b3c77fd9043be758fd05c9d5306",
            "amount": 0,
            "original_amount": 1100,
            "is_partial": false,
            "currency_code": "COP",
            "country_code": "CO",
            "status": "ACT",
            "description": "Payment by bank redirect",
            "merchant_reference_id": "",
            "customer_token": "cus_5c0d74aa77120294c507bc5ae87c7746",
            "payment_method": "other_b868ad9de6e08014cb432b1f706648bc",
            "payment_method_data": {
                "id": "other_b868ad9de6e08014cb432b1f706648bc",
                "type": "co_bancodebogota_bank",
                "category": "bank_redirect",
                "metadata": {},
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "bic_swift": "",
                "account_last4": ""
            },
            "auth_code": null,
            "expiration": 1762180022,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "https://sandboxcheckout.rapyd.net/complete-bank-payment?token=payment_9b640b3c77fd9043be758fd05c9d5306",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1760970422,
            "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_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "amount": 1100,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "co_bancodebogota_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": "pending_confirmation",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": false,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
    	"amount": 1000,
    	"currency": "BRL",
    	"payment_method": {
    		"type": "br_pix_ewallet",
    		"fields": {
    			"address_name": "John Doe",
    			"first_name": "John",
    			"last_name": "Doe",
    			"address_line_1": "123 First Street",
    			"address_city": "Anytown",
    			"address_zip": "12345",
    			"address_state": "Bahia",
    			"phone_number": "551234566789",
    			"email": "johndoe@rapyd.net",
    			"product_name": "Groceries",
    			"cpf|cnpj": "12345678901234"
    		}
    	}
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "0646b767-8628-438e-8476-0f7eacca255c"
        },
        "data": {
            "id": "payment_6396e20c4a3556aa6dfc1bda0021c403",
            "amount": 0,
            "original_amount": 1000,
            "is_partial": false,
            "currency_code": "BRL",
            "country_code": "BR",
            "status": "ACT",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_a71a661a63d2339ce12fe38665c6d8b7",
            "payment_method": "other_73799e35e9496b7dc85374a6d34fecd3",
            "payment_method_data": {
                "id": "other_73799e35e9496b7dc85374a6d34fecd3",
                "type": "br_pix_ewallet",
                "category": "ewallet",
                "metadata": {},
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "bic_swift": "",
                "account_last4": "",
                "email": "johndoe@rapyd.net",
                "cpf|cnpj": "12345678901234",
                "last_name": "Doe",
                "first_name": "John",
                "address_zip": "12345",
                "address_city": "Anytown",
                "address_name": "John Doe",
                "phone_number": "551234566789",
                "product_name": "Groceries",
                "address_state": "Bahia",
                "address_line_1": "123 First Street"
            },
            "auth_code": null,
            "expiration": 1761575923,
            "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": 1760971123,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {
                "code": "paygw_011aa946a596c3e9d42106cfc4395c4a"
            },
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": "Please scan the QR Code with your PIX supported app."
                        },
                        {
                            "step2": "Alternatively, copy the PIX code and upload it using your PIX supported app."
                        },
                        {
                            "step3": "The QR code is single-use only. Once payment is successful, the QR code is expired"
                        }
                    ]
                }
            ],
            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "amount": 1000,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "br_pix_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",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": false,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "amount": 2500,
        "currency": "COP",
        "customer": "cus_4e25112ac20e144ad073a614dc46934b",
        "payment_method": {
            "type": "co_debit_visa_card",
            "fields": {
                "number": "4111111111111111",
                "expiration_month": "12",
                "expiration_year": "30",
                "cvv": "123"
            }
        },
        "description": "Split payment to 2 wallets",
        "capture": true,
        "ewallets": [
            {
                "ewallet": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                "amount": 2000
            }, 
            {
                "ewallet": "ewallet_3cd928611934717f283df049a2c7c17e",
                "amount": 500
            }
        ]
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "af17c55d-6ff0-4463-9d3b-85915bfbbb8b"
        },
        "data": {
            "id": "payment_644730370884e6449603317e862b7bb4",
            "amount": 0,
            "original_amount": 2500,
            "is_partial": false,
            "currency_code": "COP",
            "country_code": "co",
            "status": "ACT",
            "description": "Split payment to 2 wallets",
            "merchant_reference_id": "",
            "customer_token": "cus_4e25112ac20e144ad073a614dc46934b",
            "payment_method": null,
            "payment_method_data": {
                "id": null,
                "type": "co_debit_visa_card",
                "category": "card",
                "metadata": null,
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "3d_verification",
                "name": null,
                "last4": "1111",
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "type": "DEBIT",
                    "brand": "VISA",
                    "level": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "expiration_year": "30",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "payment_account_reference": "V001ZE59ZSD31COAQDNZM630MFFPK",
                "network_reference_id": "135002"
            },
            "auth_code": null,
            "expiration": 1761577084,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "https://sandboxcheckout.rapyd.net/3ds-payment?token=payment_644730370884e6449603317e862b7bb4",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1760972284,
            "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": [
                {
                    "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                    "amount": 2000,
                    "percent": 80,
                    "refunded_amount": 0
                },
                {
                    "ewallet_id": "ewallet_3cd928611934717f283df049a2c7c17e",
                    "amount": 500,
                    "percent": 20,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "co_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": {},
            "save_payment_method": false,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "authentication_result": {
                "eci": null,
                "result": "R",
                "version": "2.2.0",
                "cardholder_info": null
            },
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "amount": 1000,
        "currency": "COP",
        "payment_method": {
            "type": "co_debit_visa_card",
            "fields": {
                "number": "4111111111111111",
                "expiration_month": "12",
                "expiration_year": "30",
                "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
            }
        ]
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "c04949b0-2500-41c9-960f-0ab6ece341cd"
        },
        "data": {
            "id": "payment_f2a09ce82a27f6f13b7e86415922a302",
            "amount": 1000,
            "original_amount": 1000,
            "is_partial": false,
            "currency_code": "COP",
            "country_code": "co",
            "status": "CLO",
            "description": "Split payment by amount",
            "merchant_reference_id": "",
            "customer_token": "cus_e6e8c34d8d3949e5438483fa55b5f0d1",
            "payment_method": null,
            "payment_method_data": {
                "id": null,
                "type": "co_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": "DEBIT",
                    "brand": "VISA",
                    "level": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "expiration_year": "30",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "123456",
                "payment_account_reference": "V001F5VE0G8TJ4JVPE96K78KOXADM"
            },
            "auth_code": null,
            "expiration": 1761577367,
            "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": 1760972567,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1760972567,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [],
            "ewallet_id": null,
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                    "amount": 120.5,
                    "percent": 12.05,
                    "refunded_amount": 0
                },
                {
                    "ewallet_id": "ewallet_3cd928611934717f283df049a2c7c17e",
                    "amount": 629.5,
                    "percent": 62.95,
                    "refunded_amount": 0
                },
                {
                    "ewallet_id": "ewallet_3801e782955b29955445586a2405a5db",
                    "amount": 250,
                    "percent": 25,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "co_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": {},
            "save_payment_method": false,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "amount": 1000,
        "currency": "COP",
        "payment_method": {
            "type": "co_debit_visa_card",
            "fields": {
                "number": "4111111111111111",
                "expiration_month": "12",
                "expiration_year": "30",
                "cvv": "123",
                "name": "John Doe"
            }
        },
        "customer": "cus_4e25112ac20e144ad073a614dc46934b",
        "payment_method_options": {
            "3d_required": true
        }
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "fe5e22d6-a554-4665-8732-ed7f5e14b1b9"
        },
        "data": {
            "id": "payment_447d1b745274a6794d44f311cf9321b7",
            "amount": 0,
            "original_amount": 1000,
            "is_partial": false,
            "currency_code": "COP",
            "country_code": "co",
            "status": "ACT",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_4e25112ac20e144ad073a614dc46934b",
            "payment_method": null,
            "payment_method_data": {
                "id": null,
                "type": "co_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": "DEBIT",
                    "brand": "VISA",
                    "level": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "expiration_year": "30",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "payment_account_reference": "V001L3XSHUPFUJL6RIKU2CBS6XKVL",
                "network_reference_id": "560217"
            },
            "auth_code": null,
            "expiration": 1761637504,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "https://sandboxcheckout.rapyd.net/3ds-payment?token=payment_447d1b745274a6794d44f311cf9321b7",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1761032704,
            "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_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "amount": 1000,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {
                "3d_required": true
            },
            "payment_method_type": "co_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": {},
            "save_payment_method": false,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "authentication_result": {
                "eci": null,
                "result": "R",
                "version": "2.2.0",
                "cardholder_info": null
            },
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw
     '{
     	"amount": 45.00,
    	"currency": "EUR",
    	"customer": "cus_4e25112ac20e144ad073a614dc46934b",
        "error_payment_url": "https://error.rapyd.net",
        "complete_payment_url": "https://complete.rapyd.net",
        "escrow": true
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "803daf8e-4c5d-4da0-a011-10c7b8225b50"
        },
        "data": {
            "id": "payment_a7f40f90f6140a9f69459284330ee6f2",
            "amount": 45,
            "original_amount": 45,
            "is_partial": false,
            "currency_code": "EUR",
            "country_code": "GB",
            "status": "CLO",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_4e25112ac20e144ad073a614dc46934b",
            "payment_method": null,
            "payment_method_data": {
                "id": null,
                "type": "gb_visa_card",
                "category": "card",
                "metadata": {},
                "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": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "expiration_year": "35",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "507150",
                "payment_account_reference": "V001YTLVBTQVMTBJSCKQMORGLB9UT"
            },
            "auth_code": null,
            "expiration": 1756899358,
            "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": 1756294558,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1756294559,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [],
            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "amount": 45,
                    "percent": 100,
                    "released_amount": 0,
                    "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": {
                "id": "escrow_6c435c866b0377496599225bc780a82a",
                "payment": "payment_a7f40f90f6140a9f69459284330ee6f2",
                "currency": "EUR",
                "amount_on_hold": 45,
                "total_amount_released": 0,
                "status": "on_hold",
                "escrow_release_days": null,
                "created_at": 1756294558,
                "updated_at": 1756294558,
                "last_payment_completion": 1756294559
            },
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "not_applicable",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": false,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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": "GBP",
        "group_payment": "gp_07823bc646fab8d16d6d7807a5eabcb3",
        "payment_method": {
            "type": "gb_visa_extended_card"
        }
    }
    '
  • {
        "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",		
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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'
    --data-raw '{
        "amount": 400,
        "currency": "EUR",
        "payment_method": {
    		    "type": "mx_spei_bank"
    	  },
        "ewallets": [
        	  {
                "ewallet": "ewallet_3801e782955b29955445586a2405a5db",
                "percentage": 100
            }
        ],
        "customer": "cus_a97ac31867f1e2e9903fc2cb936241a7",
        "expiration": 1762000000,
        "fixed_side": "buy",
        "requested_currency": "MXN"
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "a4470f03-66a5-4e8c-84d1-0ef4dd72e324"
        },
        "data": {
            "id": "payment_d810643e550805289f95f8ba5665099f",
            "amount": 0,
            "original_amount": 8772.2,
            "is_partial": false,
            "currency_code": "MXN",
            "country_code": "MX",
            "status": "ACT",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_a97ac31867f1e2e9903fc2cb936241a7",
            "payment_method": "other_c6bfa3b39104dfefafa051ead7430d73",
            "payment_method_data": {
                "id": "other_c6bfa3b39104dfefafa051ead7430d73",
                "type": "mx_spei_bank",
                "category": "bank_transfer",
                "metadata": {},
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "bic_swift": "",
                "account_last4": ""
            },
            "auth_code": null,
            "expiration": 1762000000,
            "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": 1761049030,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {
                "payCode": "779373207299697011"
            },
            "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.0455986132,
            "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",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": false,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "amount": 496,
        "currency": "EUR",
        "ewallets": [
        	  {
                "ewallet": "ewallet_3801e782955b29955445586a2405a5db",
                "percentage": 100
            }
        ],
        "expiration": 1762000000,
        "fixed_side": "sell",
        "payment_method": {
            "type": "de_visa_card",
            "fields": {
                "number": "4111111111111111",
                "expiration_month": "12",
                "expiration_year": "30",
                "cvv": "123",
                "name": "John Doe"
            }
        },
        "requested_currency": "PHP"
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "417ef430-4a50-45ce-8554-133abc961530"
        },
        "data": {
            "id": "payment_8adec4c23b13247b915fbc81e1b8efcc",
            "amount": 496,
            "original_amount": 496,
            "is_partial": false,
            "currency_code": "EUR",
            "country_code": "DE",
            "status": "CLO",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_c90999c059bd38606dcdb26d6489df3c",
            "payment_method": null,
            "payment_method_data": {
                "id": null,
                "type": "de_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": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "expiration_year": "30",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "123456",
                "payment_account_reference": "V001TA6C8B14G1AOZGW4WTSHGYAW9"
            },
            "auth_code": null,
            "expiration": 1761654767,
            "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": 1761049967,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1761049967,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": ""
                        }
                    ]
                }
            ],
            "ewallet_id": "ewallet_3801e782955b29955445586a2405a5db",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_3801e782955b29955445586a2405a5db",
                    "amount": 28785.81,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "de_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 58.0359022372,
            "merchant_requested_currency": "PHP",
            "merchant_requested_amount": 28785.81,
            "fixed_side": "sell",
            "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,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "amount": 101,
        "currency": "USD",
        "description": "Payment method token",
        "initiation_type": "moto",
        "payment_method": "other_a6482588e94ae3d8d4cb40302af9f6ba",
        "ewallets": [
            {
                "ewallet": "ewallet_1290eef66d0b84ece177a3f5bd8fb0c8",
                "percentage": 100
            }
        ]
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "8c71cba9-7446-4838-a23a-1b7fe325bd7e"
        },
        "data": {
            "id": "payment_daf596331170740554021e4594eb698c",
            "amount": 0,
            "original_amount": 101,
            "is_partial": false,
            "currency_code": "USD",
            "country_code": "CO",
            "status": "ACT",
            "description": "Payment method token",
            "merchant_reference_id": "",
            "customer_token": "cus_a97ac31867f1e2e9903fc2cb936241a7",
            "payment_method": "other_a6482588e94ae3d8d4cb40302af9f6ba",
            "payment_method_data": {
                "id": "other_a6482588e94ae3d8d4cb40302af9f6ba",
                "type": "co_bancocolpatria_bank",
                "category": "bank_redirect",
                "metadata": {},
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "bic_swift": "",
                "account_last4": ""
            },
            "auth_code": null,
            "expiration": 1762259999,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "https://sandboxcheckout.rapyd.net/complete-bank-payment?token=payment_daf596331170740554021e4594eb698c",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1761050399,
            "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_1290eef66d0b84ece177a3f5bd8fb0c8",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_1290eef66d0b84ece177a3f5bd8fb0c8",
                    "amount": 101,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "co_bancocolpatria_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": "moto",
            "mid": "",
            "next_action": "pending_confirmation",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": false,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "amount": 250,
        "currency": "EUR",
        "payment_method": {
            "type": "fr_visa_card",
            "fields": {
                "name": "John Doe",
                "number": "4111111111111111",
                "expiration_month": "12",
                "expiration_year": "30",
                "cvv": "123"
            }
        },
        "description": "Split payment with FX - fixed side buy",
        "capture": true,
        "ewallets": [{
                "ewallet": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                "amount": 200
            }, {
                "ewallet": "ewallet_755b0fd11fd22b33328fff7d30f3ce30",
                "amount": 50
            }
        ],
        "expiration": 1762000000,
        "fixed_side": "buy",
        "requested_currency": "USD"
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "933ea003-66d5-4de9-912b-cadb59794cf7"
        },
        "data": {
            "id": "payment_a0549e7cf6ad209a573d5a7361ce601b",
            "amount": 268.4,
            "original_amount": 268.4,
            "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_ceb45419d8b22afe8781ed218818c1e1",
            "payment_method": null,
            "payment_method_data": {
                "id": null,
                "type": "fr_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": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "expiration_year": "30",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "123456",
                "payment_account_reference": "V001YVNRQY67A64R9PAOOFIG1PHSC"
            },
            "auth_code": null,
            "expiration": 1761656884,
            "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": 1761052084,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1761052084,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": ""
                        }
                    ]
                }
            ],
            "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.9314382272,
            "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",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": false,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "amount": 250,
        "currency": "EUR",
        "payment_method": {
            "type": "fr_visa_card",
            "fields": {
                "name": "John Doe",
                "number": "4111111111111111",
                "expiration_month": "12",
                "expiration_year": "30",
                "cvv": "123"
            }
        },
        "description": "Split payment with FX - fixed side sell",
        "capture": true,
        "ewallets": [{
                "ewallet": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                "amount": 200
            }, {
                "ewallet": "ewallet_755b0fd11fd22b33328fff7d30f3ce30",
                "amount": 50
            }
        ],
        "expiration": 1762000000,
        "fixed_side": "sell",
        "requested_currency": "USD"
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "3ce7f3c9-0c67-43a5-8385-5f6f5db4af79"
        },
        "data": {
            "id": "payment_9dcf74d2a4681f5de1bddb2156067d60",
            "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_29dd99aec2202665b0f0da4bb5a3626c",
            "payment_method": null,
            "payment_method_data": {
                "id": null,
                "type": "fr_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": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "expiration_year": "30",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "123456",
                "payment_account_reference": "V001BS2EW8PN20ABVRT52157GV2ND"
            },
            "auth_code": null,
            "expiration": 1761657091,
            "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": 1761052291,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1761052291,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": ""
                        }
                    ]
                }
            ],
            "ewallet_id": null,
            "ewallets": [
                {
                    "ewallet_id": "ewallet_755b0fd11fd22b33328fff7d30f3ce30",
                    "amount": 50.2,
                    "percent": 20,
                    "refunded_amount": 0
                },
                {
                    "ewallet_id": "ewallet_c67c44ec60d5c2e62480aa7c76b3f8b4",
                    "amount": 200.78,
                    "percent": 80,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "fr_visa_card",
            "payment_method_type_category": "card",
            "fx_rate": 1.0039151914,
            "merchant_requested_currency": "USD",
            "merchant_requested_amount": 250.98,
            "fixed_side": "sell",
            "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,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "amount": 100,
        "currency": "USD",
        "requested_currency": "MXN",
        "fixed_side": "buy",
        "expiration": 1762000000,
        "payment_fees": {
            "transaction_fee": {
                "calc_type": "gross",
                "fee_type": "absolute",
                "value": 2
            },
            "fx_fee": {
                "calc_type": "gross",
                "fee_type": "percentage",
                "value": 2.5
            }
        },
        "customer": "cus_a97ac31867f1e2e9903fc2cb936241a7",
        "payment_method": {
            "type": "mx_spei_bank"
        }
    }'
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "f1c553d7-04f1-48ce-9a4e-df239733ff87"
        },
        "data": {
            "id": "payment_ae1e1ef5719bd4d0ca71d72cbc7db176",
            "amount": 0,
            "original_amount": 2207.45,
            "is_partial": false,
            "currency_code": "MXN",
            "country_code": "MX",
            "status": "ACT",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_a97ac31867f1e2e9903fc2cb936241a7",
            "payment_method": "other_1755d26eb3489268fa0645318ebca583",
            "payment_method_data": {
                "id": "other_1755d26eb3489268fa0645318ebca583",
                "type": "mx_spei_bank",
                "category": "bank_transfer",
                "metadata": {},
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "bic_swift": "",
                "account_last4": ""
            },
            "auth_code": null,
            "expiration": 1762000000,
            "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": 1761052557,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {
                "payCode": "040469329057821981"
            },
            "textual_codes": {},
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": "Direct the end-user to make payment to the CLABE provided."
                        }
                    ]
                }
            ],
            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "amount": 104.5,
                    "percent": 104.5,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "mx_spei_bank",
            "payment_method_type_category": "bank_transfer",
            "fx_rate": 0.0473397546,
            "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": 0.09
            },
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "pending_confirmation",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": false,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "amount": 100,
        "currency": "USD",
        "requested_currency": "MXN",
        "fixed_side": "buy",
        "expiration": 1762000000,
        "payment_fees": {
            "transaction_fee": {
                "calc_type": "net",
                "fee_type": "absolute",
                "value": 2
            },
            "fx_fee": {
                "calc_type": "net",
                "fee_type": "percentage",
                "value": 2.5
            }
        },
        "customer": "cus_a97ac31867f1e2e9903fc2cb936241a7",
        "payment_method": {
            "type": "mx_spei_bank"
    	}
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "c9ff8b8d-a16d-469f-83d5-75098acf6fdc"
        },
        "data": {
            "id": "payment_7edadab53e57316c302ebffeafa85598",
            "amount": 0,
            "original_amount": 2112.39,
            "is_partial": false,
            "currency_code": "MXN",
            "country_code": "MX",
            "status": "ACT",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_a97ac31867f1e2e9903fc2cb936241a7",
            "payment_method": "other_1c397ae612b0ff4a848dbb76f5cd95cc",
            "payment_method_data": {
                "id": "other_1c397ae612b0ff4a848dbb76f5cd95cc",
                "type": "mx_spei_bank",
                "category": "bank_transfer",
                "metadata": {},
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "bic_swift": "",
                "account_last4": ""
            },
            "auth_code": null,
            "expiration": 1762000000,
            "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": 1761052891,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {
                "payCode": "029244068804912021"
            },
            "textual_codes": {},
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": "Direct the end-user to make payment to the CLABE provided."
                        }
                    ]
                }
            ],
            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "amount": 100,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "mx_spei_bank",
            "payment_method_type_category": "bank_transfer",
            "fx_rate": 0.0473397546,
            "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": 0.09
            },
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "pending_confirmation",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": false,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "amount": "100",
        "currency": "MXN",
        "requested_currency": "USD",
        "fixed_side": "sell",
        "expiration": 1762000000,
        "payment_fees": {
            "transaction_fee": {
                "calc_type": "gross",
                "fee_type": "absolute",
                "value": 2
            },
            "fx_fee": {
                "calc_type": "gross",
                "fee_type": "percentage",
                "value": 2.5
            }
        },
        "customer": "cus_a97ac31867f1e2e9903fc2cb936241a7",
        "payment_method": {
            "type": "mx_spei_bank"
        }
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "1607277e-e451-43a4-8299-3a3279b5eff6"
        },
        "data": {
            "id": "payment_73544bd6294b3f1315737ef12a0bde2d",
            "amount": 0,
            "original_amount": 104.5,
            "is_partial": false,
            "currency_code": "MXN",
            "country_code": "MX",
            "status": "ACT",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_a97ac31867f1e2e9903fc2cb936241a7",
            "payment_method": "other_dd91ebada37988afdbda2eb6f9de603e",
            "payment_method_data": {
                "id": "other_dd91ebada37988afdbda2eb6f9de603e",
                "type": "mx_spei_bank",
                "category": "bank_transfer",
                "metadata": {},
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "bic_swift": "",
                "account_last4": ""
            },
            "auth_code": null,
            "expiration": 1762000000,
            "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": 1761053384,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {
                "payCode": "895111816145989086"
            },
            "textual_codes": {},
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": "Direct the end-user to make payment to the CLABE provided."
                        }
                    ]
                }
            ],
            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "amount": 4.94,
                    "percent": 104.44,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "mx_spei_bank",
            "payment_method_type_category": "bank_transfer",
            "fx_rate": 0.0473397546,
            "merchant_requested_currency": "USD",
            "merchant_requested_amount": 4.94,
            "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": 0.09
            },
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "pending_confirmation",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": false,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "amount": "100",
        "currency": "MXN",
        "requested_currency": "USD",
        "fixed_side": "sell",
        "expiration": 1762000000,
        "payment_fees": {
            "transaction_fee": {
                "calc_type": "gross",
                "fee_type": "absolute",
                "value": 2
            },
            "fx_fee": {
                "calc_type": "gross",
                "fee_type": "percentage",
                "value": 2.5
            }
        },
        "customer": "cus_a97ac31867f1e2e9903fc2cb936241a7",
        "payment_method": {
            "type": "mx_spei_bank"
        }
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "bc164c67-f9b7-49a1-98da-26c13b6d8224"
        },
        "data": {
            "id": "payment_1d7b227d12543cdbcb97d0242e238e09",
            "amount": 0,
            "original_amount": 104.5,
            "is_partial": false,
            "currency_code": "MXN",
            "country_code": "MX",
            "status": "ACT",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_a97ac31867f1e2e9903fc2cb936241a7",
            "payment_method": "other_6a9cc93cf425a1968889d0b39821edf5",
            "payment_method_data": {
                "id": "other_6a9cc93cf425a1968889d0b39821edf5",
                "type": "mx_spei_bank",
                "category": "bank_transfer",
                "metadata": {},
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "bic_swift": "",
                "account_last4": ""
            },
            "auth_code": null,
            "expiration": 1762000000,
            "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": 1761053480,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": false,
            "paid_at": 0,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {
                "payCode": "968250608203435469"
            },
            "textual_codes": {},
            "instructions": [
                {
                    "name": "instructions",
                    "steps": [
                        {
                            "step1": "Direct the end-user to make payment to the CLABE provided."
                        }
                    ]
                }
            ],
            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "amount": 4.94,
                    "percent": 104.44,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "mx_spei_bank",
            "payment_method_type_category": "bank_transfer",
            "fx_rate": 0.0473397546,
            "merchant_requested_currency": "USD",
            "merchant_requested_amount": 4.94,
            "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": 0.09
            },
            "invoice": "",
            "escrow": null,
            "group_payment": "",
            "cancel_reason": null,
            "initiation_type": "customer_present",
            "mid": "",
            "next_action": "pending_confirmation",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": false,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
    	"amount": "99",
    	"currency": "EUR",
    	"complete_payment_url": "https://www.rapyd.net/complete",
    	"error_payment_url": "https://www.rapyd.net/error",
    	"payment_method_options": {
    		"3d_required": true
    	},
    	"payment_method": {
    		"type": "cy_visa_card",
    		"fields": {
    			"name": "John Doe",
    			"number": "4111111111111111",
    			"expiration_month": "12",
    			"expiration_year": "30",
    			"cvv": "123"
    		}
    	},
    	"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"
    	},
    	"address": {
    		"name": "John Doe",
    		"line_1": "123 First Street",
    		"line_2": "",
    		"city": "Anytown",
    		"state": "",
    		"country": "CY",
    		"zip": "123456",
    		"phone_number": "+35791234567"
    	},
    	"receipt_email": "johndoe@rapyd.net"
    }
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "a0480b25-feb1-48a0-95d7-4a7cc630cfd1"
        },
        "data": {
            "id": "payment_83d441788b7adb06e4db0d74148d09e3",
            "amount": 0,
            "original_amount": 99,
            "is_partial": false,
            "currency_code": "EUR",
            "country_code": "CY",
            "status": "ACT",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_467da59ccce52ff656a7f45387d686fa",
            "payment_method": null,
            "payment_method_data": {
                "id": null,
                "type": "cy_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": "DEBIT",
                    "brand": "VISA",
                    "level": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "expiration_year": "30",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "payment_account_reference": "V001PRHJOXPLXPZLBJ2ADSE1FIYB8",
                "network_reference_id": "834760"
            },
            "auth_code": null,
            "expiration": 1761658521,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "johndoe@rapyd.net",
            "redirect_url": "https://sandboxcheckout.rapyd.net/3ds-payment?token=payment_83d441788b7adb06e4db0d74148d09e3",
            "complete_payment_url": "https://www.rapyd.net/complete",
            "error_payment_url": "https://www.rapyd.net/error",
            "receipt_number": "",
            "flow_type": "",
            "address": {
                "id": "address_f1924284df40ccc8cb8b27b72958296b",
                "name": "John Doe",
                "line_1": "123 First Street",
                "line_2": "",
                "line_3": "",
                "city": "Anytown",
                "state": "",
                "country": "CY",
                "zip": "123456",
                "phone_number": "+35791234567",
                "metadata": {},
                "canton": "",
                "district": "",
                "created_at": 1761053721
            },
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1761053721,
            "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": 99,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {
                "3d_required": true
            },
            "payment_method_type": "cy_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": false,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "authentication_result": {
                "eci": null,
                "result": "R",
                "version": "2.2.0",
                "cardholder_info": null
            },
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "amount": 12.73,
        "currency": "EUR",
        "payment_method": {
            "type": "cy_visa_card",
            "fields": {
                "number": "4111111111111111",
                "expiration_month": "12",
                "expiration_year": "30",
                "cvv": "345",
                "name": "John Doe"
            }
        },
        "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": "608e33bd-d54e-43c8-b431-7bd9aa546ddc"
        },
        "data": {
            "id": "payment_1628e1b78b216fc9189764f69a395726",
            "amount": 12.73,
            "original_amount": 12.73,
            "is_partial": false,
            "currency_code": "EUR",
            "country_code": "CY",
            "status": "CLO",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_a46f6c6b7af7adae3363ae94b666b771",
            "payment_method": null,
            "payment_method_data": {
                "id": null,
                "type": "cy_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": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "expiration_year": "30",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "123456",
                "payment_account_reference": "V0013W70Z9L062WDT58XEXZCBTZHW"
            },
            "auth_code": null,
            "expiration": 1761658743,
            "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": 1761053943,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1761053943,
            "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": 12.73,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "cy_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,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "amount": 3600,
        "currency": "COP",
        "customer": {
            "name": "John Doe"
        },
        "payment_method": {
            "type": "co_bancodebogota_bank"
        }
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "6bdbbf8b-5f47-4168-8c66-91b26ec09ceb"
        },
        "data": {
            "id": "payment_cb4a7902384f510151e849d5b623ba61",
            "amount": 0,
            "original_amount": 3600,
            "is_partial": false,
            "currency_code": "COP",
            "country_code": "CO",
            "status": "ACT",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_afa4554c96f5d3ce687f3f84c2f37718",
            "payment_method": "other_e95f9a3a04dce5077e722587a1c80542",
            "payment_method_data": {
                "id": "other_e95f9a3a04dce5077e722587a1c80542",
                "type": "co_bancodebogota_bank",
                "category": "bank_redirect",
                "metadata": {},
                "image": "",
                "webhook_url": "",
                "supporting_documentation": "",
                "next_action": "not_applicable",
                "bic_swift": "",
                "account_last4": ""
            },
            "auth_code": null,
            "expiration": 1762264402,
            "captured": true,
            "refunded": false,
            "refunded_amount": 0,
            "receipt_email": "",
            "redirect_url": "https://sandboxcheckout.rapyd.net/complete-bank-payment?token=payment_cb4a7902384f510151e849d5b623ba61",
            "complete_payment_url": "",
            "error_payment_url": "",
            "receipt_number": "",
            "flow_type": "",
            "address": null,
            "statement_descriptor": "Doc Team",
            "transaction_id": "",
            "created_at": 1761054802,
            "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_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "amount": 3600,
                    "percent": 100,
                    "refunded_amount": 0
                }
            ],
            "payment_method_options": {},
            "payment_method_type": "co_bancodebogota_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": "pending_confirmation",
            "error_code": "",
            "remitter_information": {},
            "save_payment_method": false,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "amount": 11.0,
        "currency": "GBP",
        "payment_method": {
            "type": "at_visa_card",
            "fields": {
                "number": "4111111111111111",
                "expiration_month": "12",
                "expiration_year": "30",
                "network_reference_id": "123456",
                "name": "John Doe"
            }
        }
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "e3fd7ef2-b261-4f86-81ed-2bdfd757a742"
        },
        "data": {
            "id": "payment_0a19192b030370a2448a73549e2b2ca6",
            "amount": 11,
            "original_amount": 11,
            "is_partial": false,
            "currency_code": "GBP",
            "country_code": "IS",
            "status": "CLO",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_8e0d367aff7e0483bcae4889ce01065f",
            "payment_method": null,
            "payment_method_data": {
                "id": null,
                "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": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "expiration_year": "29",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "932187",
                "payment_account_reference": "V001WAPFR2O80RICE9CEM7YIUY4KD"
            },
            "auth_code": null,
            "expiration": 1761660027,
            "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": 1761055227,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1761055227,
            "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": 11,
                    "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,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "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": "595af87a-26ac-48fc-aa66-155848f8d2a4"
        },
        "data": {
            "id": "payment_a980c78af251c39f05057527c75e9899",
            "amount": 250,
            "original_amount": 250,
            "is_partial": false,
            "currency_code": "USD",
            "country_code": "it",
            "status": "CLO",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_62d21d58a8c2ae38c3d6400ac8ba60c0",
            "payment_method": "card_34cbcefb733fde0403100a7070941120",
            "payment_method_data": {
                "id": "card_34cbcefb733fde0403100a7070941120",
                "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": "DEBIT",
                    "brand": "VISA",
                    "level": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "number_type": "TPAN",
                "expiration_year": "30",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "123456",
                "payment_account_reference": "V001AL5T39H4Q29PK36VWFEP20VCA"
            },
            "auth_code": null,
            "expiration": 1761660101,
            "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": 1761055301,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1761055301,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": {},
            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "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,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • 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' \
    --data-raw '{
        "amount": 10,
        "currency": "EUR",
        "capture": false,
        "description": "payment by card",
        "customer": "cus_4e25112ac20e144ad073a614dc46934b",
        "payment_method": {
            "type": "is_visa_card",
            "fields": {
                "name": "John Doe",
                "number": "4111111111111111",
                "expiration_month": "12",
                "expiration_year": "30",
                "cvv": "123"
            }
        },
        "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": "bbed4648-dc2a-4a2e-9f9a-b4259f335c32"
        },
        "data": {
            "id": "payment_e4c1c2f8c245386faf23b509180dfdc1",
            "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_4e25112ac20e144ad073a614dc46934b",
            "payment_method": "card_0ef78a1d5cbd4d84133c8d94b2d34a4f",
            "payment_method_data": {
                "id": "card_0ef78a1d5cbd4d84133c8d94b2d34a4f",
                "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": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "expiration_year": "30",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "123456"
            },
            "auth_code": null,
            "expiration": 1761660188,
            "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": 1761055388,
            "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,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }
  • Payment with Merchant 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' \
    --data-raw '{
        "amount": 10.90,
        "currency": "GBP",
        "capture": true,
        "save_payment_method": true,
        "3d_required": true,
        "payment_method": {
            "type": "gb_visa_card",
            "fields": {
                "number": "4111111111111111",
                "expiration_month": "12",
                "expiration_year": "30",
                "name": "John Doe",
                "cvv": "345"
            }
        },
        "merchant_ewallet": "ewallet_42dbfb7fd7638a95d6ba084ac07dec1e",
        "statement_descriptor": "Merchant Wallet"
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "80634722-c646-4556-aa2d-fc2a583eb8b8"
        },
        "data": {
            "id": "payment_bfdbcf6352e65c6f6c47fc322f278f86",
            "amount": 10.9,
            "original_amount": 10.9,
            "is_partial": false,
            "currency_code": "GBP",
            "country_code": "GB",
            "status": "CLO",
            "description": "",
            "merchant_reference_id": "",
            "customer_token": "cus_0edf4fa7420fbebf078fb2ca0a19b74d",
            "payment_method": "card_08c059054537acfc68723eaf363c732d",
            "payment_method_data": {
                "id": "card_08c059054537acfc68723eaf363c732d",
                "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": "CLASSIC",
                    "issuer": "CONOTOXIA SP. Z O.O",
                    "country": "PL",
                    "bin_number": "411111"
                },
                "expiration_year": "30",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                "network_reference_id": "123456",
                "payment_account_reference": "V0014HLLSLCN33YFQQXD7X3NORPEH"
            },
            "auth_code": null,
            "expiration": 1761660374,
            "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": "Merchant Wallet",
            "transaction_id": "",
            "created_at": 1761055574,
            "metadata": {},
            "failure_code": "",
            "failure_message": "",
            "paid": true,
            "paid_at": 1761055574,
            "dispute": null,
            "refunds": null,
            "order": null,
            "outcome": null,
            "visual_codes": {},
            "textual_codes": {},
            "instructions": [],
            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
            "ewallets": [
                {
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "amount": 10.9,
                    "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,
            "merchant_advice_code": null,
            "merchant_advice_message": null,
            "transaction_link_id": null
        }
    }