List

List / Check status for payouts

POST https://sandbox.localpayment.com/api/v2/payouts/list

Headers

Name	Type	Description
Content-Type*	String	Default: application/json Content Type
Authorization*	String	Authorization
customer_id*	String	String <= 12 Customer id
countryCode*	String	Check In Country Codes

Request Body

Name	Type	Description
payout_id	Integer	integer<64>
transaction_id	Integer	integer<64>
merchant_id	String	[ 0 .. 60 ] characters
date_from	String	8 characters format - yyyymmdd
date_to	String	8 characters format - yyyymmdd

200: OK

[
    {
        "payout_id": 51608,
        "customer_name": "Customer X",
        "transaction_type": "PAYOUT",
        "status": "RECEIVED",
        "lot_date": "20211222",
        "gross_amount": 100,
        "net_amount": 100,
        "transaction_list": [
            {
                "transaction_id": 308033,
                "type_of_id": "5",
                "id": "123456",
                "beneficiary_name": "beneficiaryCompany",
                "bank_account_type": "27",
                "bank_account": "111111111",
                "bank_code": "1507",
                "amount": 100,
                "transaction_date": "20211222",
                "merchant_id": "068a33783f1bb859c48657e73828e1a6",
                "concept_code": "0014",
                "currency": "COP",
                "status": "Received",
                "status_detail": "The payout was received and will be processed",
                "exchange_rate": 3961881000,
                "submerchant_code": "my org1",
                "sender_name": null,
                "sender_address": "",
                "sender_state": null,
                "sender_country": null,
                "sender_taxid": null,
                "sender_birthdate": null,
                "sender_email": null,
                "sender_phone_number": null,
                "beneficiary_phone_number": null,
                "gmf_tax": "0"
            }
        ]
    }
]

Example: List request Merchant_id

Request

{
  "merchant_id": "TPXX000000111111"
}

Status Ok

curl --location 'https://sandbox.localpayment.com//api/v2/payouts/list' \
--header 'Authorization: {{Token_Generated}}' \
--header 'customer_id: {{Your_CustomerID}}' \
--header 'countryCode: CHL' \
--header 'Content-Type: application/json' \
--data '
[
    {
        "payout_id": 67901,
        "customer_name": "Client",
        "transaction_type": "PAYOUT",
        "status": "EXECUTED",
        "lot_date": "20230529",
        "gross_amount": 11100,
        "net_amount": 11100,
        "transaction_list": [
            {
                "transaction_id": ,
                "beneficiary_document_type": "RUT",
                "beneficiary_document_number": "000000000",
                "beneficiary_name": "LOCALPAYMENT SPA",
                "bank_account_type": "A",
                "bank_code": "000",
                "beneficiary_account_number": "0000000000",
                "amount": 77600,
                "transaction_date": "20230529",
                "merchant_id": "TPXA000000111111",
                "concept_code": "0000",
                "currency": "CLP",
                "status": "Executed",
                "status_detail": "Successfully executed",
                "exchange_rate": 792495637,
                "submerchant_code": "CLIENT",
                "sender_name": "sample business",
                "sender_address": "",
                "sender_state": "",
                "sender_country": "USA",
                "sender_taxid": "11111111111",
                "sender_birthdate": null,
                "sender_email": null,
                "sender_phone_number": null,
                "beneficiary_phone_number": null
            }
        ]
    }
]

Example: List request by date range

Request

curl --location 'https://sandbox.localpayment.com//api/v2/payouts/list' \
--header 'Content-Type: application/json' \
--header '{{Token_Generated}}' \
--header 'customer_id: {{Your_CustomerID}}' \
--header 'countryCode: ARG' \
--data '
{
  "date_from": "20230528",
  "date_to": "20230529"
}

Status Ok

[
    {
        "payout_id": 67899,
        "customer_name": "Client Argentina",
        "transaction_type": "PAYOUT",
        "status": "INPROGRESS",
        "lot_date": "20230529",
        "gross_amount": 10000,
        "net_amount": 10000,
        "transaction_list": [
            {
                "transaction_id": 328236,
                "type_of_id": "CUIT",
                "beneficiary_cuit": "11111111111",
                "beneficiary_name": "LOCALPAYMENT SRL",
                "bank_account_type": "A",
                "bank_account": "000000111",
                "bank_cbu": "0110000000000000010101",
                "amount": 10379,
                "transaction_date": "20230529",
                "merchant_id": "TPXA000000111111",
                "concept_code": "0040",
                "currency": "ARS",
                "status": "InProgress",
                "status_detail": "The payout is being processed. You cannot cancel any more",
                "withholding_tax_afip": 0,
                "withholding_tax_agip": 0,
                "withholding_tax_arba": 0,
                "exchange_rate": 111111111,
                "submerchant_code": "Client",
                "sender_name": "sample business",
                "sender_address": "Ald s road",
                "sender_state": "",
                "sender_country": "USA",
                "sender_taxid": "12345678912",
                "sender_birthdate": null,
                "sender_email": null,
                "sender_phone_number": null,
                "beneficiary_phone_number": null
            }
        ]
    }
]