Class Syspay_Merchant_BillingAgreementRequest

Process a payment

Syspay_Merchant_BillingAgreementRequest

See: https://app.syspay.com/bundles/emiuser/doc/merchant_api.html#hosted-payment-request
See: https://app.syspay.com/bundles/emiuser/doc/merchant_api.html#server-to-server-credit-card-payment
Located at Syspay/SDK/Merchant/Request/BillingAgreement.php

Methods summary
`public`	# `__construct( String $flow )` Consructor Consructor Parameters `$flow`
`public string`	# `getMethod( )` Get the HTTP method to use to make the request Get the HTTP method to use to make the request Returns `string` HTTP method
`public string`	# `getPath( )` Get the path to call to make the request Get the path to call to make the request Returns `string` API path
`public mixed`	# `buildResponse( stdClass $response )` Build an object based on the decoded response received from the API (turned to a stdClass object) Build an object based on the decoded response received from the API (turned to a stdClass object) Parameters `$response` The data to build the object from Returns `mixed` The object built
`public array`	# `getData( )` Get the data to send to the API for the request Get the data to send to the API for the request Returns `array` An array of data that will be json-encoded by the Syspay_Merchant_Client Overrides `Syspay_Merchant_Request::getData()`
`public string`	# `getFlow( )` Gets the value of flow. Gets the value of flow. Returns `string` string
`public Syspay_Merchant_BillingAgreementRequest`	# `setFlow( string $flow )` Sets the value of flow. Sets the value of flow. Parameters `$flow` the flow Returns `Syspay_Merchant_BillingAgreementRequest` self
`public string`	# `getMode( )` Get the value of mode Get the value of mode Returns `string` string
`public Syspay_Merchant_BillingAgreementRequest`	# `setMode( string $mode )` Sets the value of mode Sets the value of mode Parameters `$mode` Returns `Syspay_Merchant_BillingAgreementRequest` self
`public Syspay_Merchant_BillingAgreementRequest`	# `setThreatMetrixSessionId( string $threatMetrixSessionId )` Sets the value of threatMetrixSessionId Sets the value of threatMetrixSessionId Parameters `$threatMetrixSessionId` Returns `Syspay_Merchant_BillingAgreementRequest` self
`public string`	# `getThreatMetrixSessionId( )` Get the value of threatMetrixSessionId Get the value of threatMetrixSessionId Returns `string` string
`public boolean`	# `getBillingAgreement( )` Gets the value of billingAgreement. Gets the value of billingAgreement. Returns `boolean` boolean
`public Syspay_Merchant_BillingAgreementRequest`	# `setBillingAgreement( boolean $billingAgreement )` Sets the value of billingAgreement. Sets the value of billingAgreement. Parameters `$billingAgreement` the billingAgreement Returns `Syspay_Merchant_BillingAgreementRequest` self
`public string`	# `getEmsUrl( )` Gets the value of emsUrl. Gets the value of emsUrl. Returns `string` string
`public Syspay_Merchant_BillingAgreementRequest`	# `setEmsUrl( string $emsUrl )` Sets the value of emsUrl. Sets the value of emsUrl. Parameters `$emsUrl` the emsUrl Returns `Syspay_Merchant_BillingAgreementRequest` self
`public string`	# `getRedirectUrl( )` Gets the value of redirectUrl. Gets the value of redirectUrl. Returns `string` string
`public Syspay_Merchant_BillingAgreementRequest`	# `setRedirectUrl( string $redirectUrl )` Sets the value of redirectUrl. Sets the value of redirectUrl. Parameters `$redirectUrl` the redirectUrl Returns `Syspay_Merchant_BillingAgreementRequest` self
`public Syspay_Merchant_Entity_Customer`	# `getCustomer( )` Gets the value of customer. Gets the value of customer. Returns `Syspay_Merchant_Entity_Customer` Syspay_Merchant_Entity_Customer
`public Syspay_Merchant_BillingAgreementRequest`	# `setCustomer( Syspay_Merchant_Entity_Customer $customer )` Sets the value of customer. Sets the value of customer. Parameters `$customer` the customer Returns `Syspay_Merchant_BillingAgreementRequest` self
`public Syspay_Merchant_Entity_Creditcard`	# `getCreditcard( )` Gets the value of creditcard. Gets the value of creditcard. Returns `Syspay_Merchant_Entity_Creditcard` Syspay_Merchant_Entity_Creditcard
`public Syspay_Merchant_BillingAgreementRequest`	# `setCreditcard( Syspay_Merchant_Entity_Creditcard $creditcard )` Sets the value of creditcard. Sets the value of creditcard. Parameters `$creditcard` the creditcard Returns `Syspay_Merchant_BillingAgreementRequest` self
`public string`	# `getPaymentMethod( )` Gets the value of paymentMethod. Gets the value of paymentMethod. Returns `string` string
`public Syspay_Merchant_BillingAgreementRequest`	# `setPaymentMethod( string $paymentMethod )` Sets the value of paymentMethod. Sets the value of paymentMethod. Parameters `$paymentMethod` the paymentMethod Returns `Syspay_Merchant_BillingAgreementRequest` self
`public string`	# `getWebsite( )` Gets the value of website. Gets the value of website. Returns `string` string
`public Syspay_Merchant_BillingAgreementRequest`	# `setWebsite( string $website )` Sets the value of website. Sets the value of website. Parameters `$website` the website Returns `Syspay_Merchant_BillingAgreementRequest` self
`public string`	# `getAgent( )` Gets the agent Gets the agent Returns `string` string
`public Syspay_Merchant_BillingAgreementRequest`	# `setAgent( string $agent )` Sets the value of agent. Sets the value of agent. Parameters `$agent` the agent id Returns `Syspay_Merchant_BillingAgreementRequest` self
`public integer`	# `getAllowedRetries( )` Gets the value of allowedRetries. Gets the value of allowedRetries. Returns `integer` integer
`public Syspay_Merchant_BillingAgreementRequest`	# `setAllowedRetries( integer $allowedRetries )` Sets the value of allowedRetries. Sets the value of allowedRetries. Parameters `$allowedRetries` the allowed retries Returns `Syspay_Merchant_BillingAgreementRequest` self
`public string`	# `getBankCode( )` Gets the value of bankCode. Gets the value of bankCode. Returns `string` string
`public Syspay_Merchant_BillingAgreementRequest`	# `setBankCode( string $bankCode )` Sets the value of bankCode. Sets the value of bankCode. Parameters `$bankCode` the bank code Returns `Syspay_Merchant_BillingAgreementRequest` self
`public String`	# `getReference( )` Gets the value of reference. Gets the value of reference. Returns `String` String
`public Syspay_Merchant_BillingAgreementRequest`	# `setReference( String $reference )` Sets the value of reference. Sets the value of reference. Parameters `$reference` the reference Returns `Syspay_Merchant_BillingAgreementRequest` self
`public String`	# `getCurrency( )` Gets the value of currency. Gets the value of currency. Returns `String` String
`public Syspay_Merchant_BillingAgreementRequest`	# `setCurrency( String $currency )` Sets the value of currency. Sets the value of currency. Parameters `$currency` the currency Returns `Syspay_Merchant_BillingAgreementRequest` self
`public string`	# `getDescription( )` Gets the value of description. Gets the value of description. Returns `string` string
`public Syspay_Merchant_BillingAgreementRequest`	# `setDescription( string $description )` Sets the value of description. Sets the value of description. Parameters `$description` the description Returns `Syspay_Merchant_BillingAgreementRequest` self
`public string`	# `getExtra( )` Gets the value of extra. Gets the value of extra. Returns `string` string
`public Syspay_Merchant_BillingAgreementRequest`	# `setExtra( string $extra )` Sets the value of extra. Sets the value of extra. Parameters `$extra` the extra Returns `Syspay_Merchant_BillingAgreementRequest` self

Constants summary
`string`	`FLOW_API`	#`'API'`
`string`	`FLOW_BUYER`	#`'BUYER'`
`string`	`FLOW_SELLER`	#`'SELLER'`
`string`	`MODE_BOTH`	#`'BOTH'`
`string`	`MODE_ONLINE`	#`'ONLINE'`
`string`	`MODE_TERMINAL`	#`'TERMINAL'`
`string`	`METHOD_ASTROPAY_BANKTRANSFER`	#`'ASTROPAY_BANKTRANSFER'`
`string`	`METHOD_ASTROPAY_BOLETOBANCARIO`	#`'ASTROPAY_BOLETOBANCARIO'`
`string`	`METHOD_ASTROPAY_DEBITCARD`	#`'ASTROPAY_DEBITCARD'`
`string`	`METHOD_CLICKANDBUY`	#`'CLICKANDBUY'`
`string`	`METHOD_CREDITCARD`	#`'CREDITCARD'`
`string`	`METHOD_IDEAL`	#`'IDEAL'`
`string`	`METHOD_PAYSAFECARD`	#`'PAYSAFECARD'`
`string`	`METHOD_POSTFINANCE`	#`'POSTFINANCE'`
`string`	`METHOD`	#`'POST'`
`string`	`PATH`	#`'/api/v1/merchant/billing-agreement'`

Classes

Interfaces

Exceptions

Class Syspay_Merchant_BillingAgreementRequest

Parameters

Returns

Returns

Parameters

Returns

Returns

Overrides

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns