Create a PaymentInstrument

Retrieve a PaymentInstrument

Delete a PaymentInstrument

Initiate verification process for a bank account

Initiate deactivation process for a PayID Receivable

Initiate activation process for a PayID Receivable

Payment Instruments

Create a Payin

Retrieve a Payin

Retrieve the Debtor Account for a Payin

Create an action on a Payin

Retrieve an action on a Payin

Payins

Create a refund

Retrieve a refund

Refunds

Create a Payout

Retrieve a Payout

Payouts

Create a report

Get the status of a report

Download the report

Reports

Create a Mandate

Get a Mandate

Create a Mandate Action

Get a Mandate Action

Mandates

Resolve a PayID

PayID

Create a Payin

This endpoint allows you to create a Payin. A Payin is a request to collect funds from a payer.

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.


Idempotency Key

Request signature

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

Signature

A unique identifier for the request.

This identifier is used to identify the request through the Banked system and should be included in support tickets where available.

The `id` received in the response can be used as the `payin_id` parameter in the `createPayinAction` endpoint to take an action on the Payin.

The `id` received in the response can be used as the `payin_id` parameter in the `getPayin` endpoint to retrieve the created Payin.

The request provided by the client is invalid

You are not authorized to access this resource.

Please check your credentials and try again.

Caller does not have permissions to access the resource

Trying to use an HTTP method that does not exist for the given path

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

Please wait a few seconds before trying again.

The server is currently unavailable to handle the request

Connection errors to downstream third party providers

This endpoint allows you to retrieve a Payin. A Payin is a request to collect funds.

payin_id

This endpoint allows you to retrieve the Debtor Account for a sent Payin.

Create an action on a Payin

This endpoint allows you to take an action on a Payin.

Create Action Request Body

The `id` received in the response can be used as the `action_id` and the `payment_id` can be used as the `payin_id` in the `getPayinAction` endpoint to retrieve the created Action.

This endpoint allows you to retrieve an action on a Payin.