Skip to content

Latest commit

 

History

History
49 lines (41 loc) · 14.3 KB

V1PaymentsBody.md

File metadata and controls

49 lines (41 loc) · 14.3 KB

V1PaymentsBody

Properties

Name Type Required Description
amount float ✅ The amount received by the recipient, in units of the currency defined in currency. Decimal, including the correct number of decimal places for the currency exponent, as defined in ISO 2417:2015. To verify a card, set to 0.
currency str ✅ In transactions without FX, defines the currency of the transaction. Three-letter ISO 4217 code.<BR> In FX transactions:<BR> _ When fixed_side is buy, it is the currency received in the Rapyd wallet.<BR> _ When fixed_side is sell, it is the currency charged to the buyer.
address Address1 ❌ address associated with this specific Rapyd entity Payment/Customer etc.
capture bool ❌ Determines when the payment is processed for capture. When true, the payment is captured immediately. When false, the payment is captured at a later time. Relevant to cards. Default is true.
client_details ClientDetailsObject ❌ Describes the fields in the client_details object in REST messages for payments. The client_details object describes the browser that the customer is using. The client collects this information and sends it as part of the Create Payment request. This information is used for processing the 3DS version 2 authentication of the customer. Note that Client Details information is not returned in the API response and it does not appear in any webhooks.
complete_payment_url str ❌ URL where the customer is redirected after successfully completing an operation on an external page.
customer str ❌ string - ID of the customer who is making the payment. String starting with cus_. Required if payment_method is blank. object - Contains all required fields
description str ❌ Description of the payment
error_payment_url str ❌ URL where the customer is redirected in case of an error in the operation. Provided by the client.Relevant to bank redirect payment methods
escrow bool ❌ Determines whether the payment is held in escrow for later release.
escrow_release_days int ❌ 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 between 1-90. Default is 90.
ewallet str ❌ ID of the wallet that the money is paid into. String starting with ewallet_. Relevant when the request includes a single wallet.
ewallets any ❌ Represents the wallets that the money is paid into. Array of objects.
expiration float ❌ End of the time allowed for customer to make this payment, in Unix time. Must be after the current time
fixed_side str ❌ Indicates whether the FX rate is fixed for the buy side (seller's Rapyd Wallet) or for the sell side (buyer).
group_payment str ❌ ID of the group payment, a string starting with 'gp_'. Relevant to replacing a payment that failed.
initiation_type InitiationType ❌ Describes how the transaction was initiated.
merchant_reference_id str ❌ ID defined by the client. Limited to 255 characters.
metadata dict ❌ A JSON object defined by the client.
payment_fees Fee ❌
payment_method V1PaymentsBodyPaymentMethod ❌ Payment Method object or ID.
payment_method_options dict ❌ Object describing additional information required for the payment. The object is returned by Get Payment Method Required Fields. Note that Transactions with 3DS authentication must be authenticated within 15 minutes, after which the possibility to authenticate expires.
receipt_email str ❌ Email address that the receipt for this transaction is sent to.
requested_currency str ❌ 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). Three-letter ISO 4217 code.
statement_descriptor str ❌ A text description that appears in the customer's bank statement.

InitiationType

Describes how the transaction was initiated.

Properties

Name Type Required Description
CUSTOMERPRESENT str ✅ "customer_present"
INSTALLMENT str ✅ "installment"
MOTO str ✅ "moto"
RECURRING str ✅ "recurring"
UNSCHEDULED str ✅ "unscheduled"

V1PaymentsBodyPaymentMethod

Payment Method object or ID.