Sign in
fundingInstructions

Retrieve funding instruction

Use this method to retrieve information about a funding instruction.

To retrieve a funding instruction, you need its instructionId. Our gateway returned the instructionId in the response of the Create Funding Instruction method.

Note: If you don't have the instructionId, use our List Funding Instructions method to search for the funding instruction.

Our gateway returns the following information about the funding instruction:

  • Status of the funding instruction.
  • Funding information, including which merchant's funding balance we distribute and the funding account that we send the balance to.
get/funding-instructions/{instructionId}

Path parameters

instructionIdinteger required

Unique identifier that we assigned to the funding instruction.

Headers

Authorizationstring required

Bearer authentication

Response

Successful request. Returns the funding instruction.

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

No recorded changes to this endpoint across all 1 revision of this API.