Search transfers

SecuritybearerToken

Request

path Parameters

AccountIdentifier

required

string

Account identifier

Example: 098B0A25

query Parameters

page	integer <int32>
size	integer <int32>
include	string Comma-separated values from optional response fields

Request Body schema: application/json

transferIdentifier	string
type	string (TransferType) Enum: "BUY" "SELL"
statuses	Array of strings (TransferStatus) Items Enum: "NEW" "INCOMING" "PENDING_APPROVAL" "APPROVED" "REJECTED" "SETTLED" "SETTLEMENT_FAILURE" "CANCELLED" "WITHDRAWN" "SETTLED_AS_FORWARD_TRANSFER" "PENDING_CANCELLATION" "EXPIRED" "PENDING_SETTLEMENT"
registryStatuses	Array of strings (RegistryTransferStatus) Items Enum: "NEW" "PENDING_CONFIRMATION" "CONFIRMED" "REJECTED" "WITHDRAWN" "EXPIRED" "FAILED" "PLACE_READY" "CONFIRM_READY" "REJECT_READY" "WITHDRAW_READY" "PLACE_ERROR" "CONFIRM_ERROR" "REJECT_ERROR" "WITHDRAW_ERROR"
lastUpdatedDateFrom	string <date-time>
lastUpdatedDateTo	string <date-time>
counterpartyName	string
programs	Array of strings (ProgramCode) Items Enum: "NEPOOL" "M_RETS" "NAR" "ERCOT" "PJM" "MIRECS" "NCRETS" "NYGATS" "IREC" "TIGR" "CAR" "VCS" "ACR" "CERCARBONO" "RMS"

Responses

200

List of transfers

400

Bad request

401

Not authorized error

500

Internal server error

post/transfers/account/{AccountIdentifier}/action/search

Request samples

Payload

application/json

{"transferIdentifier": "string",
"type": "BUY",
"statuses": ["NEW"
],
"registryStatuses": ["NEW"
],
"lastUpdatedDateFrom": "2019-08-24T14:15:22Z",
"lastUpdatedDateTo": "2019-08-24T14:15:22Z",
"counterpartyName": "string",
"programs": ["NEPOOL"
]
}

Response samples

application/json

{"page": 0,
"size": 0,
"totalPages": 0,
"totalElements": 0,
"content": [{"identifier": "string",
"counterparty": "string",
"type": "BUY",
"status": "NEW",
"registryStatus": "NEW",
"quantity": 0,
"externalTransferIdentifier": "string",
"createdDate": "2019-08-24T14:15:22Z",
"transferDate": "2019-08-24T14:15:22Z",
"lastUpdatedDate": "2019-08-24T14:15:22Z",
"expectedSettlementDate": "2019-08-24T14:15:22Z",
"actualSettlementDate": "2019-08-24T14:15:22Z",
"registryTransferIdentifier": "string",
"unitPrice": {"currency": "string",
"amount": 0
},
"showPriceInRegistry": true,
"registryTransferPurpose": "SPOT",
"instrument": {"type": "string",
"id": 0,
"ein": "string",
"description": "string",
"program": "NEPOOL",
"vintage": {"year": 0,
"month": 0
},
"markets": [{"market": {"name": "string",
"apiCode": "string",
"applicableExecutionVenues": [null
],
"applicablePrograms": [null
]
},
"marketModelInstrument": {"ein": "string",
"description": "string",
"price": {"amount": null,
"currency": null,
"lastUpdatedDate": null
}
}
}
],
"creditType": "string",
"serialNumber": "string",
"issuanceCertifications": [{"code": "string",
"vintageYears": [0
]
}
],
"projectCertifications": [{"code": "string",
"projectCertificationDateRanges": [{"certificationStart": null,
"certificationEnd": null
}
]
}
],
"reportingPeriodStart": "2019-08-24T14:15:22Z",
"reportingPeriodEnd": "2019-08-24T14:15:22Z",
"project": {"id": 0,
"upn": "string",
"name": "string",
"programs": [{"program": "CAR",
"programName": "string",
"registryAssignedId": "string",
"registryAccountHolderName": "string",
"status": "string",
"creditType": "string",
"projectType": "string",
"baselineMethodology": "string",
"creditingPeriodBegin": "2019-08-24T14:15:22Z",
"creditingPeriodEnd": "2019-08-24T14:15:22Z"
}
],
"description": "string",
"status": "IMPORTED",
"country": "string",
"stateProvince": "string",
"city": "string",
"location": {"latitude": 0.1,
"longitude": 0.1
},
"annualAverageOffsetQty": 0,
"projectCertifications": [{"code": "string",
"projectCertificationDateRanges": [{ }
]
}
],
"issuanceCertifications": [{"code": "string",
"vintageYears": [null
]
}
]
}
}
}
]
}