ES | EN

📄 MIPYME Documents

Initiate a document transfer process

POST
URL del endpoint https://apifacto.com/v1/document_transfers
Allows you to initiate a document transfer request

Parámetros

Sin parámetros.

Cuerpo de la solicitud — campos

CampoTipoObligatoriedadDescripción
account_idstringSiempre obligatorio—
documentobjectSiempre obligatorio—
document.document_idstringOpcional—
document.document_informationobjectOpcional—
document.document_information.xmlstringOpcional—
document.document_information.pdfstringOpcional—
document.document_information.document_type_idintegerOpcional—
document.document_information.document_numberstringOpcional—
document.document_information.issuer_tax_id_codestringOpcional—
document.document_information.issuer_tax_id_typestringOpcional—
document.document_information.receiver_tax_id_codestringOpcional—
document.document_information.receiver_tax_id_typestringOpcional—
document.document_information.issue_datestring (date)Opcional—
document.document_information.due_datestring (date)Opcional—
document.document_information.total_amountnumber (float)Opcional—
document.document_information.currency_idstringOpcional—
transfer_informationobjectSiempre obligatorio—
transfer_information.datetimestring (date-time)Opcional—
transfer_information.transferred_amountnumber (float)Opcional—
transfer_information.additional_conditionsstringOpcional—
transfer_information.digital_certificate_idstringOpcional—
fulfillment_proofarray<object>OpcionalNOT ACTIVE YET
fulfillment_proof[].typeintegerOpcional—
fulfillment_proof[].descriptionstringOpcional—
fulfillment_proof[].content_datastringOpcional—
fulfillment_proof[].content_typestringOpcional—
fulfillment_proof[].datetimestring (date-time)Opcional—
fulfillment_proof[].statusstringOpcional—
fulfillment_proof[].fulfillment_typestringOpcional—
fulfillment_proof[].validation_entitystringOpcional—
fulfillment_proof[].validation_codestringOpcional—
transfer_originobjectSiempre obligatorio—
transfer_origin.company_namestringOpcional—
transfer_origin.contact_first_namestringOpcional—
transfer_origin.contact_last_namestringOpcional—
transfer_origin.contact_phonestringOpcional—
transfer_origin.contact_emailstringOpcional—
transfer_origin.tax_id_codestringSiempre obligatorio—
transfer_origin.tax_id_typestringSiempre obligatorio—
transfer_origin.addressstringOpcional—
transfer_origin.citystringOpcional—
transfer_origin.districtstringOpcional—
transfer_origin.county_idstringOpcional—
transfer_origin.state_idstringOpcional—
transfer_origin.country_idstringSiempre obligatorio—
transfer_origin.authorized_agentobjectSiempre obligatorio—
transfer_origin.authorized_agent.first_namestringOpcional—
transfer_origin.authorized_agent.last_namestringOpcional—
transfer_origin.authorized_agent.person_tax_id_codestringOpcional—
transfer_origin.authorized_agent.person_tax_id_typestringOpcional—
transfer_destinationobjectSiempre obligatorio—
transfer_destination.company_namestringOpcional—
transfer_destination.contact_first_namestringOpcional—
transfer_destination.contact_last_namestringOpcional—
transfer_destination.contact_phonestringOpcional—
transfer_destination.contact_emailstringOpcional—
transfer_destination.tax_id_codestringSiempre obligatorio—
transfer_destination.tax_id_typestringSiempre obligatorio—
transfer_destination.addressstringOpcional—
transfer_destination.citystringOpcional—
transfer_destination.districtstringOpcional—
transfer_destination.county_idstringOpcional—
transfer_destination.state_idstringOpcional—
transfer_destination.country_idstringSiempre obligatorio—
notificationsarray<object>OpcionalNOT ACTIVE YET
notifications[].role_idintegerOpcional—
notifications[].message_typeintegerOpcional—
notifications[].message_destinationstringOpcional—
notifications[].language_idstringOpcional—
notifications[].additional_informationstringOpcional—
notifications[].notification_typesarray<object>Opcional—
notifications[].notification_types[].transfer_statusbooleanOpcional—
notifications[].notification_types[].payment_updatebooleanOpcional—
payment_informationarray<object>OpcionalNOT ACTIVE YET
payment_information[].payment_method_idintegerOpcional—
payment_information[].other_method_namestringOpcional—
payment_information[].bank_idintegerOpcional—
payment_information[].country_idstringOpcional—
payment_information[].account_holderobjectOpcional—
payment_information[].account_holder.namestringOpcional—
payment_information[].account_holder.typestringOpcional—
payment_information[].account_numberstringOpcional—
payment_information[].routing_numberstringOpcional—
payment_information[].routing_typestringOpcional—
payment_information[].urlstringOpcional—
payment_information[].currency_idstringOpcional—
payment_information[].expiration_datestring (date)Opcional—
payment_information[].additional_info_1stringOpcional—
payment_information[].additional_info_2stringOpcional—
payment_information[].additional_info_3stringOpcional—

Ejemplo JSON del cuerpo

{
    "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"
        }
    ]
}

Respuestas

200 Transfer process initiated succesfully