API Reference
Guides

Create a new Payment IFrame

post
https://api.test.payadvantage.com.au/v3/payment_iframes

This endpoint is the recommended way to obtain credit card information from customers. It ensures a PCI compliant IFrame is presented in your application.

PCI-DSS is a security standard from the payment card industry and ensures that all credit card numbers are safely managed.
The Pay Advantage IFrame is the safest way to complete the payment process in your application.
The IFrame also handles all HTML and CSS styling for obtaining credit card information.

Using the IFrame provides immediate access to 3DS security which protects you and your customers against fraud.


This creates a url that is used to initialise an iframe for capturing payment information.
See https://docs.payadvantage.com.au/docs/capture-cards-with-iframe for more information.

Body Params
Customer
object
required
CustomerPaymentAccount
object

The customer payment account to use for authorisation. Cannot be used with PaymentAuthorization. This is an optional field.

double
required

The amount of the payment. Set this to 0.00 to tokenise a card without charging it.

boolean | null

[Optional] Boolean. The desired intent of the payment and if the fee amount should be on-charged. Default is: false

string | null

The description of the payment. When the amount is 0.00, this field is ignored.

string | null

The entities ID from the external system that created it.

boolean | null

This flag indicates if the payment will be authorised or captured. Authorisations are a hold on the funds to allow capturing or voiding the payment at a later date. Default is: true which will result in the payment being instantly created

boolean | null

This will force the user authenticate their payment. For credit card payments this will ensure 3DSecure security is enforced for this payment.

boolean | null

Verifying cards during tokenisation performs a check that the card exists and can be charged. Reducing the risk of failure when the card is charged later.
There may be a fee associated with verifying a card.

PaymentOptions
array of objects
required

The payment options that the customer can use to complete the transaction.

PaymentOptions*
PayTo
object
boolean | null

Controls whether the 'Remember this card' checkbox is shown in the iframe. When true, checkbox appears and user selection is passed as rememberCard in the authorization request.

Responses

Updated 7 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago