API Reference

Send signup email

post
https://api.farpay.io/v2/customers//agreementRequest

Sends a signup email to the customer' email address. Where the user can signup for an automated payment agreement.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Your customer reference

Query Params
string
required

Types available are: "ls", "bs", "card", "mp" or "all" when you want the customer to select between available payment types. Other values are rejected

string

the destination of the email that is to be sent

string

Your customer phone number

Responses
200

Message sent to customer

400

Invalid type - see body for details

401

apiKey is unauthorized

404

Customer not found

405

Method not allowed in types

502

Bad gateway - MobilePay specific error

Updated about 1 year ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated about 1 year ago