Guatemala

Example PayOut Request and Response

Create payout Guatemala

POST https://api.stage.localpayment.com /api/payout

Create a payout order

Headers

Name	Type	Description
Authorization *	String	JWT token in format Bearer eyJ0... For more information about authentication, please refer to Authentication

Request Body

201: Created A Bank transfer payment order has been successfully created and the payment is pending

{
        "externalId": "1690211466",
        "internalId": "771f0287-f3eb-4605-9582-f900f045302d",
        "paymentMethod": {
            "code": "0110",
            "name": "ACH",
            "description": "ACH",
            "paymentMethodType": "BankTransfer"
        },
        "country": "GTM",
        "currency": "GTQ",
        "amount": 50.0,
        "accountNumber": "320.320.00000002",
        "clientCode": "0001",
        "clientName": "Acme",
        "status": {
            "code": "100",
            "description": "Received",
            "detail": "The payout was received"
        },
        "beneficiary": {
            "bank": {
                "name": "Banco",
                "code": "013",
                "branch": null,
                "account": {
                    "number": "18012003456",
                    "type": "S",
                    "alias": null,
                    "pixKey": null,
                    "phone": null
                }
            },
            "type": "INDIVIDUAL",
            "name": "Beneficiary Name",
            "lastname": "Beneficiary LastName ",
            "document": {
                "type": "NIT",
                "id": "36029785"
            },
            "userReference": null,
            "email": null,
            "phone": null,
            "birthdate": "0001-01-01T00:00:00",
            "nationality": null,
            "address": null
        },
        "merchant": {
            "type": "COMPANY",
            "name": "Merchant Name",
            "lastname": null,
            "document": null,
            "userReference": null,
            "email": null,
            "phone": null,
            "birthdate": "0001-01-01T00:00:00",
            "nationality": null,
            "address": null
        },
        "sender": {
            "type": "INDIVIDUAL",
            "name": "Sender INPAY COL",
            "lastname": "Sender LastName",
            "document": {
                "type": "DNI",
                "id": "40754127"
            },
            "userReference": null,
            "email": null,
            "phone": null,
            "birthdate": "0001-01-01T00:00:00",
            "nationality": null,
            "address": null
        },
        "comment": null,
        "exchangeRateToken": null,
        "date": {
            "creationDate": "2023-07-24T15:11:05.3593261+00:00",
            "processedDate": "2023-07-24T15:11:05.4582163+00:00"
        },
        "errors": null
    }
]

400: Bad Request Wrong parameters (syntactic or semantic errors). The status.code might give more information about the error (see Payin status code table)

{
    "externalId": "1669663393",
    "internalId": "00000000-0000-0000-0000-000000000000",
    "status": null,
    "errors": [
        {
            "code": "719",
            "description": "Amount must not be empty and more tan 0"
        }
    ]
}

Request

{
        "externalId": "{{$timestamp}}",
        "country": "GTM",
        "currency": "GTQ",
        "amount": 50.0,
        "paymentMethod": {
            "type": "BankTransfer",
            "code": "0110",
            "flow": "direct"
        },
        "beneficiary": {
            "name": "Beneficiary Name",
            "lastName": "Beneficiary LastName ",
            "type": "INDIVIDUAL",
            "document": {
                "type": "NIT",
                "id": "36029785"
            },
            "bank": {
                "name": "Banco",
                "code": "013",
                "account": {
                    "number": "18012003456",
                    "type": "S"
                }
            }
        },
        "sender": {
            "type": "INDIVIDUAL",
            "name": "Sender INPAY COL",
            "lastName": "Sender LastName",
            "document": {
                "type": "DNI",
                "id": "40754127"
            }
        },
        "merchant": {
            "type": "COMPANY",
            "name": "Merchant Name"
        },
        "accountNumber": "320.320.00000002",
        "conceptCode": "0001"

    }
]

Status OK

  [  {
        "externalId": "1690211466",
        "internalId": "771f0287-f3eb-4605-9582-f900f045302d",
        "paymentMethod": {
            "code": "0110",
            "name": "ACH",
            "description": "ACH",
            "paymentMethodType": "BankTransfer"
        },
        "country": "GTM",
        "currency": "GTQ",
        "amount": 50.0,
        "accountNumber": "320.320.00000002",
        "clientCode": "0001",
        "clientName": "Acme",
        "status": {
            "code": "100",
            "description": "Received",
            "detail": "The payout was received"
        },
        "beneficiary": {
            "bank": {
                "name": "Banco",
                "code": "013",
                "branch": null,
                "account": {
                    "number": "18012003456",
                    "type": "S",
                    "alias": null,
                    "pixKey": null,
                    "phone": null
                }
            },
            "type": "INDIVIDUAL",
            "name": "Beneficiary Name",
            "lastname": "Beneficiary LastName ",
            "document": {
                "type": "NIT",
                "id": "36029785"
            },
            "userReference": null,
            "email": null,
            "phone": null,
            "birthdate": "0001-01-01T00:00:00",
            "nationality": null,
            "address": null
        },
        "merchant": {
            "type": "COMPANY",
            "name": "Merchant Name",
            "lastname": null,
            "document": null,
            "userReference": null,
            "email": null,
            "phone": null,
            "birthdate": "0001-01-01T00:00:00",
            "nationality": null,
            "address": null
        },
        "sender": {
            "type": "INDIVIDUAL",
            "name": "Sender INPAY COL",
            "lastname": "Sender LastName",
            "document": {
                "type": "DNI",
                "id": "40754127"
            },
            "userReference": null,
            "email": null,
            "phone": null,
            "birthdate": "0001-01-01T00:00:00",
            "nationality": null,
            "address": null
        },
        "comment": null,
        "exchangeRateToken": null,
        "date": {
            "creationDate": "2023-07-24T15:11:05.3593261+00:00",
            "processedDate": "2023-07-24T15:11:05.4582163+00:00"
        },
        "errors": null
    }

Bad Request

[
    {
        "externalId": "1690211886",
        "internalId": "7a5f2a00-fe38-425a-aabe-34833f55f4a0",
        "status": {
            "code": "300",
            "description": "Rejected",
            "detail": "Invalid param + [param name] + [reason]"
        },
        "errors": [
            {
                "code": "300",
                "description": "Invalid param + document.id + verification failed"
            }
        ],
        "comment": null
    }
]