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 (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