BPAPI Methods

BPAPI method Subscription/RegisterPayment

Subscription/RegisterPayment

Registers initiation of subscription payment for the given {customer_id} and {subscription}.

Authorization required: No

HTTP methods allowed: GET

Syntax: Subscription/RegisterPayment/{customer_id}/{subscription}/  Details   Details 

Syntax: Subscription/RegisterPayment/{customer_id}/{subscription}/{callback_url}/  Details 

Registers initiation of subscription payment for the given {customer_id} and {subscription}.

{customer_id} may also (more useful) be specified as registrationId (valueCode) of a specific gateway. This is essential if the customer has more than one gateway.
Returns the following key / value information
transaction_id: Id that may be used for completing the payment (completion as seen from the user's perspective. See also completion_url)
completion_url: URL for completing the payment (completion as seen from the user's perspective. Note that completion and credit-card handling is usually done outside of BPAPI by a third-party)

payment_completion_information: When developer_mode has been set this property will give test credit-card numbers that may be used. (This last key-value property will most probably not be used as calling this method is usually done after necessary information has been presented to the user. Note that the same property payment_completion_information is also available by Subscription/VerifyRegistrationId which is called earlier in the payment process.)

{callback_url} specifies to where the clients web browser should be redirected after the payment process has completed. https:// will be prepended to this URL and a status like Fail or OK will be appended


See Subscription/Register

Popularity: 26688 (number of times method has been accessed)

Documentation and tests automatically generated from source-code 2020-08-03 15:21