Vous êtes ici: Planyo » Aide » API » add_reservation_payment

add_reservation_payment

Description:

Adds a payment for a reservation. You may NOT pass customer's credit card numbers in any of the fields. Planyo doesn't keep any credit card numbers on its servers.

Input:

Reservation ID for which the payment will be added. Required unless reservation_ids is used.You can optionally pass multiple comma-separated reservation IDs (max 50) in this parameter. If this parameter is passed, you may NOT pass any value in the parameter reservation_id. To add the same payment amount to all reservations, pass a single value in amount. For multiple values (different for each reservation), pass multiple comma-separated values corresponding to reservation_ids passed in the parameter named amounts (in the same way you can pass multiple transaction_ids instead of specifying a single ID). Note that the JSON data returned by an API call with this parameter will be different. The 'data' key will be an array with reservation IDs as keys and the values corresponding to the standard output of this function (see the Output section below) for given reservation ID.The method used to make the payment: 2 - offline (cash), 3 - cheque, 4 - bank transfer, 5 - other, 6 - gift certificate, 9 - discount, 10 - credit card number left on file, 40-45 - custom payment methods #1-6, or one of the payment gateways: 64 - Test gateway, 99 - Custom payment gateway, 62 - 24-7payment.com (CH), 55 - 4CS FMX TranPage (The Caribbean), 106 - Adyen, 102 - Authorize.net (US) Accept Hosted, 13 - Authorize.net (US) Legacy, 21 - Authorize.net - DPM (US) Legacy, 113 - Bambora (NO, SE), 33 - Be2bill (FR), 34 - Be2bill (Test Mode), 111 - Billmate Checkout (SE), 98 - Bitvolo (BTC/XRP/ETH/ADA cryptocurrencies, SEPA and BTC LN via Strike), 77 - Braintree, 78 - CartaSi (IT), 28 - CCAvenue (IN) Legacy, 112 - Checkout Finland / Paytrail (FI), 35 - Checkout.fi Legacy (FI), 127 - Clover Checkout (US, CA, EU), 46 - CM-CIC / Monetico (FR), 31 - Cobrebem (BR), 32 - Cobrebem (Test Mode), 52 - Coinbase (Bitcoin, Crypto), 67 - ConCardis (DE, CH), 68 - Credomatic / PayCom (Central America / Mexico), 71 - Datatrans (CH), 38 - DIBS FlexWin Legacy, 39 - DIBS FlexWin Legacy (Test Mode), 29 - DIBS Legacy, 30 - DIBS Legacy (Test Mode), 81 - DOKU (IN), 126 - DOKU - Jokul Checkout (IN), 18 - EBS (IN), 104 - EpayNC (NC), 47 - EWAY Hosted Payment Page (AU, NZ), 48 - EWAY Responsive Shared Page (AU, NZ), 88 - Global Payments (prev Realex) (IE/UK), 90 - Heidelpay - Credit Cards (DE), 91 - Heidelpay - Sofort (DE), 100 - Helcim, 138 - HelcimPay (USA/CA), 70 - Hipay (BE), 80 - Homelocpay (FR), 73 - Innocard InnoPay (CH), 97 - Klick&Pay (FR), 87 - Make Commerce (EE), 22 - MasterCard MiGS (AU), 25 - Mercanet / BNP Paribas (FR), 82 - MisterTango (LT), 95 - Mollie (NL), 101 - Moneris (CA) Legacy, 37 - Montrada (DE), 74 - mPAY24 (AT), 16 - MultiSafepay (NL), 17 - MultiSafepay (Test Mode), 63 - Netaxept / Nets.eu (NO, SE, DK, FI), 117 - Nets Easy (EN, NO, SE, DK), 53 - Ogone, 15 - Opayo (prev. SagePay) (Test Mode), 14 - Opayo (prev. SagePay) (UK), 75 - OSB / Océanienne de services bancaires (PF), 125 - Pay360, 24 - Paybox (FR), 96 - PayGenius (ZA), 1 - PayPal, 124 - PayPal Checkout, 109 - PayPal Plus (DE), 7 - PayPal Sandbox (Test), 69 - PayPoint SecPay (UK), 120 - Payrexx (CH), 86 - PayU Latin America, 114 - PayWay Sinergia (IT), 72 - PayZen (FR), 83 - Piraeus Bank - ePos PayCenter (GR), 119 - PostFinance Checkout (CH), 84 - PostFinance Legacy (CH), 60 - Przelewy24 (PL), 123 - SaltPay (prev Borgun) (IS), 10 - Sauvegarder les numéros de cartes de crédit sur mon serveur, 19 - Servired (ES), 20 - Servired (Test Mode), 49 - Sherlock's / LCL (FR), 122 - SimplePay (HU), 54 - SIX Saferpay (CH), 8 - Skrill, 76 - Société Générale PayZen (FR), 118 - Société Générale Sogecommerce (FR), 57 - Sogenactif / Paylib (FR), 108 - Square Checkout, 107 - Stripe Checkout, 56 - Stripe Legacy, 103 - Stripe Payment Intents, 89 - Stripe SOFORT, 27 - Systempay (Test Mode), 26 - Systempay / BPCE (FR), 94 - TIPI (FR), 115 - Unzer, 121 - Up2Pay / Crédit Agricole (FR), 137 - Viva Wallet Smart Checkout (EU), 116 - Viveum Meteorpay, 79 - VR Pay (DE), 23 - Wirecard, 105 - Wirecard Payment Page (HPP), 11 - WorldPay Business, 12 - WorldPay Business (Test Mode), 85 - WorldPay Online LegacyOne of the values representing the status of the payment: 1 - payment successful, 2 - payment is pending, 3 - error, 4 - this is a refundThe response code returned by payment gateway. This can be a number or a text symbol like 'OK' etc.Unique transaction ID of the payment.Optional status text e.g. reason for errorYou can optionally pass an alternative transaction time for this payment.You can optionally add any custom info to the payment.The payment amount, e.g. 15.25 or 0.3-letter (ISO 4217) currency code e.g. EUR, USD, CHF, GBP etc.Set this to true if you don't want any post-payment processing to be done as a result of the payment. This could include: email notifications sent and/or status changed (to confirmed or cancelled in case of a full refund). The default value is false.must be set to add_reservation_paymentby specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returnedyour API key - Click here to get your key. If your API key uses a hash key, you must also include the parameters hash_key and hash_timestamp.

Output:

Status of the reservation after the paymentID of the added payment

API playground:

Click here to test this function in the API playground.