The name of the account holder. Either the business name or the individual's name.

* PENDING - The user still needs to enter their card details
* CONSENTED - This consent is ready for use

* PAYMENT_LINKS - The fee charged when settling payments to your WigWag balance
* WITHDRAWAL - The fee charged when withdrawing funds from your WigWag balance

An integer value representing the specific day of the month from 1-31

An integer value representing how many units of frequency are skipped between occurrences. i.e. interval 3 means every 3 months

Will only have a fee once the payment is settled

A reference internal to the platform. Will not show up on any bank statements. Must be less than or equal to 50 characters.

* PENDING - The initial status of a payment that was just created
* EXPIRED - The payment has passed it's expiry time
* PAID - The payment has been paid by the user
* SETTLED - We have allocated the payment to the WigWag merchant balance
* CANCELLED - This payment was cancelled. Unable to be completed

* PAID - The payment has been paid by the user
* SETTLED - We have allocated the payment to the WigWag merchant balance

* SUBSCRIPTION - The payment was created via a Subscription
* CONSENT - The payment was created via a Consent Request
* LINK - The payment was created via a Payment Link

* PROCESSED - The refund has been processed
* FAILED - The refund was not processed

 MO - Monday
 TU - Tuesday
 WE - Wednesday
 TH - Thursday
 FR - Friday
 SA - Saturday
 SU - Sunday

An integer value representing how many units of frequency are skipped between occurrences. i.e. interval 3 means every 3 weeks

* INSTANT - Will be disbursed within the hour
* DEFAULT - Will be disbursed within the next 3 working days

An integer value representing the specific month from 1-12

An integer value representing how many units of frequency are skipped between occurrences. i.e. interval 3 means every 3 years

Welcome to the WigWag API docs. This API will enable you to programmatically create, view and manage your WigWag payments.<br>All routes below are relative to https://just.wigwag.me

WigWag API

Get the verified bank account details for your merchant

Create a new Consent Request to save and charge cards at a later time.

Retrieve a card consent by ID. Great for checking the status.

consentRequestId

Initiate a payment using a consent request. Can only be used with consents who have been granted. If interaction is required we will return status PENDING and an interaction URL to which to send the user. CAUTION: this URL will action the payment amount specified in the request.

Initiate a payment using a consent request

Get fees that were charged to your account

Retrieve an array of payments based on the provided query parameters

Retrieve an array of payment links based on the provided query parameters

The start time of the request window, in ISO date format. Payment links created at or after this time will be returned.

startTime

The end time of the request window, in ISO date format. Payment links created at or before this time will be returned.

endTime

status

The maximum number of payments to return.

limit

A reference internal to the platform. Will not show up on any bank statements.

merchantReference

payerName

Creates a payment request. Use the link to send your payer through our payment flow. You can optionally append one of your redirect URLs to send the user somewhere after completing the payment. <br/>e.g **https://just.wigwag.me/pay/12345?redirect_url=https%3A%2F%2Fexample.com%2Fcallback**

paymentId

Retrieves a payment link's delivery details

Create a refund for a payment. The amount should be in cents. The refund will be processed immediately.

Retrieve an array of Redirect URLs that the client has access to

Creates a new Redirect URL. You can optionally append one of your redirect URLs to send the user somewhere after completing the payment. <br/>e.g **https://just.wigwag.me/pay/12345?redirect_url=https%3A%2F%2Fexample.com%2Fcallback**. You can only have a maximum of 5 Redirect URLs per client

Retrieve an array of subscriptions created by the merchant.

Create a new Subscription Request to save and charge cards at a specified period of time. If your subscription fails to initiate a payment the subscription will go into a "FAILED" state. We will retry the payment once a day for the next three days. After that, a new subscription will need to be created and authorised by the user to start initiating payments again

Once cancelled, a subscription cannot be re-authorised and payments will no longer be executed

subscriptionId

Retrieves a new short-lived (15min) token. Use this token in the Authorization header to access other endpoints. <br/> e.g. **Authorization\: Bearer \<token\>**

Creates a new webhook. The URL will be used to send events to the client.

Withdraw funds from WigWag account into your verified bank account. Amount is in Cents. Test clients will always receive success but no money will be withdrawn.

Withdraw all funds from WigWag account into your verified bank account. Amount is in Cents. Test clients will always receive success but no money will be withdrawn.