Payout Updated Webhook

The PAYOUT_UPDATED webhook is sent when a payout is updated by Update Payout or the action of a third party.

Parameters

Webhook Header Parameters

Webhook Root Parameters

- created_at
- Time that the webhook was created, in Unix time.
  Note
  Inside the data object, some webhooks have another created_at field that refers to a different event.
- data
- Contains the actual data of the webhook.
  For details, see below.
- id
- ID of the webhook. String starting with wh_.
- status
- Status of the webhook. One of the following:
  - NEW
  - CLO - Closed.
  - ERR - Error.
  - RET - Re-sent.
  Note
  Inside the data object, some webhooks have another status field that refers to a different event.
- trigger_operation_id
- ID of the operation that triggered the webhook. UUID.
- type
- Name of the webhook type.
  Note
  The name in the Client Portal is different.

Webhook Data Parameters

- amount
- Amount of the payout, in units defined by payout_currency. Decimal, including the correct number of decimal places for the currency exponent, as defined in ISO 2417:2015. Same as payout_amount.
- batch_file
- Batch file ID. Relevant to batch payouts that were created via the Client Portal.
- beneficiary
- Object describing the beneficiary.
- beneficiary_country
- Country of the beneficiary. Two-letter ISO 3166-1 ALPHA-2 code.
- created_at
- Time of creation of the payout object, in Unix time.
- error
- Indicates the error code of the last unsuccessful operation on the payout object.
- estimated_time_of_arrival
- The estimated time period in which the beneficiary will receive the funds.
  Note
  Rapyd will try to complete the payout within the estimated time. However, completion of a payout can be delayed for legal or other reasons.
- ewallets
- An array of one object, which contains the following fields:
  ewallet_id
  The ID of the wallet that the money is transferred from, a string starting with ewallet_.
  amount
  Amount of the transaction in currency units defined in currency.
  percent
  A decimal number representing a percentage of the total payout.
- expiration
- Determines the day the payout expires, in Unix time. The payout must be completed before the start of this day.
  Relevant to cash payout methods where the is_expirable field is true in the response to List Payout Method Types.
- fx_rate
- Currency conversion rate for the payout. Decimal.
- gc_error_code
- Reserved.
- id
- ID of the payout. String starting with payout_.
- identifier_type
- Reserved.
- identifier_value
- Reserved.
- instructions
- Describes how the customer collects the payout. Contains the following fields:
  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.
- merchant_reference_id
- Identifier defined by the client for reference purposes. Limit: 45 characters.
- metadata
- A JSON object defined by the client. See Metadata.
- paid_amount
- Cumulative amount received by the beneficiary, in units defined by payout_currency.
- paid_at
- Time of the payout, in Unix time.
- payout_currency
- Currency received by the beneficiary. Three-letter ISO 4217 code.
- payout_fees
- Object that defines transaction fees and foreign exchange fees that the client can define for payout transactions.
  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.
- payout_method_type
- The type of payout method. The two-letter prefix must match the country code of the beneficiary.
- payout_type
- The type of the payout method. One of the following values:
  - bank - Payout to bank account.
  - card - Payout to card.
  - cash - Payout to cash.
  - ewallet - Payout to local eWallet.
- sender
- Object describing the sender.
  company_name
  Name of the sender company. Relevant when entity_type is company.
  country
  Country of the sender. Two-letter ISO 3166-1 ALPHA-2 code.
  currency
  Currency that the sender is paying with. Three-letter ISO 4217 code.
  entity_type
  Type of entity. One of the following values:
  company
  individual
  first_name
  First name of the sender. Relevant when entity_type is individual.
  identification_type
  Type of identification document for the sender. When entity_type is company, this field must be company_registered_number. When entity_type is individual, one of the following values:
  drivers_license
  identification_id
  international_passport
  residence_permit
  social_security
  work_permit
  identification_value
  Identification number on the document mentioned in identification_type.
  last_name
  Last name of the sender. Relevant when entity_type is individual.
- sender_amount
- Amount that the sender is paying in units of the currency defined in sender_currency. This amount remains the same regardless of FX fees. Decimal.
- sender_country
- Country of the sender. Two-letter ISO 3166-1 ALPHA-2 code.
- sender_currency
- Currency that the sender is paying with. Three-letter ISO 4217 code.
- statement_descriptor
- A statement that includes the reason for the payout. Limited to 35 characters.
- status
- Indicates the status of the payout. One of the following:
  - Canceled - The payout was canceled.
  - Completed - The beneficiary received some or all payout funds.
  - Confirmation - The payout is waiting for the beneficiary to confirm the FX rate.
  - Created - The payout was created successfully.
  - Declined - The payout failed to pass inspection.
  - Error - The payout was not created or failed after creation.
  - Expired - The payout has expired.
  - Hold - A bank payout is being reviewed manually by Rapyd Protect. A Quarantine Under Review Webhook is also triggered.
  - Pending - The payout is waiting for the beneficiary to confirm acceptance of the funds.

PAYOUT_UPDATED Webhook

{
  "id": "wh_6df263ebe0d843411a127fd66db2330b",
  "type": "PAYOUT_UPDATED",
  "data": {
    "id": "payout_4afe629c371462886ead1c0fafcbee01",
    "error": null,
    "amount": 200,
    "sender": {
      "id": "sender_8897b29d6e423fa5a16e9acec4a54a26",
      "name": "Four Star Professional Services",
      "country": "US",
      "currency": "USD",
      "entity_type": "company",
      "company_name": "Four Star Professional Services",
      "purpose_code": "Transfer",
      "identification_type": "company_registered_number",
      "identification_value": "0123456789"
    },
    "status": "Created",
    "fx_rate": 1,
    "paid_at": null,
    "ewallets": [
      {
        "amount": 200,
        "percent": 100,
        "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861"
      }
    ],
    "metadata": {
      "merchant_defined": "updated"
    },
    "created_at": 1672045411,
    "expiration": null,
    "beneficiary": {
      "id": "beneficiary_d895d90d276869efe1e359386a1fb3e3",
      "aba": "987654321",
      "name": "All Star Limousine",
      "country": "US",
      "category": "bank",
      "currency": "USD",
      "bank_name": "All Star Limousine",
      "entity_type": "company",
      "company_name": "All Star Limousine",
      "account_number": "0987654321",
      "identification_type": "company_registered_number",
      "identification_value": "9876543210",
      "merchant_reference_id": "AllStarLimo"
    },
    "description": null,
    "paid_amount": 0,
    "payout_fees": null,
    "payout_type": "bank",
    "instructions": {
      "name": "instructions",
      "steps": [
        {
          "step1": "The funds will be transferred to the provided account details of the beneficiary ."
        }
      ]
    },
    "gc_error_code": null,
    "sender_amount": 200,
    "sender_country": "US",
    "identifier_type": null,
    "payout_currency": "USD",
    "sender_currency": "USD",
    "identifier_value": null,
    "instructions_value": {},
    "payout_method_type": "us_ach_bank",
    "beneficiary_country": "US",
    "statement_descriptor": null,
    "merchant_reference_id": null
  },
  "trigger_operation_id": "f0919eca-8347-40b9-aed2-d3538f09bd54",
  "status": "NEW",
  "created_at": 1672045609
}

In this section:

Documentation

Payout Updated Webhook

Note

Parameters

Webhook Header Parameters

Webhook Root Parameters

Note

Note

Note

Webhook Data Parameters

Note

Search results