Retrieve bank account balances

Retrieve bank account transactions

Create bank account

List bank accounts

Delete bank account

Bank accounts

Create a new mandate

Get mandates

Get mandate by id

Create action on mandate

Get action details

Mandates

Create client key

List client keys

Delete client key

Client Keys

Fetch payment sessions

Create a payment session

Retrieve a payment session

Delete a payment session

Retrieve consumer account details

Execute an action against a payment session

Retrieve a payment action

Payments

List providers

Providers

Create webhook

List webhooks

Update webhook

Delete webhook

Webhooks

Fetch payouts

Create a payout

Retrieve a payout

Expire a payout

Payouts

Create PayLink

Search for PayLinks

Fetch a single PayLink

PayLinks

Create a report

Retrieve a report

Download the report file

Reports

A PayLink is a special resource that wraps other Banked resources.

> Please speak to Banked Support about using this product.

PayLinks are used to send notifications to customers about other Banked resources.
We support Email or SMS notifications.

## PayLinks wrap other API resources

The PayLink endpoint provides convenience methods for creating other Banked resources,
but it simply wraps the existing APIs and extends them with the notification functionality.

For example, if you want to create a Payout, you may either create a Payout directly
using the payout endpoints and then send a notification to the customer using this
PayLink endpoint, or you may create a PayLink and a payout together in one request.

In either case, when the customer clicks on the PayLink, they will be taken to a Banked-hosted
page where they can receive the payout.

Whether the user is directed to the payout through a PayLink or from a merchant giving
them the payout link, the payout experience will be the same.
PayLinks do not modify the payout experience in any way.

## PayLink resource differences

Because PayLinks wrap other resources, the request body requires either IDs (references)
or complete objects for the resources you wish to create, as well as requiring PayLink specific
information such as the delivery methods and supplemental information.

Because of this, the webhooks associated with PayLinks only provide information about the PayLink itself, not the underlying resources.

For example, if you created a payout through the PayLink endpoint,
the "Payout Pending" webhook would not be associated with the PayLink, but the underlying payout.

The Idempotency Key of the Request.

The Idempotency Key Parameter will allow you to safely retry a request
without accidentally performing the same operation twice.

Idempotency-Key

A unique identifier for a request.

This should be randomly generated by the client. And each request made to the API should have a unique idempotency key.


Request signature

Reach out to Banked to set up a signature key for your account.

Signature

PayLink creation request.
In order to create a payLink, you must provide either an existing payout_id or a full payout creation request object.

You are not authorized to access this resource.

Please check your credentials and try again.

Same Idempotency Key used with different body.

Idempotency may be used to prevent multiple requests being
counted as separate requests.

However, if you use the same Idempotency Key with a different
request body, this error will be returned.

You have made too many requests in a short period of time.

Please wait a few seconds before trying again.

Use this endpoint to search for PayLinks by a linked resource's ID.

> Please speak to Banked Support about using this product.

You must send one of the following parameters:
  - payout_id

This endpoint will only return the PayLink object, not the linked resource.

payout_id

Bad Request. At least one "filterable" parameter must be provided.

You must send one of the following:
  - payout_id

Use this endpoint to fetch a single PayLink.

> Please speak to Banked Support about using this product.

This endpoint will only return the PayLink object, not the linked resource.

For example, if you would like to fetch the payout associated with this PayLink,
you must use the payout endpoints.

This endpoint may be used as a substitute to the webhooks that will be sent
when a payLink changes state.