Passport Payments

Action	Method	End-point

Action	Method	End-point
Delete a Passport Payment	DELETE	`/api/v1/passports/{id}`
Retrieve a Passport Payment	GET	`/api/v1/passports/{id}`
Update Passport Payment	POST	`/api/v1/passports/{id}`
Create new Passport Payment	POST	`/api/v1/passports`

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. The destination phone number should be formatted as follows EX: `-888-888-8888`
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	Required	Non-indexed text field can be used by the merchant to help identify the transaction. Visible to the customer. Enter a blank value for no poNumber.
referenceId	Required	Non-indexed text field can be used by the merchant to help identify the transaction. Not visible to the customer. Enter a blank value for no referenceId.
subTotal	Required	Amount of the transaction, minus any tax or discount amounts.
tax	Required	Tax amount applied to the transaction. Enter a value of 0 for no tax added.
discount	Required	Discount amount applied to the transaction. Enter a value of 0 for no discount applied.
total	Required	Total amount of the transaction
lineItems	Required	Please provide an empty array here. EX: `[]`
notes	Optional	Notes are internal to the transaction and are not visible to the customer.
memo	Optional	Memo is visible on the transaction to the paying customer.
nosurcharge	Optional	Valid Values: n, y (DEFAULT = n) y = a surcharge WILL NOT be added n = a surcharge may be added
tip	Optional	Valid Values: n, y (DEFAULT = n) y = a tip CAN BE added n = a tip can NOT be added

Basic Example

POST /api/v1/passports
{
    "customer": "123456789",
    "total": "1.09",
    "subTotal": "1.09",
    "tax": "0",
    "discount": "0",
    "poNumber": "",
    "referenceId": "",
    "type": "email",
    "email": "test@omnifund.com",
    "lineItems": []
}

Full Field Example

Retrieve a Passport Payment

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.

Example

Update Passport Payment

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

Example

Delete a Passport Payment

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