ES | EN

📄 MIPYME Documents

Initiate a document transfer process

POST
Endpoint URL https://api-billing.koywe.com/V1/document_transfers
Allows you to initiate a document transfer request

Parameters

No parameters.

Request body — fields

FieldTypeRequiredDescription
account_idstringAlways required—
documentobjectAlways required—
document.document_idstringOptional—
document.document_informationobjectOptional—
document.document_information.xmlstringOptional—
document.document_information.pdfstringOptional—
document.document_information.document_type_idintegerOptional—
document.document_information.document_numberstringOptional—
document.document_information.issuer_tax_id_codestringOptional—
document.document_information.issuer_tax_id_typestringOptional—
document.document_information.receiver_tax_id_codestringOptional—
document.document_information.receiver_tax_id_typestringOptional—
document.document_information.issue_datestring (date)Optional—
document.document_information.due_datestring (date)Optional—
document.document_information.total_amountnumber (float)Optional—
document.document_information.currency_idstringOptional—
transfer_informationobjectAlways required—
transfer_information.datetimestring (date-time)Optional—
transfer_information.transferred_amountnumber (float)Optional—
transfer_information.additional_conditionsstringOptional—
transfer_information.digital_certificate_idstringOptional—
fulfillment_proofarray<object>OptionalNOT ACTIVE YET
fulfillment_proof[].typeintegerOptional—
fulfillment_proof[].descriptionstringOptional—
fulfillment_proof[].content_datastringOptional—
fulfillment_proof[].content_typestringOptional—
fulfillment_proof[].datetimestring (date-time)Optional—
fulfillment_proof[].statusstringOptional—
fulfillment_proof[].fulfillment_typestringOptional—
fulfillment_proof[].validation_entitystringOptional—
fulfillment_proof[].validation_codestringOptional—
transfer_originobjectAlways required—
transfer_origin.company_namestringOptional—
transfer_origin.contact_first_namestringOptional—
transfer_origin.contact_last_namestringOptional—
transfer_origin.contact_phonestringOptional—
transfer_origin.contact_emailstringOptional—
transfer_origin.tax_id_codestringAlways required—
transfer_origin.tax_id_typestringAlways required—
transfer_origin.addressstringOptional—
transfer_origin.citystringOptional—
transfer_origin.districtstringOptional—
transfer_origin.county_idstringOptional—
transfer_origin.state_idstringOptional—
transfer_origin.country_idstringAlways required—
transfer_origin.authorized_agentobjectAlways required—
transfer_origin.authorized_agent.first_namestringOptional—
transfer_origin.authorized_agent.last_namestringOptional—
transfer_origin.authorized_agent.person_tax_id_codestringOptional—
transfer_origin.authorized_agent.person_tax_id_typestringOptional—
transfer_destinationobjectAlways required—
transfer_destination.company_namestringOptional—
transfer_destination.contact_first_namestringOptional—
transfer_destination.contact_last_namestringOptional—
transfer_destination.contact_phonestringOptional—
transfer_destination.contact_emailstringOptional—
transfer_destination.tax_id_codestringAlways required—
transfer_destination.tax_id_typestringAlways required—
transfer_destination.addressstringOptional—
transfer_destination.citystringOptional—
transfer_destination.districtstringOptional—
transfer_destination.county_idstringOptional—
transfer_destination.state_idstringOptional—
transfer_destination.country_idstringAlways required—
notificationsarray<object>OptionalNOT ACTIVE YET
notifications[].role_idintegerOptional—
notifications[].message_typeintegerOptional—
notifications[].message_destinationstringOptional—
notifications[].language_idstringOptional—
notifications[].additional_informationstringOptional—
notifications[].notification_typesarray<object>Optional—
notifications[].notification_types[].transfer_statusbooleanOptional—
notifications[].notification_types[].payment_updatebooleanOptional—
payment_informationarray<object>OptionalNOT ACTIVE YET
payment_information[].payment_method_idintegerOptional—
payment_information[].other_method_namestringOptional—
payment_information[].bank_idintegerOptional—
payment_information[].country_idstringOptional—
payment_information[].account_holderobjectOptional—
payment_information[].account_holder.namestringOptional—
payment_information[].account_holder.typestringOptional—
payment_information[].account_numberstringOptional—
payment_information[].routing_numberstringOptional—
payment_information[].routing_typestringOptional—
payment_information[].urlstringOptional—
payment_information[].currency_idstringOptional—
payment_information[].expiration_datestring (date)Optional—
payment_information[].additional_info_1stringOptional—
payment_information[].additional_info_2stringOptional—
payment_information[].additional_info_3stringOptional—

Request body — JSON example

{
    "account_id": "string",
    "document": {
        "document_id": "string",
        "document_information": {
            "xml": "string",
            "pdf": "string",
            "document_type_id": 0,
            "document_number": "string",
            "issuer_tax_id_code": "string",
            "issuer_tax_id_type": "string",
            "receiver_tax_id_code": "string",
            "receiver_tax_id_type": "string",
            "issue_date": "string",
            "due_date": "string",
            "total_amount": 0,
            "currency_id": "string"
        }
    },
    "transfer_information": {
        "datetime": "string",
        "transferred_amount": 0,
        "additional_conditions": "string",
        "digital_certificate_id": "string"
    },
    "fulfillment_proof": [
        {
            "type": 0,
            "description": "string",
            "content_data": "string",
            "content_type": "string",
            "datetime": "string",
            "status": "string",
            "fulfillment_type": "string",
            "validation_entity": "string",
            "validation_code": "string"
        }
    ],
    "transfer_origin": {
        "company_name": "string",
        "contact_first_name": "string",
        "contact_last_name": "string",
        "contact_phone": "string",
        "contact_email": "string",
        "tax_id_code": "string",
        "tax_id_type": "string",
        "address": "string",
        "city": "string",
        "district": "string",
        "county_id": "string",
        "state_id": "string",
        "country_id": "string",
        "authorized_agent": {
            "first_name": "string",
            "last_name": "string",
            "person_tax_id_code": "string",
            "person_tax_id_type": "string"
        }
    },
    "transfer_destination": {
        "company_name": "string",
        "contact_first_name": "string",
        "contact_last_name": "string",
        "contact_phone": "string",
        "contact_email": "string",
        "tax_id_code": "string",
        "tax_id_type": "string",
        "address": "string",
        "city": "string",
        "district": "string",
        "county_id": "string",
        "state_id": "string",
        "country_id": "string"
    },
    "notifications": [
        {
            "role_id": 0,
            "message_type": 0,
            "message_destination": "string",
            "language_id": "string",
            "additional_information": "string",
            "notification_types": [
                {
                    "transfer_status": "...",
                    "payment_update": "..."
                }
            ]
        }
    ],
    "payment_information": [
        {
            "payment_method_id": 0,
            "other_method_name": "string",
            "bank_id": 0,
            "country_id": "string",
            "account_holder": {
                "name": "string",
                "type": "string"
            },
            "account_number": "string",
            "routing_number": "string",
            "routing_type": "string",
            "url": "string",
            "currency_id": "string",
            "expiration_date": "string",
            "additional_info_1": "string",
            "additional_info_2": "string",
            "additional_info_3": "string"
        }
    ]
}

Responses

200 Transfer process initiated succesfully