Reverse a Card Payment

This API endpoint reverses a card payment when a communications failure prevents a terminal from receiving Rapyd's REST response. This action is also known as a "technical reversal", which prevents a duplicate charge to the customer's card.

After the original transation has been reversed, the terminal can repeat the card transaction. This process must be initiated within 15 minutes of the original payment transaction.

The action is as follows:

If the original card payment was completed, Rapyd creates a refund.
- If the refund succeeds, Rapyd sends Refund Completed Webhook.
- If the refund fails, Rapyd sends Refund Failed Webhook.
If the original card payment was completed and there is a pending refund, Rapyd cancels the refund. Rapyd sends Refund Rejected Webhook.
If the original payment failed or remains pending, Rapyd cancels the payment. Rapyd sends Payment Canceled Webhook.
If the original payment was completed and a refund was successful, this process returns SUCCESS without any other action.

Note

Sandbox only.

Parameters

Request Header Parameters

Request Body Parameters

- device_id
- ID of the payment device.
- ewallet_id
- ID of the merchant's Rapyd Wallet.
- merchant_reference_id
- Identifier defined by the merchant. Must be the same as the merchant_reference_id parameter in the original card transaction.

Response Parameters

- payment
- Full information about the payment. Relevant when the original payment failed or remains pending. Empty array when not relevant.
  address
  Billing address associated with the payment. For details about the fields of the 'address' object, see Create Address.
  amount
  The amount of the payment, in units of the currency defined in currency.
  auth_code
  Indicates that the card payment was authorized by the card network.
  authentication_result
  Details about the Three-Domain Secure (3DS) authentication of a card payment.
  eci
  Electronic Commerce Indicator (ECI) represents the level of security used when the cardholder submitted their card information for authentication. Two ECI values are listed for each description because VISA and Mastercard use different values.
  05 or 02: Authenticated by verifying the cardholder’s password or identity information. 3DS authentication was successful.
  06 or 01: Authentication was attempted, but not completed.
  07 or 00: Authentication failed or could not be attempted.
  result
  The result of an authentication request. One of the following:
  A: Authentication completed.
  N: Not authenticated. The account was not verified and the transaction was declined.
  R: Redirection of cardholder to 3DS authentication challenge. Awaiting cardholder action.
  U: Unsupported. Verification could not be performed. The liability shift was not accepted by 3DS.
  version
  3DS protocol version.
  cardholder_info
  Information provided by the issuer to a cardholder during the authentication process. For example, information to help the cardholder complete the payment authentication.
  Maximum length: 128 characters.
  cancel_reason
  Reason for cancellation or reversal of a payment.
  captured
  Indicates whether the payment has been successfully captured.
  complete_payment_url
  URL where the customer is redirected when payment is successful, after returning from an external page such as a 3DS page. Does not support localhost URLs.
  country_code
  The country of the payment method.
  created_at
  Time of creation of the object, in Unix time.
  currency_code
  Transactions without FX - Indicates the currency of the amount received by the recipient.
  FX transactions - Indicates the currency of the amount paid by the buyer.
  customer_token
  ID of the customer who is making the payment. String starting with cus_.
  description
  Description of the payment transaction.
  destination_card
  Filters the list for payments related to the specified destination card.
  dispute
  Details about the dispute, if the payment was disputed.
  amount
  Amount that Rapyd deducted from the merchant due to the dispute.
  central_processing_date
  The date the transaction was processed by the card network.
  created_at
  Time of creation of the dispute, in Unix time.
  currency
  Currency of the disputed transaction. Three-letter ISO 4217 code.
  dispute_category
  The category of dispute that was provided by the card network.
  dispute_reason_description
  A short description of the reason for the dispute.
  due_date
  The latest date for the dispute to be contested in Unix time.
  evidence
  Reserved.
  evidence_reason_code
  Reserved.
  ewallet_id
  ID of the wallet that the money is paid into. Relevant when the request includes a single wallet.
  id
  Reserved.
  original_dispute_amount
  Amount of the dispute, as reported to Rapyd.
  original_dispute_currency
  Currency of the disputed payment. Three-letter ISO 4217 code.
  original_transaction_amount
  Amount of the original payment.
  original_transaction_currency
  Currency of original_transaction_amount. Three-letter ISO 4217 code.
  original_transaction_id
  ID of the payment that the dispute is charged against.
  payment_method
  ID of the payment method.
  payment_method_data
  Details of the payment method that was used for the payment.
  pre_dispute
  When true, indicates that the disputed payment was automatically refunded based on pre-determined criteria.
  rate
  FX rate. Relevant to FX payments.
  status
  Indicates the status of the dispute. One of the following values:
  ACT (Active) - The dispute was initiated and is awaiting action by the merchant.
  RVW (Review) - Rapyd is reviewing the merchant's evidence contesting the dispute.
  PRA (Pre-Arbitration) - The card issuer challenged a previously contested dispute. The dispute is being reviewed.
  ARB (Arbitration) - The merchant rejected a pre-arbitration outcome. Rapyd is awaiting a ruling by an arbitration committee of the card schemes.
  LOS (Lose) - The merchant lost the dispute. Funds were deducted from the merchant wallet. Final status.
  WIN (Win) - The merchant won the dispute. Funds were credited to the merchant wallet. Final status.
  REV (Reverse) - The card issuer reversed the dispute. Funds were credited to the merchant wallet. Final status.
  token
  ID of the dispute.
  updated_at
  Time that the dispute was last updated, in Unix time.
  error_code
  Error code for the failure of the payment.
  error_message
  Reserved.
  error_payment_url
  URL where the customer is redirected when payment is not successful, after returning from an external page, such as a 3DS page. Does not support localhost URLs.
  escrow
  Details of the escrow for the payment. Relevant when the payment is created with escrow set to true.
  amount
  The amount in escrow, in units of the currency defined in currency in the payment.
  amount_on_hold
  Total amount of funds that are currently held in the escrow, in the currency defined in currency_code in the payment.
  created_at
  Date and time the escrow was created, in Unix time.
  currency
  The currency of the escrow balance. Three-letter ISO 4217 code.
  escrow_release_days
  Indicates 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.
  escrow_releases
  Array of objects that describe individual releases.
  ewallets
  Array of objects that define the allocation of the release to multiple wallets.
  ewallet
  ID of the wallet, a string starting with ewallet_.
  amount
  The amount to release to this wallet. Relevant when percentage is not set.
  percentage
  The percentage of this escrow to release to this wallet. Relevant when amount is not set. On a partial release after the first, this refers to the percentage of the original amount of the escrow.
  Note
  All wallets in the array must be specified by amount or by percentage or neither. If neither amount nor percentage is set, the release is proportionate according to the split defined in the payment.
  last_payment_completion
  Date and time of the completion of the last payment or partial payment, in Unix time.
  payment
  ID of the payment, a string starting with payment_.
  status
  Status of the escrow. One of the following:
  pending - The payment and escrow were created, but the payment is not completed and the funds are not in the escrow.
  on_hold - The payment is completed and the funds are in escrow.
  canceled - The escrow is canceled.
  released - All or part of the funds have been released to the wallets.
  total_amount_released
  Total amount of funds that were released to the wallets, in the currency defined in currency_code in the payment response.
  updated_at
  Date and time of the last update to the escrow, in Unix time.
  escrow_release_days
  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.
  ewallet_id
  ID of the wallet that the money is paid into. String starting with ewallet_.
  ewallets
  Specifies the wallets that the money is collected into. If this is left blank, the money goes into the oldest collection-type client wallet. If there is no collection client wallet, the money goes into the oldest general-type client wallet.
  amount
  The amount of the payment to the wallet, in units of the currency defined in currency.
  ewallet_id
  ID of the wallet.
  percent
  The percentage that is paid to the wallet out of the total payment.
  refunded_amount
  The total amount refunded against this payment, in units of the currency defined in currency.
  expiration
  End of the time for completing the payment, in Unix time. Relevant to card payments.
  failure_code
  Error code for failure of the payment.
  failure_message
  Message to the merchant, explaining the reason for failure of the payment.
  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.
  flow_type
  Reserved.
  fx_rate
  Exchange rate for the transaction.
  When fixed_side is buy, fx_rate is the buy rate.
  When fixed_side is sell, fx_rate is the sell rate.
  full_name
  Full name of the cardholder, as submitted for account name inquiry (ANI).
  first_name
  The cardholder's given name.
  middle_name
  The cardholder's middle name.
  last_name
  The cardholder's family name.
  group_payment
  ID of the group payment.
  Relevant when the payment is part of a group payment.
  id
  ID of the payment. String starting with payment_.
  initiation_type
  Indicates how the transaction was initiated. One of the following:
  customer_present - The transaction was initiated by the customer.
  delayed_charges - The transaction was initiated by a merchant for a supplemental charge after the original services were rendered. For example, a hotel processes minibar charges discovered after a guest checks out. Typically relevant to the hotel, cruise lines, and vehicle rental industries. original_payment is required.
  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.
  no_show - The transaction was initiated by a merchant to charge a customer who agreed to purchase but did not meet the agreement terms. For example, a hotel processes a fee charged to a customer who does not arrive for a booked reservation. Typically relevant to the hotel and airline industries. original_payment is required.
  reauthorization - The transaction was initiated by a merchant to extend the authorization of a payment that expires before completion of the service or delivery of the product. For example, a car rental company extends the payment authorization for a car that a customer rents for a longer period than the card network allows for the original payment to be collected. Typically relevant to the hotel, vehicle rental, and online retail industries. original_payment is required.
  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.
  instructions
  Describes how the customer makes the payment.
  name
  Description of the payment method.
  steps
  An array containing a list of steps for the customer to take. Each step is named stepN, where N is an integer.
  invoice
  ID of the invoice that this payment is for.
  is_partial
  Indicates whether the payment has been partially paid. When false, indicates that the payment is unpaid or fully paid.
  merchant_advice_code
  Optional code with additional information about the payment for the merchant.
  The merchant_advice_message field describes the code.
  merchant_advice_message
  Description of the merchant advice code.
  Typically informs the merchant whether a declined transaction can be retried. If so, describes when and how to retry. For details, see Merchant Advice Codes.
  For successful payments, may describe limits on the reuse of a payment method, such as a single use virtual card or a non-reloadable prepaid card.
  merchant_ewallet
  The sub-merchant’s ewallet ID. As a Payment Facilitator (PayFac), you can create a card payment and direct the funds that the sub-merchant collects to your client wallet.
  Relevant to a PayFac.
  merchant_reference_id
  Identifier defined by the client for reference purposes. Limit: 45 characters.
  merchant_requested_amount
  Indicates the amount paid by the payer, in units of the currency defined in merchant_requested_currency.
  Relevant to payments with FX.
  merchant_requested_currency
  Indicates the currency that merchant receives. Three-letter ISO 4217 code.
  Relevant to payments with FX.
  metadata
  A JSON object defined by the client. See Metadata.
  mid
  Reserved.
  next_action
  Indicates the next action for completing the payment. One of the following values:
  3d_verification - The next action is 3DS authentication. Relevant only to card payments.
  pending_capture - The next action is pending the capture of the amount. Relevant only to card payments when the amount is not zero.
  pending_confirmation - The next action is pending the confirmation for the payment. Relevant to all payment methods excluding card payment.
  not_applicable - The payment has completed or the next action is not relevant.
  order
  ID of the order that this payment is for.
  original_amount
  Payments not involving foreign exchange - The amount of the payment, in units of the currency defined in currency, including gross transaction fees.
  Foreign exchange payments - The amount paid by the buyer, in units of the currency defined in currency_code, including gross transaction fees and gross FX fees.
  original_payment
  (Sandbox only) ID of the original payment. String starting with payment_. Relevant when initiation_type is set to an industry-specific Merchant-Initiated Transaction (MIT) value.
  outcome
  Describes the outcome of the risk assessment.
  network_status
  Network status of the payment. One of the following:
  approved_by_network
  declined_by_network
  not_sent_to_network
  reversed_after_approval
  risk_level
  Assessment of the risk level of the payment. One of the following:
  normal
  elevated
  highest
  not_assessed
  seller_message
  Message to the merchant.
  type
  Indicates the outcome of the risk assessment. One of the following:
  authorized
  manual_review
  issuer_declined
  blocked
  invalid
  reason
  More detailed indication of the reason indicated by type. One of the following:
  highest_risk_level - Blocked by default rules.
  elevated_risk_level - Placed in review by default rules.
  rule - Placed in review by customer-designed rules.
  paid
  Indicates whether the payment has been fully captured.
  paid_at
  Time of the last capture, in Unix time.
  payment_fees
  Defines transaction fees and foreign exchange fees. These are fees that the Rapyd merchant can define for its consumers in addition to the payment amount. They are not related to the fees Rapyd charges to its clients.
  transaction_fee
  Describes the fee for processing the transaction.
  calc_type
  Specifies how the fee is calculated. One of the following:
  net - The fee is deducted from the amount paid. For example, in a payment of $100 with a fee of 5%, the recipient receives $95.00 and the $5.00 fee goes to the client wallet.
  gross - The fee is added to the amount paid. For example, for a transaction of $100 with a fee of 5%, the sender pays $105.00.
  fee_type
  One of the following:
  percentage - A percentage of the transaction amount. For example, 5 percent is represented by value=5.
  absolute - A fixed amount.
  value
  The amount of the fee.
  fx_fee
  Describes the fees for processing the currency exchange. Relevant to payments with FX.
  calc_type
  Specifies how the fee is calculated. One of the following:
  net - The fee is deducted from the amount paid. For example, in a payment of $100 with a fee of 5%, the recipient receives $95.00 and the $5.00 fee goes to the client wallet.
  gross - The fee is added to the amount paid. For example, for a transaction of $100 with a fee of 5%, the sender pays $105.00.
  value
  The amount of the fee. Percentage.
  gross_fees
  The total gross fees for the transaction, in units defined by currency_code.
  net_fees
  The total net fees for the transaction, in units defined by merchant_requested_currency.
  total_merchant_fees
  The amount of the fee.
  payment_method
  Payment method ID.
  Note
  Card payment method ID is not returned when the next_action is 3d_verification or when save_payment_method was set to false.
  payment_method_data
  Details of the payment method.
  account_last4
  Last four digits of the IBAN.
  Relevant to bank transfers.
  account_name_inquiry
  Data about the account name inquiry (ANI).
  account_name_inquiry_result
  Result of the account name inquiry. One of the following values:
  match - Indicates that the name provided in the request fully matched the issuing bank's records.
  partial match - Indicates that the name provided in the request partially matched the issuing bank's records.
  no match - Indicates that the name provided in the request did not match the issuing bank's records.
  not performed - Indicates that the account name inquiry was not performed.
  not supported - Indicates that the payment method does not support account name inquiries.
  account_name_inquiry_details
  Indicates the degree of matching each part of the cardholder's name.
  first_name
  Indicates the result of matching the cardholder's given name. One of the following values:
  match - Indicates that the first name provided in the request fully matched the first name in the issuing bank's records.
  partial match - Indicates that the first name provided in the request partially matched the first name in the issuing bank's records.
  no match - Indicates that first the name provided in the request did not match the first name in the issuing bank's records.
  middle_name
  indicates the result of matching the cardholder's middle name. One of the following values:
  match - Indicates that the middle name provided in the request fully matched the middle name in the issuing bank's records.
  partial match - Indicates that the middle name provided in the request partially middle the first name in the issuing bank's records.
  no match - Indicates that the middle name provided in the request did not match the middle name in the issuing bank's records.
  last_name
  indicates the result of matching the cardholder's family name. One of the following values:
  match - Indicates that the last name provided in the request fully matched the family name in the issuing bank's records.
  partial match - Indicates that the last name provided in the request partially matched the family name in the issuing bank's records.
  no match - Indicates that the last name provided in the request did not match the family name in the issuing bank's records.
  acs_check
  Results of the Access Control Server (ACS) check. Possible values:
  pass
  fail
  unavailable
  unchecked
  Relevant to cards.
  avs_check
  Results of the Address Verification Service (AVS) check.
  Relevant to Visa, Mastercard, Amex, and Discover cards.
  authentication_url
  URL of a page where the customer enters the IBAN and phone number for authentication.
  Relevant to some bank transfer payment methods.
  bic_swift
  BIC (Bank Identifier Code)/SWIFT code.
  bin_details
  Bank identification details. Relevant to cards.
  bin_number
  Bank identification number of the issuing bank.
  brand
  The brand of the card.
  country
  The country where the card was issued.
  issuer
  Name of the bank that issued the card.
  level
  The level of the card.
  type
  The type of card.
  category
  Category of payment method. One of the following:
  bank_redirect
  bank_transfer
  card
  cardtocard
  cash
  ewallet
  rapyd_ewallet
  cvv_check
  Verification of the card’s CVV. Valid values:
  pass
  fail
  unavailable
  unchecked
  Relevant to cards.
  digital_wallet
  Information about the digital wallet.
  pan_type
  Describes the type of PAN.
  type
  Describes the type of digital wallet.
  expiration_month
  The month when the expiration of the card occurs.
  Relevant to cards.
  expiration_year
  The year when the expiration of the card occurs.
  Relevant to cards.
  fingerprint_token
  Hash of the card number, expiration date and CVV.
  Relevant to cards.
  full_name
  Full name of the cardholder, as submitted for account name inquiry (ANI).
  first_name
  The cardholder's given name.
  middle_name
  The cardholder's middle name.
  last_name
  The cardholder's family name.
  id
  ID of the payment method.
  Note
  Card payment method ID is not returned when the next_action is 3d_verification or when save_payment_method was set to false.
  image
  A URL to the image of the icon for the payment method type.
  last4
  Last four digits of the card.
  Relevant to cards.
  metadata
  A JSON object defined by the client. See Metadata.
  network_reference_id
  Identifier for use in a recurring card payment.
  next_action
  Indicates the next action for completing the payment. One of the following values:
  3d_verification - The next action is 3DS. Relevant to card payments.
  pending_capture - The next action is pending the capture of the amount. Relevant to card payments when the amount is not zero.
  pending_confirmation - The next action is pending the confirmation for the payment. Relevant to all payment methods excluding card payment.
  not_applicable - The payment has completed or the next action is not relevant.
  payment_account_reference
  Payment Account Reference (PAR) number. An alphanumeric code that associates payments made by different tokens and physical cards that all represent the same payment account number (PAN). Appears only in card responses that include an EMVCo-compliant PAR.
  type
  Type of the payment card. Possible values:
  credit
  debit
  prepaid
  unknown
  Relevant to cards.
  supporting_documentation
  Reserved.
  webhook_url
  Reserved.
  payment_method_options
  Object describing additional payment method fields for the payment. These values are not saved as part of the payment method object.
  payment_method_type
  The type of payment method.
  payment_method_type_category
  Category of payment method type. One of the following:
  bank_redirect
  bank_transfer
  card
  cash
  ewallet
  rapyd_ewallet
  receipt_email
  Email address that the receipt for this transaction is sent to.
  Required for Visa card payments with 3DS authentication. See Creating a Card Payment With 3DS Authentication - Rapyd 3DS for additional request parameters that are required for 3DS authentication.
  receipt_number
  Reserved.
  redirect_url
  URL where the customer is redirected for additional steps for the payment.
  refunded
  Indicates whether there was a refund against this payment.
  refunded_amount
  The total amount refunded against this payment, in units of the currency defined in currency.
  refunds
  An array containing a data object:
  data
  A list of up to three refund objects.
  has_more
  Indicates whether there are more than three refunds against this payment.
  total_count
  Total number of refunds against this payment.
  url
  URL for requesting all of the refunds against this payment.
  remitter_information
  Contains the remitter's name and bank account information. This includes:
  account_id
  Number of the remitter's bank account.
  bank_code
  SWIFT code for the remitter's bank.
  name
  Name of the remitter.
  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).
  save_payment_method
  Relevant to card payment methods when the request included full card details. Indicates whether Rapyd saved the payment method for future use.
  statement_descriptor
  A text description suitable for a customer's payment statement. 5-22 characters.
  status
  Indicates the status of the payment. One of the following:
  ACT - Active and awaiting completion of 3DS or capture. Can be updated.
  CAN - Canceled by the client or the customer's bank.
  CLO - Closed.
  ERR - Error. An attempt was made to create or complete a payment, but it failed.
  EXP - The payment has expired.
  REV - Reversed by Rapyd. See cancel_reason.
  textual_codes
  A set of text codes for the customer to use to complete the steps described in the instructions field. The name of the field is the local name of the code, or some other label. For example:
  code
  paycode
  payid
  pairing_code
  payment_code
  response_code
  transaction_id
  ID of the associated transaction.
  transaction_link_id
  A unique transaction identifier.
  Save the ID to link future lifecycle and economically-related transactions to the current transaction.
  Relevant to Mastercard transactions for a client authorized to use a network reference ID. See Creating a Card Payment with a Network Reference ID.
  visual_codes
  A set of images for the customer to use to complete the steps described in the instructions field. For example, a QR code or barcode.
- refund
- Full information about the refund. Relevant when the original card payment was completed and a refund was created or canceled. Empty array when not relevant.
  amount
  Amount of the refund, in units defined by currency in the original payment.
  created_at
  Time of creation of this refund, in Unix time.
  currency
  The currency of the amount received by the original payment source. Three-letter ISO 4217 code.
  ewallets
  Array of objects that define the allocation of the refund to multiple wallets.
  ewallet
  ID of the wallet, a string starting with ewallet_.
  amount
  The amount refunded to this wallet. Relevant when percentage is not set.
  percentage
  The percentage of this payment refunded to this wallet. Relevant when amount is not set.
  failure_code
  Indicates the reason that the refund failed. See Card Network Errors.
  failure_reason
  Indicates the reason that the refund failed. One of the following:
  lost_or_stolen_card
  expired_or_canceled_card
  unknown
  Empty string
  fixed_side
  Indicates which side of the transaction the FX rate is fixed for. Relevant for refunds with foreign exchange. One of the following values:
  buy
  sell
  fx_rate
  Exchange rate for the transaction.
  When fixed_side is buy, fx_rate is the buy rate.
  When fixed_side is sell, fx_rate is the sell rate.
  Decimal number as string. Relevant to refunds with foreign exchange.
  id
  ID of the refund object. String starting with refund_.
  merchant_reference_id
  Identifier defined by the client for reference purposes. Limit: 45 characters.
  merchant_debited_amount
  Amount debited from the merchant. Relevant to refunds with foreign exchange.
  merchant_debited_currency
  Indicates the currency that is debited from the merchant. Three-letter ISO 4217 code. Relevant to refunds with foreign exchange.
  merchant_ewallet
  As a Payment Facilitator (PayFac), you can create a card payment and direct the funds that the sub-merchant collects to your client wallet.
  Relevant to a PayFac.
  metadata
  A JSON object defined by the client. See Metadata.
  payment
  ID of the payment object that the refund is credited against. String starting with payment_.
  payment_created_at
  Time that the original payment was created, in Unix time.
  payment_method_type
  The original payment method type. Use List Payment Methods by Country for a list of supported types for a country.
  proportional_refund
  Indicates whether the refund was returned in proportion to the amounts received by the wallets in the payment. Relevant to a refund for a payment split among multiple wallets.
  reason
  Description of the reason for the refund, provided by the merchant.
  receipt_number
  Number of the receipt for the refund, provided by the merchant.
  status
  Indicates the status of the refund operation. One of the following values:
  Canceled - The merchant canceled the refund.
  Completed - The refund was complete.
  Error - The refund failed since the payment object on which the refund is based is not in closed status.
  Rejected - The refund was rejected by the specific payment processor for this payment.
  Pending - The request created a refund object on the Rapyd platform, but the refund is not yet complete. For example, the refund is for a payment method that requires a customer action, such as cash, bank redirect or bank transfer.
  updated_at
  Time that this refund was last updated, in Unix time.

/v1/payment-device/technical_reversal

Reversal When Original Payment Succeeded and not Refunded

curl -X post 'https://sandboxapi.rapyd.net/v1/payment-device/technical_reversal' \
-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 '{
    merchant_reference_id: '51001******9',
    device_id: '0880196',
    ewallet_id: 'ewallet_8818c1e4c2185f4137822ea58f952e2a'
}'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "bc5321ff-204b-4fb6-87cb-bf964fadd00a"
    },
    "data": {
        "payment": [],
        "refund": [
            {
                "id": "refund_6aa701483abbb9c16bfa8e7513f1e484",
                "amount": 1.02,
                "payment": "payment_f125433e92e49f9d5c097e8d111018b4",
                "currency": "ILS",
                "failure_reason": "",
                "failure_code": "",
                "metadata": {},
                "reason": "technical_reversal",
                "status": "Pending",
                "receipt_number": 0,
                "created_at": 1776346809,
                "updated_at": 1776346809,
                "merchant_ewallet": null,
                "merchant_reference_id": "51001009",
                "payment_created_at": 1776346517,
                "payment_method_type": "il_visa_shva_pos",
                "ewallets": [
                    {
                        "ewallet": "ewallet_8818c1e4c2185f4137822ea58f952e2a",
                        "amount": 1.02
                    }
                ],
                "proportional_refund": true,
                "merchant_debited_amount": null,
                "merchant_debited_currency": null,
                "fx_rate": null,
                "fixed_side": null
            }
        ]
    }
}

Reversal When Original Payment Remains Pending

curl -X post 'https://sandboxapi.rapyd.net/v1/payment-device/technical_reversal' \
-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 '{
    merchant_reference_id: '51001******0',
    device_id: '0880196',
    ewallet_id: 'ewallet_8818c1e4c2185f4137822ea58f952e2a'
}'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "536d6f54-4901-4ba1-a058-a194469fc6ed"
    },
    "data": {
        "payment": [
            {
                "id": "payment_c9196845903d1f2f529dfb2682234aba",
                "amount": 0,
                "original_amount": 1.03,
                "is_partial": false,
                "currency_code": "ILS",
                "country_code": "IL",
                "status": "CAN",
                "description": "",
                "merchant_reference_id": "51001******0",
                "customer_token": "cus_e4ab0229f97252532993a9d10414cfb1",
                "payment_method": "card_513cf5b509f80f711ab22c90646e0450",
                "payment_method_data": {
                    "cvv_check": "unchecked",
                    "acs_check": "unchecked"
                },
                "auth_code": " 03153",
                "expiration": 1776900,
                "captured": false,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": "",
                "redirect_url": "",
                "complete_payment_url": "",
                "error_payment_url": "",
                "receipt_number": "",
                "flow_type": "",
                "address": null,
                "statement_descriptor": "Shva Integration Merch",
                "transaction_id": "",
                "created_at": 1776395,
                "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_8818c1e4c2185f4137822ea58f952e2a",
                "ewallets": [
                    {
                        "ewallet_id": "ewallet_8818c1e4c2185f4137822ea58f952e2a",
                        "amount": 1.03,
                        "percent": 100,
                        "refunded_amount": 0
                    }
                ],
                "payment_method_options": {},
                "payment_method_type": "il_visa_shva_pos",
                "payment_method_type_category": "pos",
                "fx_rate": 1,
                "merchant_requested_currency": null,
                "merchant_requested_amount": null,
                "fixed_side": "",
                "payment_fees": null,
                "invoice": "",
                "escrow": null,
                "group_payment": "",
                "cancel_reason": "technical_reversal",
                "initiation_type": "card_present",
                "mid": "mid_aed21e6c30927c6a3d702ea5a3a19a9d",
                "next_action": "not_applicable",
                "error_code": "",
                "remitter_information": {},
                "save_payment_method": false,
                "merchant_advice_code": null,
                "merchant_advice_message": null,
                "enhanced_data": null,
                "payment_request_id": "payment_req_46979bd94555ade68079b2c236ec3f67",
                "transaction_link_id": null
            }
        ],
        "refund": []
    }
}

Reversal When Original Payment Refunded and Refund is Pending

curl -X post 'https://sandboxapi.rapyd.net/v1/payment-device/technical_reversal' \
-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 '{
    merchant_reference_id: '52001******2',
    device_id: '0880196',
    ewallet_id: 'ewallet_8818c1e4c2185f4137822ea58f952e2a'
}'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "b692c457-ada0-4708-9cdb-917a5d6c1608"
    },
    "data": {
        "payment": [],
        "refund": [
            {
                "id": "refund_d8745853911f8a3412932a676b4007c8",
                "amount": 1.45,
                "payment": "payment_45c1e105b7c0559b2944223f50de2b74",
                "currency": "ILS",
                "failure_reason": "",
                "failure_code": "",
                "metadata": {},
                "reason": "Direct Refund",
                "status": "Cancelled",
                "receipt_number": 0,
                "created_at": 1776936,
                "updated_at": 1776949,
                "merchant_ewallet": null,
                "merchant_reference_id": "52001******2",
                "payment_created_at": 1776935,
                "payment_method_type": "il_visa_shva_pos",
                "ewallets": [
                    {
                        "ewallet": "ewallet_8818c1e4c2185f4137822ea58f952e2a",
                        "amount": 1.45
                    }
                ],
                "proportional_refund": true,
                "merchant_debited_amount": null,
                "merchant_debited_currency": null,
                "fx_rate": null,
                "fixed_side": null
            }
        ]
    }
}

In this section:

Documentation

Reverse a Card Payment

Note

Parameters

Request Header Parameters

Request Body Parameters

Response Parameters

Note

Note

Note

Search results