{"openapi":"3.0.0","info":{"contact":{"email":"paysmakers@rabobank.nl","name":"Rabo Smart Pay Support","url":"https://www.rabobank.nl/bedrijven/betalen/klanten-laten-betalen/rabo-smart-pay/support-overzicht"},"description":"Rabo Smart Pay Merchant Services API allows developers to access functionality of Rabo Smart Pay.\nThis functionality can typically be integrated into backoffice systems of merchants.\n\nAs of October 11th, 2022, Rabo OmniKassa has a new name: Rabo Smart Pay. On a technical level (endpoints, api-calls),\nthis name change has no impact and technical items are not changed.\n\nAs of October 4th, 2022, Payment brand AfterPay has a new name: Riverty. For the time being, the company decided to \nuse both names as a combination: Riverty/AfterPay.  On a technical level (endpoints, api-calls), this name change \nhas no impact and technical items are not changed.\n\nSpecial consideration must be given to so-called 'delayed' transactions. These are pin transactions that arrive at\nRabo Smart Pay (OmniKassa) with a delay of several days. This can occur for example if the terminal was not online \nfor some time. As a consequence these transactions could be missed when querying transactions on a regular basis.\nAn example. Suppose today is September 5th, 2020 and you call the Transaction API to retrieve transactions that\noccurred since yesterday.\n\nFor this call you would typically set the start_datetime parameter to '2020-09-04T00:00:00+02:00'.\nNow if there was a PIN transaction on the 4th which has not arrived at Smart Pay (OmniKassa) yet then clearly this \ntransaction would not be included in the response of the API call. Now suppose that this transaction arrives on \nSeptember 5th in Smart Pay (OmniKassa) after this API call was done. Then the next day, September 6th, a call to \nretrieve the transactions that occurred the day before (September 5th) would still not include this delayed \ntransaction, because the date and time of any pin transaction is set to the moment when it was registered by the \nterminal. For this specific delayed transaction that that would be September 4th. So using this approach the delayed\ntransaction would never be returned in any API call.\n\nThe way to solve this problem is by also including the created_or_updated_at parameter in the call.\nThis parameter denotes the timestamp at which the transaction was stored in Smart Pay (OmniKassa) or last modified. \nAssuming that 7 days is a reasonable upperbound at which delayed transactions arrive at Smart Pay (OmniKassa) then \nany new or updated transaction (delayed or not) can be retrieved by setting the start_datetime parameter to the \ncurrent date and time minus 7 days and the created_or_updated_at to the date and time of the previous API call.\nOf course, this is assuming that the API is called at least once each week. If the API is called less frequently\nthen the value of the start_datetime parameter needs to be updated accordingly.\n\n**Sandbox transaction data**\n\nOn the sandbox environment we have limited transaction data available for test purposes.\nThere are in total 44 transactions with different type of transactions and statuses spread over February until June 2020.\nThe requests are similar to the production environment except the calls must be sent to the\nSmart Pay Merchant Service API Sandbox endpoint https://api-sandbox.rabobank.nl/openapi/sandbox/omnikassa/merchant\n\n**Sandbox refund transaction**\n\nOn the sandbox environment it is possible to simulate different scenarios based on the refund amount provided when initiating a refund request.\n\nAlthough we try to create the example data of our API specification in such a way that data can be retrieved by using the example data, it is not functionality that should be relied upon.\nYou can use the following request data in order to test requests in the sandbox environment.\n\nThe following are the amounts (in euro) that can be used to simulate the corresponding scenarios when a refund is initiated. Any other amount will trigger a pending refund.\n* 2.00: MAXIMUM_REFUNDABLE_AMOUNT_EXCEEDED\n* 3.00: REFUND_PERIOD_EXPIRED\n* 4.00: UNKNOWN_TRANSACTION_OR_REFUND_NOT_SUPPORTED\n* 5.00: UNKNOWN\n* 10.00: simulates a partial refund transaction for Riverty/Afterpay which requires a description and vat category in the request.\n* 20.00: simulates an iDEAL refund transaction\n\nWhen the request is created successfully, the status will be pending. Use the get api to check the status of the refund.\n\n**Sandbox retrieve refund transaction**\n\nThe following refund IDs can be used to retrieve specific refund transaction, each of which has a specific status:\n* 926a0c88-aa9e-4897-8bc6-0c4f770cc8a5: simulates a successful refund transaction\n* 96436fe3-caef-4af8-9cb5-dacc0d5e8907: simulates a failed refund transaction\n* cc094aeb-89f7-4123-b60b-ccf83a16320d: simulates a pending refund transaction\n* a3e5c64d-6f0d-45fd-b0f6-0b6bc1124a44: simulates a pending partial transaction for Riverty/Afterpay\n\nWhich transaction ID is used is not relevant, as far as it is a valid UUID. Any other refund id in the request will return a NOT_FOUND\n\n**Sandbox retrieve refundable details**\n\nThe following transaction IDs can be used to retrieve refundable details responses:\n* 22b36073-57a3-4c3d-9585-87f2e55275a5: simulates a successful refundable details response\n* 172f0295-daca-4783-971b-34f89847e69e: simulates an UNKNOWN error response\n\nAny other transaction id in the request will return a NOT_FOUND\n\n**Sandbox retrieve Payouts**\n\nOn the sandbox environment we have limited payout data available for test purposes.\nThe payout sandbox data available is spread over February until June 2020 so please consider that when using date time filters.\n","termsOfService":"https://media.rabobank.com/m/76c8550a1467d125/original/Algemene-Voorwaarden-Rabo-Smart-Pay.pdf","title":"Rabo Smart Pay Merchant Services API","version":"3.2.33","x-api-id":"bf379754-e8e9-4d95-85d0-00679d78b991","x-audience":"component-internal","x-ibm-name":"omnikassa-merchant-services-api"},"servers":[{"url":"https://api.rabobank.nl/openapi/omnikassa/merchant","description":"Production server"},{"url":"https://api-sandbox.rabobank.nl/openapi/sandbox/omnikassa/merchant","description":"Sandbox server"}],"paths":{"/payouts":{"post":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutsResponse"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrors"}}},"description":"Invalid request."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrors"}}},"description":"X-Api-Org-Id value is missing on the header"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrors"}}},"description":"Internal server error."},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrors"}}},"description":"Transaction Query Service is unavailable"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrors"}}},"description":"Unexpected error"}},"tags":["Payouts"],"description":"Use this endpoint to query payout data using filters.","operationId":"PayoutSearch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutsRequest"}}},"description":"The request body containg the payout filters used in the search"},"summary":"Query payouts"}},"/payouts/{payoutId}":{"get":{"parameters":[{"description":"Unique value identifying the payout within Smart Pay.","example":"a558927a-9fe0-4925-b371-ec59971d2811","in":"path","name":"payoutId","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutDetails"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrors"}}},"description":"Invalid request."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrors"}}},"description":"Internal server error."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrors"}}},"description":"Unexpected error"}},"tags":["Payouts"],"description":"Use this endpoint to retrieve a payout information details.","operationId":"GetPayoutDetails","summary":"Payout information"}},"/transactions":{"post":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionsResponse"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrors"}}},"description":"Invalid request."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrors"}}},"description":"X-Api-Org-Id value is missing on the header"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrors"}}},"description":"Internal server error."},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrors"}}},"description":"Transaction Query Service is unavailable"},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrors"}}},"description":"Unexpected error"}},"tags":["Transactions"],"description":"Use this endpoint to query transaction data using filters.","operationId":"TransactionsSearch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionsRequest"}}},"description":"The request body containg the transaction filters used in the search","required":true},"summary":"Query transactions"}},"/transactions/{transactionId}/refundable-details":{"get":{"parameters":[{"description":"Unique value identifying the transaction within Smart Pay.","example":"22b36073-57a3-4c3d-9585-87f2e55275a5","in":"path","name":"transactionId","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundableDetailsResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrors"}}},"description":"Invalid request."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrors"}}},"description":"Internal server error."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrors"}}},"description":"Unexpected error"}},"tags":["Refunds"],"description":"Use this endpoint to retrieve the refundable details of a payment transaction.","operationId":"GetRefundableDetails","summary":"Refundable details of a transactions"}},"/transactions/{transactionId}/refunds":{"post":{"parameters":[{"description":"Unique value to enforce idempotency","example":"a2b36073-57a3-4c3d-9585-87f2e55275aa","in":"header","name":"X-Request-ID","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Unique value identifying the transaction within Smart Pay.","example":"22b36073-57a3-4c3d-9585-87f2e55275a5","in":"path","name":"transactionId","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRefundResponse"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrors"}}},"description":"Invalid request."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrors"}}},"description":"Internal server error."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrors"}}},"description":"Unexpected error"}},"tags":["Refunds"],"description":"Use this endpoint to initiate a refund for a payment transaction.","operationId":"CreateRefund","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundRequest"}}},"description":"The request body containing the refund details","required":true},"summary":"Refund transactions"}},"/transactions/{transactionId}/refunds/{refundId}":{"get":{"parameters":[{"description":"Unique value identifying the transaction within Smart Pay.","example":"22b36073-57a3-4c3d-9585-87f2e55275a5","in":"path","name":"transactionId","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Unique value identifying the refund transaction within Smart Pay.","example":"926a0c88-aa9e-4897-8bc6-0c4f770cc8a5","in":"path","name":"refundId","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRefundResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrors"}}},"description":"Invalid request."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrors"}}},"description":"Internal server error."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrors"}}},"description":"Unexpected error"}},"tags":["Refunds"],"description":"Use this endpoint to retrieve a refund for a payment transaction.","operationId":"GetRefundInformation","summary":"Refund transactions information"}}},"components":{"parameters":{"payoutId":{"description":"Unique value identifying the payout within Smart Pay.","example":"a558927a-9fe0-4925-b371-ec59971d2811","in":"path","name":"payoutId","required":true,"schema":{"format":"uuid","type":"string"}},"refundId":{"description":"Unique value identifying the refund transaction within Smart Pay.","example":"926a0c88-aa9e-4897-8bc6-0c4f770cc8a5","in":"path","name":"refundId","required":true,"schema":{"format":"uuid","type":"string"}},"requestId":{"description":"Unique value to enforce idempotency","example":"a2b36073-57a3-4c3d-9585-87f2e55275aa","in":"header","name":"X-Request-ID","required":true,"schema":{"format":"uuid","type":"string"}},"transactionId":{"description":"Unique value identifying the transaction within Smart Pay.","example":"22b36073-57a3-4c3d-9585-87f2e55275a5","in":"path","name":"transactionId","required":true,"schema":{"format":"uuid","type":"string"}}},"schemas":{"AccountHolderIban":{"description":"The IBAN of the account holder for an iDEAL payment.","example":"NL76RABO000000000","pattern":"^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{11,30}$","type":"string"},"AccountHolderName":{"description":"The name of the account holder for an iDEAL payment.","example":"James Bond","type":"string","maxLength":70},"AmountLowerLimit":{"description":"The minimum amount to filter on.","example":0,"format":"decimal","maximum":99999999.99,"minimum":-99999999.99,"type":"number"},"AmountUpperLimit":{"description":"The maximum amount to filter on.","example":1500,"format":"decimal","maximum":99999999.99,"minimum":-99999999.99,"type":"number"},"ApiError":{"description":"Error occurred - see status code and problem object for more information.","properties":{"error_code":{"description":"A textual value identifying the type of error.","example":"ORG_ID_NOT_FOUND","pattern":"^[A-Z]+(_[A-Z]+)*$","type":"string"},"error_message":{"description":"A textual description of the error.","example":"Invalid request","maxLength":256,"minLength":1,"type":"string"}},"required":["error_code","error_message"],"type":"object"},"ApiErrors":{"description":"Error occurred - see status code and problem object for more information.","properties":{"errors":{"items":{"$ref":"#/components/schemas/ApiError"},"type":"array"}},"type":"object"},"BeneficiaryAccountIban":{"description":"The IBAN of the beneficiary account for the transaction.","example":"NL76RABO000000000","pattern":"^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{11,30}$","type":"string"},"BeneficiaryAccountName":{"description":"The name of the beneficiary account for the transaction.","example":"James Bond","type":"string","maxLength":70},"CommercialUnitId":{"description":"Unique value identifying the commercial unit.","example":37020,"format":"int64","type":"integer"},"ContractId":{"description":"The ID of the Rabo Smart Pay merchant contract.","example":1,"format":"int64","type":"integer"},"CreateRefundResponse":{"description":"Response for the refund transaction request","properties":{"created_at":{"description":"The timestamp at which the refund transaction was created within Smart Pay.","example":"2020-01-01T13:00:00+01:00","format":"date-time","type":"string"},"description":{"description":"The reason for refund request","example":"Customer request for refund","maxLength":45,"minLength":1,"pattern":"^[a-zA-Z0-9 ]{1,45}$","type":"string"},"payment_brand":{"description":"The Payment brand of the transaction","enum":["IDEAL","IDEAL_QR","AFTERPAY","VISA","MASTERCARD","SOFORT","V_PAY","MAESTRO","PAYPAL","BILLINK","BANCONTACT","VVV","WERO"],"example":"IDEAL","type":"string"},"refund_id":{"description":"The refund request unique identifier","example":"cc094aeb-89f7-4123-b60b-ccf83a16320d","format":"uuid","type":"string"},"refund_money":{"$ref":"#/components/schemas/Money"},"status":{"description":"The initial status of the refund request","enum":["PENDING"],"example":"PENDING","type":"string"},"transaction_id":{"description":"Unique value identifying the payment transaction within Smart Pay.","example":"22b36073-57a3-4c3d-9585-87f2e55275a5","format":"uuid","type":"string"},"vat_category":{"description":"The VAT category of the product. The values refer to the different rates used in the Netherlands. This field is required for partial refunds of payment transactions with payment brand Afterpay.'","enum":["HIGH","LOW","ZERO"],"example":"HIGH","type":"string"}},"required":["created_at","payment_brand","refund_id","refund_money","status","transaction_id"],"type":"object"},"EndDateTime":{"description":"Exclude payouts that occurred after and including this date time (ISO8601)","example":"2020-07-01T00:00:00+02:00","format":"date-time","type":"string"},"EntityName":{"description":"The name of the entity for the configured payout level.","example":"77XVR0","type":"string"},"GetRefundResponse":{"properties":{"created_at":{"description":"The timestamp at which the refund transaction was created within Smart Pay.","example":"2020-01-01T13:00:00+01:00","format":"date-time","type":"string"},"description":{"description":"The reason for refund request","example":"Customer request for refund","maxLength":45,"minLength":1,"pattern":"^[a-zA-Z0-9 ]{1,45}$","type":"string"},"payment_brand":{"description":"The Payment brand of the transaction","enum":["IDEAL","IDEAL_QR","AFTERPAY","VISA","MASTERCARD","SOFORT","V_PAY","MAESTRO","PAYPAL","BILLINK","BANCONTACT","VVV","WERO"],"example":"IDEAL","type":"string"},"refund_id":{"description":"The refund request unique identifier","example":"926a0c88-aa9e-4897-8bc6-0c4f770cc8a5","format":"uuid","type":"string"},"refund_money":{"$ref":"#/components/schemas/Money"},"refund_transaction_id":{"description":"When the status is 'SUCCEEDED' this field will contain the identifier of the created refund transaction","example":"4db87f7a-d287-443e-abf8-92500551aaa3","format":"uuid","type":"string"},"status":{"description":"The status of the refund request","enum":["PENDING","SUCCEEDED","FAILED"],"example":"SUCCEEDED","type":"string"},"transaction_id":{"description":"Unique value identifying the payment transaction within Smart Pay.","example":"22b36073-57a3-4c3d-9585-87f2e55275a5","format":"uuid","type":"string"},"updated_at":{"description":"The timestamp at which the refund transaction was last updated within Smart Pay.","example":"2020-01-02T13:00:00+01:00","format":"date-time","type":"string"},"vat_category":{"description":"The VAT category of the product. The values refer to the different rates used in the Netherlands. This field is required for partial refunds of payment transactions with payment brand Afterpay.'","enum":["HIGH","LOW","ZERO"],"example":"HIGH","type":"string"}},"type":"object"},"InterchangePlusPlusDate":{"description":"The date of billing, date interchange plus plus was added.","example":"2020-02-01T00:00:00+01:00","format":"date-time","type":"string"},"Limit":{"default":1000,"description":"The number of items to return.","example":1,"format":"int64","maximum":3000,"minimum":1,"type":"integer"},"MerchantPayoutReference":{"description":"Reference containing payout level, merchant_reconciliation_reference, payout date and payout sequence number\nmerchant_reconciliation_reference is a custom value set by the merchant on the level of the payout. \nThis MerchantPayoutReference can be used as a reference for reconciliation by the merchant\nFormat is: Mrr_[payout_level]: [merchant reconciliation reference] [Date]_[Payout sequence number]\n","example":"Mrr_btlp:  POI6SP 20220314_2","maxLength":50,"type":"string"},"Money":{"properties":{"amount":{"description":"Amount of money in euros.","example":230.15,"format":"decimal","type":"number"},"currency":{"description":"3 letter currency code as defined by ISO-4217","enum":["EUR"],"format":"iso-4217","type":"string"}},"required":["amount","currency"],"type":"object"},"NextPageToken":{"description":"This property is used for pagination and exposes a token that can be use to retrieve the next page of results. Check the description of the starting_after field on how to obtain these pages. If this field is not present in the response then it means that there are no more records available for the search criteria.","example":"1581931210000|d4749848-760d-4301-a3d3-d0648bacdeba","type":"string"},"PaymentBrand":{"description":"The payment brand of the transaction.","enum":["AFTERPAY","BANCONTACT","DEPOSIT","IDEAL","IDEAL_QR","MAESTRO","MASTERCARD","DEBIT_MC","PAYPAL","SOFORT","VISA","VISA_DEBIT","V_PAY","BILLINK","VVV","WERO"],"example":"MAESTRO","type":"string"},"PaymentChannel":{"description":"The payment channel of the transaction.","enum":["DEPOSIT","ONLINE","PAYMENT_REQUEST","PIN","REUSABLE_QR_CODE","VIRTUAL_CASH_REGISTER"],"example":"PIN","type":"string"},"ProcessorParty":{"description":"The processor party used for the transaction. Possible processor party options - (WLFS,CCV,EQUENS,RABOBANK,GELDMAAT,INTERSOLVE,PAYPAL).","example":"EQUENS","type":"string"},"PaymentServiceCode":{"description":"The payment service used for the transaction.","example":"DIDO","maxLength":50,"type":"string"},"Payout":{"description":"Details of a single payout.","properties":{"commercial_unit_id":{"$ref":"#/components/schemas/CommercialUnitId"},"contract_id":{"$ref":"#/components/schemas/ContractId"},"entity_name":{"$ref":"#/components/schemas/EntityName"},"merchant_payout_reference":{"$ref":"#/components/schemas/MerchantPayoutReference"},"number_of_transactions":{"description":"The number of transactions in the settlement.","example":23,"format":"int32","type":"integer"},"payout_amount":{"$ref":"#/components/schemas/Money"},"payout_datetime":{"description":"The payout date time (ISO8601).","example":"2020-06-09T08:00:00+02:00","format":"date-time","type":"string"},"payout_iban":{"$ref":"#/components/schemas/PayoutIban"},"payout_id":{"$ref":"#/components/schemas/PayoutId"},"payout_level":{"$ref":"#/components/schemas/PayoutLevel"},"payout_reference":{"$ref":"#/components/schemas/PayoutReference"},"payout_status":{"description":"The payout status.","enum":["INITIATED","SETTLED"],"example":"SETTLED","type":"string"},"poi_id":{"$ref":"#/components/schemas/PoiId"},"shop_id":{"$ref":"#/components/schemas/ShopId"},"terminal_id":{"$ref":"#/components/schemas/TerminalId"}},"required":["contract_id","entity_name","payout_id","payout_level","payout_reference","payout_status"],"type":"object"},"PayoutDetails":{"allOf":[{"$ref":"#/components/schemas/Payout"},{"properties":{"payments_amount":{"$ref":"#/components/schemas/Money"},"refunds_amount":{"$ref":"#/components/schemas/Money"}},"type":"object"}]},"PayoutIban":{"description":"The IBAN to where the amount was settled.","example":"NL76RABO000000000","pattern":"^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{11,30}$","type":"string"},"PayoutId":{"description":"Unique value identifying the payout within Smart Pay.","example":"a558927a-9fe0-4925-b371-ec59971d2811","format":"uuid","type":"string"},"PayoutLevel":{"description":"The payout level.","enum":["POI","SHOP","CONTRACT","COMMERCIAL_UNIT"],"example":"POI","type":"string"},"PayoutReference":{"description":"The payout reference. For filters, partial matching is supported (e.g., by payout date like 20200410 or sequence number like _1).","example":"Betaalpunt_77XVR0 20200410_1","maxLength":50,"type":"string"},"PayoutsRequest":{"description":"This object contains various options that can be used to filter payouts that must be returned.\n","properties":{"amount_lower_limit":{"$ref":"#/components/schemas/AmountLowerLimit"},"amount_upper_limit":{"$ref":"#/components/schemas/AmountUpperLimit"},"commercial_unit_id":{"$ref":"#/components/schemas/CommercialUnitId"},"end_datetime":{"$ref":"#/components/schemas/EndDateTime"},"entity_name":{"$ref":"#/components/schemas/EntityName"},"limit":{"$ref":"#/components/schemas/Limit"},"merchant_payout_reference":{"$ref":"#/components/schemas/MerchantPayoutReference"},"payout_iban":{"$ref":"#/components/schemas/PayoutIban"},"payout_level":{"$ref":"#/components/schemas/PayoutLevel"},"payout_reference":{"$ref":"#/components/schemas/PayoutReference"},"shop_id":{"$ref":"#/components/schemas/ShopId"},"start_datetime":{"$ref":"#/components/schemas/StartDateTime"},"starting_after":{"$ref":"#/components/schemas/StartingAfter"},"terminal_id":{"$ref":"#/components/schemas/TerminalId"}},"type":"object"},"PayoutsResponse":{"description":"Payouts resultset","properties":{"next_page_token":{"$ref":"#/components/schemas/NextPageToken"},"payouts":{"items":{"$ref":"#/components/schemas/Payout"},"type":"array"}},"type":"object"},"PoiId":{"description":"Unique value identifying the point of interaction.","example":39544,"format":"int32","type":"integer"},"RefundRequest":{"description":"The refund request body","properties":{"description":{"description":"Reason for refund request","example":"Customer request for refund","maxLength":45,"minLength":1,"pattern":"^[a-zA-Z0-9 ]{1,45}$","type":"string"},"money":{"$ref":"#/components/schemas/Money"},"vat_category":{"description":"The VAT category of the product. The values refer to the different rates used in the Netherlands. This field is required for partial refunds of payment transactions with payment brand Afterpay.'","enum":["HIGH","LOW","ZERO"],"example":"LOW","type":"string"}},"required":["money"],"type":"object"},"RefundableDetailsResponse":{"description":"Response for the refundable details request","properties":{"expiry_datetime":{"description":"The timestamp at which the payment transaction becomes refundable no more.","example":"2020-06-01T13:00:00+01:00","format":"date-time","type":"string"},"refundable_money":{"$ref":"#/components/schemas/Money"},"transaction_id":{"description":"Unique value identifying the payment transaction within Smart Pay.","example":"22b36073-57a3-4c3d-9585-87f2e55275a5","format":"uuid","type":"string"}},"required":["expiry_datetime","refundable_money","transaction_id"],"type":"object"},"SettlementMode":{"description":"The settlement mode of the transaction.","enum":["COLLECTING","DISTRIBUTING"],"example":"COLLECTING","type":"string"},"ShopId":{"description":"Unique value identifying the shop.","example":4894,"format":"int64","type":"integer"},"StartDateTime":{"description":"Exclude records that occurred before this date time (ISO8601)","example":"2020-02-01T00:00:00+01:00","format":"date-time","type":"string"},"StartingAfter":{"description":"This property contains a token and is used for pagination. For example, if you send a query and receive the first page of 1000 entries, the response will contain a next_page_token. This value can be set in the starting_after filter of the subsequent request to retrieve the next page of the result set.","example":"1581935530000|3b35d1ad-cf7b-4c9d-9757-90a4b8f83b59","maxLength":60,"type":"string"},"TerminalId":{"description":"Unique value identifying the terminal.","example":"77XVR0","maxLength":16,"type":"string"},"Transaction":{"description":"Details of a single transaction.","properties":{"account_holder_iban":{"$ref":"#/components/schemas/AccountHolderIban"},"account_holder_name":{"$ref":"#/components/schemas/AccountHolderName"},"backup_mode":{"description":"Whether or not the transaction was initiated in backup mode","type":"boolean"},"beneficiary_account_iban":{"$ref":"#/components/schemas/BeneficiaryAccountIban"},"beneficiary_account_name":{"$ref":"#/components/schemas/BeneficiaryAccountName"},"card_input_mode":{"description":"From the `posData` uses it to identify the method by which card data was entered on the POS terminal.","maxLength":20,"type":"string"},"card_number":{"description":"Last 4 digits of the Primary Account Number","type":"string"},"commercial_unit_id":{"$ref":"#/components/schemas/CommercialUnitId"},"commercial_unit_name":{"description":"The name of the commercial unit.","example":"Rotterdam","maxLength":50,"type":"string"},"consumer_name":{"description":"The name of the consumer.","example":"John Doe","maxLength":128,"type":"string"},"created_or_updated_at":{"description":"The timestamp at which the transaction was created or the timestamp of the transaction's last update. The timestamp is always in \"Europe/Amsterdam\" timezone.","example":"2020-09-22T23:29:22+02:00","format":"ISO8601","type":"string"},"date_time":{"description":"The timestamp at which the transaction was created within Smart Pay. The timestamp is always in \"Europe/Amsterdam\" timezone.","example":"2020-02-17T10:20:10+01:00","format":"ISO8601","type":"string"},"equens_transaction_id":{"description":"The ID of the transaction as known within Equens.","example":"TDS81360196549317310","maxLength":50,"type":"string"},"interchange_fee":{"$ref":"#/components/schemas/Money"},"interchange_plus_plus_date":{"$ref":"#/components/schemas/InterchangePlusPlusDate"},"merchant_activated_transaction_status":{"description":"The status when a transaction is initiated in backup mode | 1 successful | 2 pending | 4 failed","example":"1","maxLength":1,"type":"string"},"merchant_name":{"description":"The name of the merchant as registered within Rabo Smart Pay to which this transaction belongs to.","example":"Foodstuff","maxLength":50,"type":"string"},"merchant_payout_reference":{"$ref":"#/components/schemas/MerchantPayoutReference"},"omnikassa_contract_id":{"$ref":"#/components/schemas/ContractId"},"omnikassa_transaction_id":{"description":"Unique value identifying the transaction within Smart Pay.","example":"d4749848-760d-4301-a3d3-d0648bacdeba","format":"uuid","type":"string"},"pan_entry_mode":{"description":"Online card transactions are indicated by the PAN entry mode","maxLength":40,"type":"string"},"payment_brand":{"$ref":"#/components/schemas/PaymentBrand"},"payment_channel":{"$ref":"#/components/schemas/PaymentChannel"},"processor_party":{"$ref":"#/components/schemas/ProcessorParty"},"payment_service_code":{"$ref":"#/components/schemas/PaymentServiceCode"},"payout_id":{"$ref":"#/components/schemas/PayoutId"},"payout_level":{"$ref":"#/components/schemas/PayoutLevel"},"payout_reference":{"$ref":"#/components/schemas/PayoutReference"},"poi_id":{"$ref":"#/components/schemas/PoiId"},"poi_name":{"description":"The name of the point of interaction.","example":"Foodstuff Restaurant Rotterdam","maxLength":50,"type":"string"},"reference":{"description":"The merchant order ID for online transactions, the authorization code for POS transactions or the sealbag ID for sealbags.","example":"14","maxLength":255,"type":"string"},"refundable":{"description":"Whether or not refunds are supported for a transaction","example":false,"type":"boolean"},"scheme_fee":{"$ref":"#/components/schemas/Money"},"settlement_mode":{"$ref":"#/components/schemas/SettlementMode"},"shop_id":{"$ref":"#/components/schemas/ShopId"},"shop_name":{"description":"The name of the shop.","example":"Foodstuff Restaurant","maxLength":50,"type":"string"},"terminal_batch_reference":{"description":"Reference number assigned by the terminal-host to a batch of transactions done in backup mode","example":"0000000005","maxLength":10,"type":"string"},"terminal_id":{"$ref":"#/components/schemas/TerminalId"},"total_transaction_fee":{"$ref":"#/components/schemas/Money"},"transaction_amount":{"$ref":"#/components/schemas/Money"},"transaction_status":{"$ref":"#/components/schemas/TransactionStatus"},"transaction_type":{"$ref":"#/components/schemas/TransactionType"},"wallet":{"$ref":"#/components/schemas/Wallet"}},"required":["commercial_unit_id","created_or_updated_at","date_time","omnikassa_contract_id","omnikassa_transaction_id","payment_brand","payment_channel","poi_id","refundable","shop_id","transaction_amount","transaction_status","transaction_type"],"type":"object"},"TransactionStatus":{"description":"The state that the transaction is in.","enum":["ACCEPTED","CANCELLED","EXPIRED","FAILURE","NEW","SETTLED","SUCCESS"],"example":"SETTLED","type":"string"},"TransactionType":{"description":"The type of the transaction.","enum":["AUTHORIZE","CAPTURE","CORRECTION","FULL_FULFILLMENT","OUTSTANDING_FULFILLMENT","PARTIAL_FULFILLMENT","PAYMENT","REFUND","REVERSAL","CANCELLATION","CHARGEBACK","PRE_AUTHORISATION","ASI","AUTHORISATION"],"example":"PAYMENT","type":"string"},"TransactionsRequest":{"description":"This object contains various options that can be used to filter the transactions that must be returned.\n","properties":{"account_holder_iban":{"$ref":"#/components/schemas/AccountHolderIban"},"account_holder_name":{"$ref":"#/components/schemas/AccountHolderName"},"amount_lower_limit":{"$ref":"#/components/schemas/AmountLowerLimit"},"amount_upper_limit":{"$ref":"#/components/schemas/AmountUpperLimit"},"commercial_unit_ids":{"items":{"$ref":"#/components/schemas/CommercialUnitId"},"type":"array"},"consumer_name":{"description":"The name of the consumer to filter transactions on.","example":"John Doe","maxLength":128,"type":"string"},"created_or_updated_after":{"description":"Include only transactions that were created or updated after this timestamp (inclusive).","example":"2020-01-01T00:00:00+01:00","format":"ISO8601","type":"string"},"created_or_updated_before":{"description":"Include only transactions that were created or updated before this timestamp (exclusive).","example":"2021-01-01T00:00:00+01:00","format":"ISO8601","type":"string"},"currency":{"description":"The currency of the transaction to filter on.","enum":["EUR"],"example":"EUR","type":"string"},"end_datetime":{"$ref":"#/components/schemas/EndDateTime"},"limit":{"$ref":"#/components/schemas/Limit"},"payment_brands":{"items":{"$ref":"#/components/schemas/PaymentBrand"},"type":"array"},"payment_channels":{"items":{"$ref":"#/components/schemas/PaymentChannel"},"type":"array"},"processor_parties":{"items":{"$ref":"#/components/schemas/ProcessorParty"},"type":"array"},"payment_service_code":{"$ref":"#/components/schemas/PaymentServiceCode"},"payout_id":{"$ref":"#/components/schemas/PayoutId"},"payout_level":{"$ref":"#/components/schemas/PayoutLevel"},"payout_reference":{"$ref":"#/components/schemas/PayoutReference"},"poi_id":{"$ref":"#/components/schemas/PoiId"},"poi_name":{"description":"The name of the poi as configured by the merchant to filter transactions on.","example":"000016","maxLength":255,"type":"string"},"reference":{"description":"The merchant order ID for online transactions, the authorization code for POS transactions or the sealbag ID for sealbags.","example":"000016","maxLength":255,"type":"string"},"shop_ids":{"items":{"$ref":"#/components/schemas/ShopId"},"type":"array"},"start_datetime":{"$ref":"#/components/schemas/StartDateTime"},"starting_after":{"$ref":"#/components/schemas/StartingAfter"},"terminal_id":{"$ref":"#/components/schemas/TerminalId"},"transaction_statuses":{"items":{"$ref":"#/components/schemas/TransactionStatus"},"type":"array"},"transaction_types":{"items":{"$ref":"#/components/schemas/TransactionType"},"type":"array"},"wallet_ids":{"items":{"$ref":"#/components/schemas/WalletId"},"type":"array"}},"required":["start_datetime"],"type":"object"},"TransactionsResponse":{"description":"Transaction resultset","properties":{"next_page_token":{"$ref":"#/components/schemas/NextPageToken"},"transactions":{"items":{"$ref":"#/components/schemas/Transaction"},"type":"array"}},"type":"object"},"Wallet":{"description":"If the transaction is done through a wallet, this wallet object will be available","properties":{"name":{"description":"the current brand name for the provider of the wallet","example":"Apple Pay","type":"string"},"wallet_id":{"$ref":"#/components/schemas/WalletId"}},"required":["name","wallet_id"],"type":"object"},"WalletId":{"description":"The unique identifier for the provider of the wallet. Non-semantic to ensure immutability.  1 is 'Apple Pay', 2 is 'Google Pay', 3 is 'Card on File', 4 is 'Click to Pay'","example":"1","type":"string"}},"securitySchemes":{"clientId":{"description":"ClientId as provided by the Rabobank developer portal.","in":"header","name":"X-IBM-Client-Id","type":"apiKey"}}},"security":[{"clientId":[]}],"externalDocs":{"description":"Find out more about Rabo Smart Pay","url":"https://www.rabobank.nl/bedrijven/betalen/klanten-laten-betalen/rabo-smart-pay"},"x-readme":{"explorer-enabled":false,"proxy-enabled":false}}