Registry API
Create Transfer
Transfer credits from specific batches, in whole or with splits. All credit batches must originate from the same supplier and be owned by the current organisation.
POST
/
transfers
Authorizations
Authorization
string
headerrequiredAn JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>
Headers
x-client-secret
string
requiredA secret token identifying the client connecting to the API
Body
application/json
credit_batch_quantities
object[]
requiredA list of credit batch IDs and kilogram amounts of each to transfer.
from_organisation_id
string
requiredThe ID of the organisation that is sending the credits. Typically this would be your own organisation ID.
notes
string | null
requiredA publicly visible note stored with the credit transfer.
supplier_id
string
requiredAll credits in a transfer must originate from the same supplier.
to_organisation_id
string
requiredThe ID of the organisation that will receive the credits.
Response
200 - application/json
credit_batch_size_total
object
requiredfrom_organisation
object
requiredid
string
requirednotes
string | null
requiredto_organisation
object
requiredtransferred_at
string
requiredWas this page helpful?