Parameters for REST API integration

Follow

This article concerns the setup for the different payment flows for a Custom Integration of the REST API. The parameters below are not relevant for WooCommerce, Magento or Shopify integrations.

The quick reference card below describes the highlights for each flow in case you are doing a Custom Integration. The full documentation here describes the complete Custom setup in further detail.

 

Copy and Pay and MSDK

Server-to-Server

Once off (DB)

Channel (entityID): 3DS
Post to: https://test.oppwa.com/v1/payments/

Channel (entityID): 3DS
Post to: https://test.oppwa.com/v1/payments/

Checkout + card storage (DB + RG)

Channel (entityID): 3DS
createRegistration=true
recurringType=INITIAL

Channel (entityID): 3DS
paymentType=DB
createRegistration=true
recurringType=INITIAL​
Handle 3DS redirect manually (async)

Add card (PA) - standalone storage

Channel (entityID): 3DS
createRegistration=true
amount=1.00
paymentType=PA
recurringType=INITIAL

recurringType=INITIAL
createRegistration=true
amount=1.00
paymentType=PA
Handle 3DS redirect manually (async)
Channel (entityID): 3DS

Subscription - Recurring

Channel (entityID): 3DSrecurringType=REPEATED
Post to: https://test.oppwa.com/v1/registrations/{id}/payments

Channel (entityID): Recur
recurringType=REPEATED
Post to https://test.oppwa.com/v1/registrations/{id}\

3DS Single click

Channel (entityID): 3DS
registrations[n].id=XXXXXXXXXXXXXX

Channel (entityID): 3DS
recurringType=REPEATED
Post to https://test.oppwa.com/v1/registrations/{id}\
Handle 3DS redirect manually (async)

No 3DS Single click

Channel (entityID): 3DS
recurringType=REGISTRATION_BASED
registrations[n].id=XXXXXXXXXXXXXX

Channel (entityID): Recur recurringType=REPEATED
Post to https://test.oppwa.com/v1/registrations/{id}\

Have more questions? Submit a request

Comments

Powered by Zendesk