Sign in

v1

latestOpenAPI 3.0.02026-07-26166415635.8 KB
Instant Funding

Get Instant Funding List

Returns a list of instant funding records based on the query parameters. The results are paginated, sorted, and filtered based on the parameters provided.

get/v1/instant_funding

Query parameters

sort_by'created_at' | 'amount' | 'deadline'

sort results based on created_at, amount, and deadline

sort_order'ASC' | 'DESC'

Defines the ordering of sort_by query. Defaults to ASC when not specified.

limitinteger

defines the number of results that will be returned from the request

offsetinteger

defines the number of results that will be skipped before picking the results that will be returned

system_datestring date

filter transfers based on system date

deadlinestring date

filter transfers based on settlement deadline

status'PENDING' | 'CANCELED' | 'EXECUTED' | 'FAILED' | 'COMPLETED'

Status:

  • PENDING: Created and waiting to be processed
  • CANCELED: Canceled
  • EXECUTED: All fees (including Partner fee) are transacted
  • FAILED: Failed mostly due to technical reasons
  • COMPLETED: All transactions are settled

filter transfers based on status

beforestring date-time

filter transfers based on the date of creation

Response

list of transfers

account_nostring required
amountstring decimal required
created_atstring date-time required
deadlinestring date required
idstring uuid required
remaining_payablestring decimal required
source_account_nostring required
status'PENDING' | 'CANCELED' | 'EXECUTED' | 'FAILED' | 'COMPLETED' required

Status:

  • PENDING: Created and waiting to be processed
  • CANCELED: Canceled
  • EXECUTED: All fees (including Partner fee) are transacted
  • FAILED: Failed mostly due to technical reasons
  • COMPLETED: All transactions are settled
system_datestring date required
total_intereststring decimal required