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": "string", 5 "document": {}, 6 "transfer_information": {}, 7 "transfer_origin": { 8 "tax_id_code": "string", 9 "tax_id_type": "string", 10 "country_id": "string", 11 "authorized_agent": {} 12 }, 13 "transfer_destination": { 14 "tax_id_code": "string", 15 "tax_id_type": "string", 16 "country_id": "string" 17 } 18 }'

1 { 2 "schema": { 3 "document_transfer_id": "string", 4 "account_id": "string", 5 "document": { 6 "document_id": "string", 7 "document_information": { 8 "xml": "string", 9 "pdf": "string", 10 "document_type_id": 1, 11 "document_number": "string", 12 "issuer_tax_id_code": "string", 13 "issuer_tax_id_type": "string", 14 "receiver_tax_id_code": "string", 15 "receiver_tax_id_type": "string", 16 "issue_date": "2023-01-15", 17 "due_date": "2023-01-15", 18 "total_amount": 1.1, 19 "currency_id": "string" 20 } 21 }, 22 "transfer_information": { 23 "datetime": "2024-01-15T09:30:00Z", 24 "transferred_amount": 1.1, 25 "additional_conditions": "string" 26 }, 27 "transfer_origin": { 28 "tax_id_code": "string", 29 "tax_id_type": "string", 30 "country_id": "string", 31 "authorized_agent": { 32 "first_name": "string", 33 "last_name": "string", 34 "person_tax_id_code": "string", 35 "person_tax_id_type": "string" 36 }, 37 "company_name": "string", 38 "contact_first_name": "string", 39 "contact_last_name": "string", 40 "contact_phone": "string", 41 "contact_email": "string", 42 "address": "string", 43 "city": "string", 44 "district": "string", 45 "county_id": "string", 46 "state_id": "string" 47 }, 48 "transfer_destination": { 49 "tax_id_code": "string", 50 "tax_id_type": "string", 51 "country_id": "string", 52 "company_name": "string", 53 "contact_first_name": "string", 54 "contact_last_name": "string", 55 "contact_phone": "string", 56 "contact_email": "string", 57 "address": "string", 58 "city": "string", 59 "district": "string", 60 "county_id": "string", 61 "state_id": "string" 62 }, 63 "transfer_registry": [ 64 { 65 "registry_entity": "string", 66 "sending_status": "string", 67 "sending_datetime": "2024-01-15T09:30:00Z", 68 "sending_number": "string", 69 "validation_status": "string", 70 "validation_datetime": "2024-01-15T09:30:00Z", 71 "validation_details": "string" 72 } 73 ], 74 "fulfillment_proof": [ 75 { 76 "type": 1, 77 "description": "string", 78 "content_data": "string", 79 "content_type": "string", 80 "datetime": "2024-01-15T09:30:00Z", 81 "status": "string", 82 "fulfillment_type": "string", 83 "validation_entity": "string", 84 "validation_code": "string" 85 } 86 ], 87 "notifications": [ 88 { 89 "role_id": 1, 90 "message_type": 1, 91 "message_destination": "string", 92 "language_id": "string", 93 "additional_information": "string", 94 "notification_types": [ 95 { 96 "transfer_status": true, 97 "payment_update": true 98 } 99 ] 100 } 101 ], 102 "payment_information": [ 103 { 104 "payment_method_id": 1, 105 "other_method_name": "string", 106 "bank_id": 1, 107 "country_id": "string", 108 "account_holder": { 109 "name": "string", 110 "type": "string" 111 }, 112 "account_number": "string", 113 "routing_number": "string", 114 "routing_type": "string", 115 "url": "string", 116 "currency_id": "string", 117 "expiration_date": "2023-01-15", 118 "additional_info_1": "string", 119 "additional_info_2": "string", 120 "additional_info_3": "string" 121 } 122 ] 123 } 124 }

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

schemaobject or null