Passport Payments

Action	Method	End-point

Create New Passport Payment


type	Required	Valid Values: email, text
customer	Required	OmniFund Customer ID
description	Optional	Text description for the payment request. Will be visible to the customer
email	Conditional	If “type” is set to email, this field indicates the destination address to send the request.
phone	Conditional	If “type” is set to text, this field indicates the destination phone number to send the request.
country_code	Conditional	If “type” is set to text, this field indicates the country code of the destination phone number to send the request.
poNumber	Optional	Non-indexed text field can be used by the merchant to help identify the transaction. Visible to the customer.
referenceId	Optional	Non-indexed text field can be used by the merchant to help identify the transaction. Not visible to the customer.
subTotal	Required	Amount of the transaction, minus any tax or discount amounts.
tax	Optional	Tax amount applied to the transaction
discount	Optional	Discount amount applied to the transaction
total	Required	Total amount of the transaction

POST /api/v1/passports
{
  "type":"email",
  "email":"test@omnifund.com",
  "subTotal":2.25,
  "total":2.25
}

Retrieves the details of a single passport payment based on the supplied unique identifier.

Argument	Type	Description

Argument	Type	Description
id	string	Required. The event identifier to be retrieved.

GET /api/v1/passports/f4244e2e8b29426b9c490597f21e6b51

Update a previously created passport payment. Same field structure as the create method, but applied to the supplied unique identifier

POST /api/v1/passports/f4244e2e8b29426b9c490597f21e6b51
{
  "type":"email",
  "email":"test@omnifund.com",
  "subTotal":3.00,
  "total":3.00
}

Delete a single passport payment based on the supplied unique identifier.