Payout Details

Get Payout Details

GET https://<PayEngine-host>/api/merchant/:merchant_id/payouts/:payout_id

Path Parameters

Name	Type	Description
merchant_id*	String	Merchant Id
payout_id*	String	Payout Id

200: OK

Payout Field Details

Field Name	Type	Description	Required?
id	string	id of the payout	yes
fee_amount	string	Total fee amount	yes
funding_amount	string	Total funding amount	yes
chargeback_amount	string	Total chargeback amount	yes
debit_amount	string	Total debit amount	yes
merchant_id	string	Merchant id that the payout belongs to	yes
payout_date	string	Date of the payout	yes
fees	array	All the fees for a payout	yes
fees[i].id	string	id of the fee	yes
fees[i].description	string	Description of the fee	yes
fees[i].amount	string	Fee amount	yes
fees[i].payment_date	string	Fee payment date	yes
transactions	array	Payout Transactions	yes

Second Tab

Payout Details Sample Response

{
  "data": {
    "id": "5cba57c5-5079-4756-8220-349ba669b481",
    "fee_amount": "-5.00",
    "funding_amount": "193.20",
    "chargeback_amount": "10.00",
    "adjustment_amount": "10.00",
    "debit_amount": "173.20",
    "payout_date": "2022-06-06T20:00:00.000Z",
    "fees": [
      {
        "id": "3a57cc2a-5ee8-42f6-9d5e-06b75e056faa",
        "amount": 5.00,
        "description": "ASSESSMENTS",
        "payment_date": "2022-04-13T20:00:00+00:00"
      },
      {
        "id": "af5bcc6f-6ae2-408a-9c35-be852bd165b5",
        "amount": 5.00,
        "description": "VISA NO AVS SUBMITTED",
        "payment_date": "2022-04-13T20:00:00+00:00"
      }
    ],
    "transactions":[
            {
                "id": "02729cb3-6983-4b14-8a8e-3f902108ed06",
                "data": {
                    "last_4": "2003",
                    "card_id": null,
                    "card_type": "aexp",
                    "bank_account_id": null
                },
                "type": "payment",
                "amount": 193.2,
                "status": "succeeded",
                "created_at": "2022-08-07T21:00:00+00:00",
                "is_offline": false,
                "updated_at": "2022-08-07T21:00:00+00:00",
                "external_id": "26220974276",
                "host_report": {
                    "status": "PASS",
                    "task_id": "26220974276",
                    "auth_code": "865098",
                    "card_type": "aexp",
                    "total_amount": "$193.20",
                    "response_code": "1",
                    "transaction_id": "26220974276",
                    "customer_receipt": "<Customer Receipt>",
                    "merchant_receipt": "<Merchant Receipt>",
                    "processed_amount": "$193.20",
                    "response_message": "APPROVAL",
                    "host_response_code": "100",
                    "masked_card_number": "377964*****2003",
                    "transaction_amount": "$193.20",
                    "host_reference_number": "26220974276",
                    "transaction_timestamp": "08082022",
                    "host_response_result_raw": "{}",
                    "address_verification_code": "",
                    "card_transaction_identifier": "26220974276",
                    "card_holder_verification_code": "N"
                },
                "customer_name": "John Doe",
                "transaction_id": "871b3957-51bf-4b67-a09e-5ffc2e41d277",
                "payment_method": "Credit Card"
            }]
  }
}