SchemaFundingFunding Instructions

Create funding instruction

Create funding instructions to tell us how to divide funds between your funding recipients.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Idempotency-KeystringRequired

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

This endpoint expects an object.
instructionIdintegerOptional

Unique identifier of the funding instruction.

createdDatestringOptionalformat: "datetime"

Date that we created the funding instruction.

lastModifiedDatestringOptionalformat: "datetime"

Date of the most recent change to the funding instruction.

statusenumOptional

Status of the funding instruction.

Allowed values:
merchantslist of objectsOptional

Array of merchantInstruction objects.

metadatamap from strings to stringsOptional

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

Response

Successful request. We accepted the instructions.

instructionIdintegerOptional

Unique identifier of the funding instruction.

createdDatestringOptionalformat: "datetime"

Date that we created the funding instruction.

lastModifiedDatestringOptionalformat: "datetime"

Date of the most recent change to the funding instruction.

statusenumOptional

Status of the funding instruction.

Allowed values:
merchantslist of objectsOptional

Array of merchantInstruction objects.

metadatamap from strings to stringsOptional

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