Pricing Templates
Log in Sign up
Integrations / Rebilly / ...

PUT /payout-requests/{id}

Creates or updates (upserts) a payout request with a specified ID.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
availableAmount Number No

Available payout request amount that has not been allocated.
description String No

Description of payout request.
createdTime String No

Date and time when the payout request is created.
status String No

Status of the request.

Valid values:

  • "fulfilled"
  • "partially-fulfilled"
  • "pending"
  • "canceled"
  • "instrument-selected"
blockReason Object No
currency String Yes

Currency of the payout.
websiteId String Yes

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
customerId String Yes

ID of the customer who is requesting a payout.
allocations[] Array No

List of credit transactions that are allocated to reduce the available amount of a payout request.
allocations[].method String No

Payment method.

Valid values:

  • "iDebit"
  • "Boleto-3"
  • "Litecoin"
  • "Wallet88"
  • "Giropay"
  • "Neosurf"
  • "PagoEffectivo"
  • "MercadoPago"
  • "PinPay"
  • "Interac-express-connect"
  • "PayULatam"
  • "Piastrix"
  • "Bancontact-mobile"
  • "Affirm"
  • "OXXO"
  • "Yandex-money"
  • "paypal"
  • "ecoVoucher"
  • "Pagsmile-lottery"
  • "Paysafecard"
  • "Alipay"
  • "XPay-P2P"
  • "Khelocard"
  • "MiFinity-eWallet"
  • "QQPay"
  • "Megafon"
  • "Ripple"
  • "Nordea-Solo"
  • "Airpay"
  • "CODVoucher"
  • "FasterPay"
  • "eZeeWallet"
  • "Afterpay"
  • "Alfa-click"
  • "cryptocurrency"
  • "Flexepin"
  • "PhonePe"
  • "InstantPayments"
  • "Paynote"
  • "Zip"
  • "Bizum"
  • "Blik"
  • "Webpay-2"
  • "domestic-cards"
  • "bank-transfer-2"
  • "Directa24Card"
  • "POLi"
  • "Zimpler"
  • "Bancontact"
  • "loonie"
  • "Onlineueberweisen"
  • "Dimoco-pay-smart"
  • "Klarna"
  • "PayU"
  • "Gpaysafe"
  • "ToditoCash-card"
  • "Payeer"
  • "iDEAL"
  • "Sofort"
  • "BankReferenced"
  • "ING-homepay"
  • "XPay-QR"
  • "Mollie"
  • "bank-transfer-3"
  • "swift-dbt"
  • "VegaWallet"
  • "iWallet"
  • "Telr"
  • "Terminaly-RF"
  • "ecoPayzTurkey"
  • "Skrill"
  • "bank-transfer"
  • "PaymentAsia-crypto"
  • "INOVAPAY-wallet"
  • "Trustly"
  • "Viva"
  • "UPayCard"
  • "bank-transfer-4"
  • "phone"
  • "SparkPay"
  • "reverse-withdrawal"
  • "Matrix"
  • "USD-coin"
  • "PayCash"
  • "AstroPay Card"
  • "EPS"
  • "bank-transfer-6"
  • "Conekta-oxxo"
  • "Interac"
  • "bank-transfer-5"
  • "Paymero"
  • "SMSVoucher"
  • "Paymero-QR"
  • "PostFinance-e-finance"
  • "bank-transfer-7"
  • "China UnionPay"
  • "Boleto"
  • "AdvCash"
  • "P24"
  • "Payco"
  • "Webmoney"
  • "cash-deposit"
  • "Resurs"
  • "CyberSource"
  • "ezyEFT"
  • "bank-transfer-8"
  • "QIWI"
  • "Jeton"
  • "jpay"
  • "TWINT"
  • "ePay.bg"
  • "Google Pay"
  • "VenusPoint"
  • "SPEI"
  • "LPG-payment-card"
  • "PayTabs"
  • "QPay"
  • "bank-transfer-9"
  • "BankSEND"
  • "Clearpay"
  • "MobilePay"
  • "MTS"
  • "Pagsmile-deposit-express"
  • "AstroPay-GO"
  • "Webpay Card"
  • "Perfect-money"
  • "SafetyPay"
  • "voucher-2"
  • "Cleo"
  • "instant-bank-transfer"
  • "CASHlib"
  • "ecoPayz"
  • "Webpay"
  • "voucher"
  • "MaxiCash"
  • "Pay4Fun"
  • "payment-card"
  • "Aircash"
  • "Skrill Rapid Transfer"
  • "voucher-3"
  • "Neteller"
  • "SEPA"
  • "NordikCoin"
  • "Samsung Pay"
  • "ach"
  • "WeChat Pay"
  • "miscellaneous"
  • "online-bank-transfer"
  • "Zotapay"
  • "Siirto"
  • "MuchBetterVoucher"
  • "INOVAPAY-pin"
  • "Ethereum"
  • "voucher-4"
  • "Efecty"
  • "PIX"
  • "VCreditos"
  • "Netbanking"
  • "Baloto"
  • "Tupay"
  • "Tether"
  • "AmazonPay"
  • "JetonCash"
  • "Tele2"
  • "Multibanco"
  • "bitcoin"
  • "OchaPay"
  • "MyFatoorah"
  • "CashToCode"
  • "Apple Pay"
  • "invoice"
  • "Belfius-direct-net"
  • "cash"
  • "InstaDebit"
  • "echeck"
  • "Interac-online"
  • "check"
  • "iCashOne Voucher"
  • "MuchBetter"
  • "oriental-wallet"
  • "PostFinance-card"
  • "Beeline"
  • "Boleto-2"
  • "Cupon-de-pagos"
  • "Aera"
  • "Pagadito"
  • "rebilly-hosted-payment-form"
  • "rapyd-checkout"
  • "LPG-online"
  • "UPI"
  • "Conekta-spei"
  • "KNOT"
  • "Interac-eTransfer"
  • "KakaoPay"
  • "e-wallet"
  • "CCAvenue"
  • "UniCrypt"
allocations[].updatedTime String No

Date and time when the payout request is updated.
allocations[].transactionResult String No

Result of the transaction.

Valid values:

  • "declined"
  • "approved"
  • "abandoned"
  • "unknown"
  • "canceled"
allocations[].createdTime String No

Date and time when the payout request is created.
allocations[].amount Number No

Payout amount that is allocated from the payout request to the credit transaction.
allocations[].transactionId String No

ID of the transaction to which the payout request is allocated.
allocations[].currency String No

Currency of the payout.
allocations[].gatewayName String No

Name of the payment gateway that processed, or is selected to process, the transaction.

Valid values:

  • "iDebit"
  • "Pin4Pay"
  • "Wallet88"
  • "Panamerican"
  • "Stripe"
  • "EMS"
  • "AuthorizeNet"
  • "Walpay"
  • "vegaaH"
  • "Neosurf"
  • "MercadoPago"
  • "MuchBetterGateway"
  • "PayULatam"
  • "Piastrix"
  • "NMI"
  • "Dimoco"
  • "Chillstock"
  • "CoinGate"
  • "ePay"
  • "MtaPay"
  • "VantivLitle"
  • "Coppr"
  • "CheckoutCom"
  • "Paysafecard"
  • "PPRO"
  • "Limepay"
  • "Rotessa"
  • "DataCash"
  • "EPG"
  • "Gooney"
  • "Khelocard"
  • "Moneris"
  • "ACI"
  • "AsiaPaymentGateway"
  • "Ezeebill"
  • "EcorePay"
  • "Airpay"
  • "CODVoucher"
  • "FasterPay"
  • "Paybilt"
  • "eZeeWallet"
  • "Awepay"
  • "Payeezy"
  • "BitPay"
  • "Orbital"
  • "Flexepin"
  • "LPG"
  • "EasyPayDirect"
  • "EBANX"
  • "Paynote"
  • "Monolo"
  • "iCheque"
  • "Powertranz"
  • "Intuit"
  • "Paysafecash"
  • "OnRamp"
  • "Zimpler"
  • "PayRedeem"
  • "Chase"
  • "Inovio"
  • "Plugnpay"
  • "loonie"
  • "SaltarPay"
  • "HiPay"
  • "Onlineueberweisen"
  • "Safecharge"
  • "PayEcards"
  • "Klarna"
  • "PayU"
  • "Gpaysafe"
  • "Sofort"
  • "MiFinity"
  • "Mollie"
  • "VegaWallet"
  • "PaymentAsia"
  • "Telr"
  • "Bambora"
  • "Conekta"
  • "Loonio"
  • "ecoPayzTurkey"
  • "Gigadat"
  • "Pagsmile"
  • "Skrill"
  • "Trustly"
  • "Naewe"
  • "Viva"
  • "UPayCard"
  • "SparkPay"
  • "A1Gateway"
  • "WesternUnion"
  • "Clearhaus"
  • "PaymenTechnologies"
  • "Antom"
  • "GlobalOnePay"
  • "PayCash"
  • "SeamlessChex"
  • "SmartInvoice"
  • "TestProcessor"
  • "Credorax"
  • "LaCore"
  • "Elavon"
  • "GET"
  • "Tabby"
  • "Dropayment"
  • "AstroPayCard"
  • "Paymero"
  • "PostFinance"
  • "SMSVoucher"
  • "Cayan"
  • "dLocal"
  • "iCashOne"
  • "PSiGate"
  • "Airwallex"
  • "Payper"
  • "ICEPAY"
  • "NOWPayments"
  • "ParamountEft"
  • "ParamountInterac"
  • "USAePay"
  • "PayPal"
  • "CyberSource"
  • "ezyEFT"
  • "Jeton"
  • "Payr"
  • "TWINT"
  • "XPay"
  • "Cashflows"
  • "ApcoPay"
  • "Circle"
  • "Prosa"
  • "Paycly"
  • "Splitit"
  • "Truevo"
  • "PayTabs"
  • "Worldpay"
  • "JPMOrbital"
  • "IpayOptions"
  • "Konnektive"
  • "PayRetailers"
  • "PayCom"
  • "Buckaroo"
  • "BankSEND"
  • "Ilixium"
  • "Redsys"
  • "SecureTrading"
  • "OmniMatrix"
  • "gate2way"
  • "Cardknox"
  • "MobilePay"
  • "TrustsPay"
  • "BraintreePayments"
  • "Cleo"
  • "INOVAPAY"
  • "SecurionPay"
  • "CASHlib"
  • "ecoPayz"
  • "Greenbox"
  • "PandaGateway"
  • "MaxiCash"
  • "Pay4Fun"
  • "NGenius"
  • "Aircash"
  • "Paysafe"
  • "JetPay"
  • "Realex"
  • "Citadel"
  • "FundSend"
  • "Neteller"
  • "eMerchantPay"
  • "GoCardless"
  • "NordikCoin"
  • "CoinPayments"
  • "Finrax"
  • "RPN"
  • "Forte"
  • "Rapyd"
  • "Dengi"
  • "Wirecard"
  • "Dragonphoenix"
  • "Coinbase"
  • "AmexVPC"
  • "BVNK"
  • "Realtime"
  • "iCanPay"
  • "Zotapay"
  • "FinTecSystems"
  • "Cryptonator"
  • "NuaPay"
  • "VCreditos"
  • "PayClub"
  • "Netbanking"
  • "Cashterminal"
  • "AmazonPay"
  • "Sagepay"
  • "MonRem"
  • "Payflow"
  • "OchaPay"
  • "MyFatoorah"
  • "CashToCode"
  • "Cryptomus"
  • "Directa24"
  • "STPMexico"
  • "InstaDebit"
  • "ParamountCommerce"
  • "PaymentsOS"
  • "MuchBetter"
  • "NinjaWallet"
  • "Payvision"
  • "CauriPayment"
  • "Adyen"
  • "BlueSnap"
  • "Kushki"
  • "WorldlineAtosFrankfurt"
  • "Aera"
  • "Pagadito"
  • "Triple000"
  • "Unlimit"
  • "EPro"
  • "StaticGateway"
  • "Ingenico"
  • "PharosPayments"
  • "CCAvenue"
  • "ToditoCash"
  • "AsiaPay"
  • "Euteller"
allocations[].paymentInstrumentId String No

ID of the selected payment instrument for the transaction.
id String No

Unique resource ID.
_links[] Array No

Related links.
_links[].href String No

Link URL.
_links[].rel String No

Type of link.

Valid values:

  • "paymentInstrument"
  • "self"
batchId String No

ID of the payout request batch that contains this request.
updatedTime String No

Date and time when the payout request is updated.
amount Number Yes

Amount of the payout.
blocked Boolean No

Specifies whether the payout request is blocked or unblocked.
selectPaymentInstrumentUrl String No

URL for the customer to select a preferred payment instrument.
selectedPaymentInstrumentRedirectUrl String No

URL where the customer is redirected when a payment instrument is selected. The default value is the website URL. Use {{id}} as a placeholder for the payout request ID.
cancellationReason Object No

Reason the payout request is canceled.
cancellationReason.description String No

Description of the cancellation reason in free form.
cancellationReason.canceledBy String No

Specifies who initiated the cancellation.

Valid values:

  • "merchant"
  • "customer"

Default value: "customer"
paymentInstrumentId String No

ID of the requested payment instrument to offer for the payout.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2026 SimWorkflow
Terms of Service Privacy Policy