Get Transfers

get

https://v1/v1/payments

This API retrieves a list of payments for different payment types such as ACH, WIRE, SWIFT, INTERNAL, FXPAY, and CARD.

The status of the payments can be filtered by specifying one of the allowed status values.

Status	Description	Applicable to Transfer Type
DRAFT	Transfer submitted, awaiting execution.	ALL
AML_SCREENING	The transfer is being manually reviewed by compliance due to a potential violation of limit thresholds, a mismatch in beneficiary name information, or a potential OFAC sanctions match.	ALL
AML_REJECTED	The transfer has been rejected during AML screening.	ALL
EXECUTION_SCHEDULED	The transfer is scheduled for bank processing and clearing house submission.	ACH
EXECUTION_PROCESSING	Outgoing transfer sent to the bank. Awaiting ACH processing, estimated to take 3 business days for ACH.	ALL
EXECUTION_SUCCESS	The transfer has been finalized. The incoming funds have been posted to the client's account, and the outgoing funds have been disbursed to the recipient's account.	ALL
EXECUTION_FAILURE	The transfer could not be completed due to an error in execution.	ALL
RETURNED	The transfer has been returned.	ALL
CANCELLED	Outgoing transfer canceled prior to bank submission.	ACH
COMPLIANCE_FAILURE	The wire transfer has been rejected by the bank due to a compliance issue.	ALL
DELETED	Transfer marked for deletion due to error.	ALL
UNKNOWN	If the transfer doesn't have any of the above statuses	ALL

Example Requests

GET /payments/{paymentId}

Query Params

paymentId

integer

Filter by specific payment ID.

originatorName

string

This is Originator's Name.

originatorAccount

string

Originator's account number.

originatorBankRoutingCode

string

Originator's bank routing code.

recipientName

string

This is Recipient's Name.

recipientAccount

string

Recipient's account number.

recipientBankRoutingCode

string

Recipient's bank routing code.

reference

string

If you want to provide anything for reference.

traceNumber

string

Unique trace number for the payment.

externalId

string

This is External Id (unique).

clientId

integer

This is Client Id.

dateFormat

string

The date format.

locale

string

Defaults to en

This is used for Locale language.

originatedBy

string

Defaults to us

Need to pass one of from - 'us' for OUTGOING, 'external party' for INCOMING.

paymentRail

string

The different payment types we have - ACH, WIRE, SWIFT, CARD, FXPAY, INTERNAL.

paymentType

string

Defaults to null

Need to pass one of from - CREDIT, DEBIT.

fromValueDate

date

Starting value date for the payment filter.

toValueDate

date

Ending value date for the payment filter.

fromExecuteDate

date

Starting execution date for the payment filter.

toExecuteDate

date

Ending execution date for the payment filter.

status

string

Defaults to null

Need to pass any one of the Status above listed for status but it's optional.

fromReturnDate

date

This is From Return Date.

toReturnDate

date

This is To Return Date.

offset

integer

The offset for pagination.

limit

integer

Fetch record limit. Default is 200.

isSettlement

boolean

Is it settlement. (true/false).

orderBy

string

Defaults to id

By which property you want to order.

sortOrder

string

Defaults to DESC

Which order you want to sort. (ASC/DESC).

Headers

tenantId

string

required

The ID of your banking instance visible in the MBANQ Console.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The list of payments retrieved successfully.

400The request fails if the tenant Id is missing or incorrect.

401Authentication credentials were missing or incorrect.

403The authenticated user does not have permission to view payments.

404The requested payment resource was not found.