Initiate a document transfer process

1 curl -X POST https://api-billing.koywe.com/V1/document_transfers \ 2 -H "Content-Type: application/json" \ 3 -d '{ 4 "account_id": "account_id", 5 "document": {}, 6 "transfer_information": {}, 7 "transfer_origin": { 8 "tax_id_code": "tax_id_code", 9 "tax_id_type": "tax_id_type", 10 "country_id": "country_id", 11 "authorized_agent": {} 12 }, 13 "transfer_destination": { 14 "tax_id_code": "tax_id_code", 15 "tax_id_type": "tax_id_type", 16 "country_id": "country_id" 17 } 18 }'

1 { 2 "schema": { 3 "document_transfer_id": "document_transfer_id", 4 "account_id": "account_id", 5 "document": { 6 "document_id": "document_id" 7 }, 8 "transfer_information": { 9 "datetime": "2024-01-15T09:30:00Z", 10 "transferred_amount": 1.1, 11 "additional_conditions": "additional_conditions" 12 }, 13 "transfer_origin": { 14 "tax_id_code": "tax_id_code", 15 "tax_id_type": "tax_id_type", 16 "country_id": "country_id", 17 "authorized_agent": {}, 18 "company_name": "company_name", 19 "contact_first_name": "contact_first_name", 20 "contact_last_name": "contact_last_name", 21 "contact_phone": "contact_phone", 22 "contact_email": "contact_email", 23 "address": "address", 24 "city": "city", 25 "district": "district", 26 "county_id": "county_id", 27 "state_id": "state_id" 28 }, 29 "transfer_destination": { 30 "tax_id_code": "tax_id_code", 31 "tax_id_type": "tax_id_type", 32 "country_id": "country_id", 33 "company_name": "company_name", 34 "contact_first_name": "contact_first_name", 35 "contact_last_name": "contact_last_name", 36 "contact_phone": "contact_phone", 37 "contact_email": "contact_email", 38 "address": "address", 39 "city": "city", 40 "district": "district", 41 "county_id": "county_id", 42 "state_id": "state_id" 43 }, 44 "transfer_registry": [ 45 {} 46 ], 47 "fulfillment_proof": [ 48 {} 49 ], 50 "notifications": [ 51 {} 52 ], 53 "payment_information": [ 54 {} 55 ] 56 } 57 }

Allows you to initiate a document transfer request

Request

This endpoint expects an object.

account_idstringRequired

documentobjectRequired

transfer_informationobjectRequired

transfer_originobjectRequired

transfer_destinationobjectRequired

fulfillment_prooflist of objectsOptional

NOT ACTIVE YET

notificationslist of objectsOptional

NOT ACTIVE YET

payment_informationlist of objectsOptional

NOT ACTIVE YET

Response

Transfer process initiated succesfully

schemaobjectOptional