/api/v1/omnipay/paymentInstructions/{mid}

get https://uat-merchant-services.fiservapp.com/boarding-ui/external-api/maintenance/api/v1/omnipay/paymentInstructions/{mid}

Retrieves a paginated list of payment instructions for a merchant. By default only active and future effective dated payment instructions are returned, the results can be fitered by account type, account currency code, instruction type and payment instruction status.

Responses

Response body

array of objects

object

sourceAccount

object

Indicates the source account details for which the reserve, rolling reserve and/or factoring set up applies

destinationAccount

object

Indicates the destination account details for which the reserve, rolling reserve and/or factoring set up applies

instructionType

object

Indicates the type of payment instruction to be set for the selected source account type and source account

status

string

StatusDTO of the payment instruction assigned to the merchant. If status field not provided as query parameter in the payload, then assigned ACTIVE and FUTURE status payment instructions will be extracted for a merchant and any EXPIRED status payment instructions will be excluded.

ACTIVE FUTURE EXPIRED ALL

instructionIdNumber

string

length between 0 and 10

Internal unique Instruction ID number per merchant per instruction type generated by OmniPay. To get list of valid instructionIdNumber for a merchant, use Retrieve Payment Instructions endpoint in merchant maintenance API.

deductionStartDate

string

length between 8 and 8

Date when the payment instruction starts. The date must be greater than or equal to the current posting date. Format YYYYMMDD.

deductionEndDate

string

length between 8 and 8

Date when the payment instruction ends. The date must be greater than or equal to the current posting date. Format YYYYMMDD.

deductionPercentage

string

length between 0 and 11

The percentage of the payment that should be deducted from the merchant source account. This cannot be used in conjunction with Payment Base. Either Payment Base or Payment Percent to be setup. Maximum 4 decimal digits allowed...

deductionMinAmount

string

length between 0 and 11

The minimum value to be deducted from the payment. Maximum 4 decimal digits allowed.

deductionMaxAmount

string

length between 0 and 11

The maximum value to be deducted from the payment. Maximum 4 decimal digits allowed.

deductionBaseAmount

string

length between 0 and 11

The amount to be deducted from the calculated total amount, to be paid from the source account type selected. This cannot be used in conjunction with Payment Percent. Either Payment Base or Payment Percent to be setup. Maximum 4 decimal digits allowed.

deductionTotalCnt

string

length between 0 and 11

Indicates how many times this instruction should be executed.

deductionTotalAmount

string

length between 0 and 18

A limit to indicate the maximum amount to be collected during the instruction life cycle. Maximum 4 decimal digits allowed.

factorAgent

string

length between 0 and 24

Name of the factor agent.

note

string

length between 0 and 674

Free Text for extra note.

deductionFrequency

string

length between 0 and 16

Indicates the frequency at which payment instruction get triggered.

lastExecutionDate

string

length between 8 and 8

Indicates the date the last payment instruction is executed. Format YYYYMMDD.

executionCount

string

length between 0 and 11

Indicates the number of times the payment instruction has been executed.

amountPaid

string

length between 0 and 18

Total amount being collected under this payment instruction as of last execution date from start date. Maximum 4 decimal digits allowed.

lastUpdatedBy

string

length between 0 and 60

User Name by which the last update was made.

lastUpdatedDate

string

length between 8 and 8

Date the last update made to the payment instruction. Format YYYYMMDD.

204

No register was found

401

Unauthorized request

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://uat-merchant-services.fiservapp.com/boarding-ui/external-api/maintenance/api/v1/omnipay/paymentInstructions/mid \
3
     --header 'accept: */*'

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

*/*

application/json

200Successful operation

400Bad request

403Forbidden request

404Record does not exist

500Internal Error

502API Error