Documentation

Creates a payment request record and processes the payment.

post
https://api-sandbox.nofrixion.com/api/v1/paymentrequests/payondemand

Authorization: End user or Merchant token is required.

User permissions required: CanCreatePaymentRequests

Body Params
uuid

The ID of the merchant to create the payment request for.

double
required

The amount of money to request.

string
enum

The currency of the payment request.

string

An optional customer identifier for the payment request. This field is sent to the payer's bank when using payment initiation. The restriction in the available characters is due to some banks rejecting requests when ones outside the set are used.

string

An optional order ID for the payment request. If the request is for an invoice this is the most appropriate field for the invoice ID.

string
enum
deprecated

The payment methods that the payment request supports. When setting using form data should be supplied as a comma separated list, for example "card, pisp, lightning".

PaymentRequestCreate.PaymentMethods
array of strings

The payment methods that the payment request supports.

PaymentRequestCreate.PaymentMethods
string

An optional description for the payment request. If set this field will appear on the transaction record for some card processors.

uuid

The payment account ID to use to receive payment initiation payments. This must match one of your NoFrixion payment account IDs. This can be left blank to use your default payment account.

string

Optionally the first name of the customer's shipping address.

string

Optionally the last name of the customer's shipping address.

string

Optionally the first line of the customer's shipping address.

string

Optionally the second line of the customer's shipping address.

string

Optionally the city of the customer's shipping address.

string

Optionally the state or county of the customer's shipping address.

string

Optionally the post code of the customer's shipping address.

string

Optionally the country code of the customer's shipping address.

string

Optionally the shipping phone number for the customer.

string

Optionally the shipping email address for the customer.

string
deprecated
string
deprecated

For card payments the origin of the payment page needs to be set in advance. A public key context is generated to encrypt sensitive card details and is bound to a single origin URL.

string

Once a payment is processed, or a notification of an inbound payment is received, a callback request will be made to this URL. Typically it will be the page on a merchant's web site that displays the results of the payment attempt.

string

Optional callback URL for payment failures that can occur when the payer is redirected away from the payment page. Typically the payer is only sent away from the payment page for pay by bank attempts. If this URL is not set the payer will be redirected back to the original URL the payment attempt was initiated from.

string

If a payment event results in the payment request being classified as fully paid this success webhook URL will be invoked. The URL will be invoked as a GET request, i.e. there will be no request body. Two query parameters will be added to the URL. The first one will be "id" and will hold the payment request ID. The second one will be "orderid" and will hold the payment request OrderID, note the OrderID could be empty if it was not set when the payment request was created. The recommended approach when receiving a success web hook is to use the "id" parameter to call the moneymoov get payment request endpoint to retrieve the full details of the payment request and check the status. Web hooks can be easily spoofed and should not be relied upon.

boolean

For card payments the default behaviour is to authorise and capture the payment at the same time. If a merchant needs to authorise and then capture at a later point this property needs to be set to true.

boolean

For card payments a payment attempt can be used to create a reusable token for subsequent payments. Setting this field to true will create a reusable customer token.

string
enum

This specifies whether user consent will be taken before tokenising card or not. This cannot be 'None' if CardCreateToken is set to true. If this is set to 'UserConsentRequired' then, the user consent will overwrite CardCreateToken flag on submit card payment.

Allowed:
boolean

If set to true for card payments the sensitive card number and card verification number will be transmitted directly rather than being tokenised. This makes the payment quicker but more exposed to client side flaws such as cross site scripting.

string

Optional field that if specified indicates the processor merchant ID that should be used to process any card payments. Mainly useful where a merchant has multiple processor merchant ID's. If left empty the default merchant card settings will be used.

boolean

If set to true the card payment gateway will be directed to proceed with a payment even if the address verification checks fails.

boolean

If set to true the card payment gateway will be directed to proceed with a payment even if the card verification number check fails.

string
deprecated

For Payment Initiation payments this is the reference that will be requested to used as the reference on the your transaction record. Note that it is not guaranteed that the sending bank will use this reference and in practice it has been observed to be supported by only half to two thirds of banks.

boolean

If set to true, and the merchant is configured for hosted payment pages, the base and callback URLs will be set to use the hosted payment page.

boolean

If set to true for card payments no attempt will be made to use payer authentication (3-D Secure and equivalent). Skipping payer authentication can help avoid failed payment attempts when a payer is not enrolled or when they can't be bothered completing their issuing bank's authentication steps. A disadvantage is it exposes the merchant to liability for charge backs.

string
enum

The approach to use, or not, for accepting partial payments.

Allowed:
string

Optional email address for the customer. If the tokenise card option is set then the customer email address is mandatory.

string
enum

Lists the supported card and PIS processors.

string
date-time
string
uuid

The ID of the bank that is set as the priority bank for display on pay element.

string

A generic field to contain any additional data that the merchant wishes to store against the payment request. E.g. product or service information.

string

An optional comma separated list of partial payment amounts. The amounts represent guidance, or suggestions, as to how the payer will be requested to make partial payments.

uuid

Optional, if set it indicates that this payment request will be used to top up a payment account for a pay run.

int32

Sandbox only. Optional. If set, the simulated Direct Debit settlement will be delayed by the specified number of seconds. Must be greater than 0 and less than 600. Otherwise, the default value will be used.

PaymentRequestCreate.TagIds
array of uuids

An optional list of tag ids to add to the payment request

PaymentRequestCreate.TagIds
PaymentRequestCreate.Tags
array of strings

An optional list of tag values to set on the payment request. If no matching tag exists it will be created.

PaymentRequestCreate.Tags
boolean

If set to true, a receipt will be automatically sent to the CustomerEmailAddress when payments are received.

PaymentRequestCreate.CustomFields
array of objects

A list of custom fields to add to the payment request. The custom fields are data type agnostic which means that the API will not do any validation or formatting in the key-value pairs. The API will store the custom fields as is.

PaymentRequestCreate.CustomFields
date-time

An optional due date for the payment request.

PaymentRequestCreate.FieldDisplaySettings
array of objects

An optional display settings for the payment request fields. This allows the merchant to control how the fields are displayed on the hosted payment page, receipt, etc.

PaymentRequestCreate.FieldDisplaySettings
PaymentRequestCreate.NotificationRoleIDs
array of uuids

An optional list of notification role IDs that will receive notifications about the payment request. This is useful for roles that need to be notified about payment request events.

PaymentRequestCreate.NotificationRoleIDs
string
required
string
required
string

The JWT token is not used if the raw card details are provided. This property is to override the base card property and stop it being required.

string

The Number Token is not used if the raw card details are provided. This property is to override the base card property and stop it being required.

string

The Cvc Token is not used if the raw card details are provided. This property is to override the base card property and stop it being required.

string
required
string
required
string
string
string
string
string
string
string
string
string
string
boolean
double

Optional partial payment amount. If not specified then the full payment request amount will be attempted.

string
required
string
required
string

The tokenised Card Number and CardVerification Number (CVN) details. Typically generated by the CyberSource javascript library.

string
string
string
string
string
string
string
string
string
string
string
string
boolean
double

Optional partial payment amount. If not specified then the full payment request amount will be attempted.

string
enum

The single payment method to use for the pay on demand payment request.

uuid

The ID of the tokenised card to use for the payment. The merchant needs to ensure that the use of the tokenised card is restricted to the same customer that created it.

string
enum

Indicates who initiated the card token payment, customer or merchant.

Allowed:
string

Not used for merchant initiated transactions. Optional for customer initiated transactions. If supplied will be sent to the card processor as a check that the customer using the tokenised card knows the card verification number.

double

Optional partial payment amount. If not specified then the full payment request amount will be attempted.

string
required

This is the ID of the institution (bank) that the payer ha chosen.

double

Optional. If 0 the full amount is assumed.

string
deprecated
string

Optional. If set should indicate the origin URL the payer is making the payment from. If a pay by bank attempt fails and the payment request does not have a FailureCallbackUrl set then the payer will be redirected to this URL.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

201

Returns the payment response.

Updated 9 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 9 months ago