fundingInstructions

Create funding instruction

Changed on

Use this method to create a funding instruction that tells us how to distribute the funds from your merchants' transactions.

Note: Before you create a funding instruction, you can use our List Funding Balances method to view the amount of available funds that a merchant has.

In your request, include an array of merchantInstruction objects. Each merchantInstruction object contains the following:

  • Merchant ID (MID) of the merchant whose funding balance you want to distribute.
  • Funding account that you want to send funds to.
  • Amount that you want to send to the funding account.

Our gateway returns the instructionId, which you can use to run follow-on actions.

post/funding-instructions

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/funding-instructions
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring uuid required

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Request body

instructionIdinteger

Unique identifier that we assigned to the funding instruction.

createdDatestring datetime

Date that we created the funding instruction. The date format follows the ISO 8601 standard.

lastModifiedDatestring datetime

Date of the most recent change to the funding instruction. The date format follows the ISO 8601 standard.

status'accepted' | 'pending' | 'completed'

Status of the funding instruction. Our gateway returns one of the following values:

  • accepted - We have received the funding instruction but have not yet reviewed it.
  • pending - We have received the funding instruction and we are reviewing it.
  • completed - We have reviewed and processed the funding instruction.
metadataobject

Metadata object you can use to include custom data with your request.

Response

Successful request. We accepted the instructions.

instructionIdinteger

Unique identifier that we assigned to the funding instruction.

createdDatestring datetime

Date that we created the funding instruction. The date format follows the ISO 8601 standard.

lastModifiedDatestring datetime

Date of the most recent change to the funding instruction. The date format follows the ISO 8601 standard.

status'accepted' | 'pending' | 'completed'

Status of the funding instruction. Our gateway returns one of the following values:

  • accepted - We have received the funding instruction but have not yet reviewed it.
  • pending - We have received the funding instruction and we are reviewing it.
  • completed - We have reviewed and processed the funding instruction.
metadataobject

Metadata object you can use to include custom data with your request.

Changes