Payouts - List using filters

curl --request POST \
  --url https://api.sandbox.pesaswap.io/payouts/list \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "start_time": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z",
  "payout_id": "187282ab-40ef-47a9-9206-5099ba31e432",
  "connector_response_reference_id": "UEM5T5GEZQ",
  "profile_id": "<string>",
  "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
  "limit": 1,
  "offset": 1,
  "connector": [
    "wise",
    "adyen"
  ],
  "status": [
    "pending",
    "failed"
  ],
  "payout_method": [
    "bank",
    "card"
  ],
  "payout_method_type": [
    "momo_mtn",
    "airtel_money"
  ],
  "amount_filter": {
    "start_amount": 123,
    "end_amount": 123
  },
  "error_code": "<string>",
  "error_message": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    start_time: '2023-11-07T05:31:56Z',
    end_time: '2023-11-07T05:31:56Z',
    payout_id: '187282ab-40ef-47a9-9206-5099ba31e432',
    connector_response_reference_id: 'UEM5T5GEZQ',
    profile_id: '<string>',
    customer_id: 'cus_y3oqhf46pyzuxjbcn2giaqnb44',
    limit: 1,
    offset: 1,
    connector: ['wise', 'adyen'],
    status: ['pending', 'failed'],
    payout_method: ['bank', 'card'],
    payout_method_type: ['momo_mtn', 'airtel_money'],
    amount_filter: {start_amount: 123, end_amount: 123},
    error_code: '<string>',
    error_message: '<string>'
  })
};

fetch('https://api.sandbox.pesaswap.io/payouts/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.sandbox.pesaswap.io/payouts/list"

payload = {
    "start_time": "2023-11-07T05:31:56Z",
    "end_time": "2023-11-07T05:31:56Z",
    "payout_id": "187282ab-40ef-47a9-9206-5099ba31e432",
    "connector_response_reference_id": "UEM5T5GEZQ",
    "profile_id": "<string>",
    "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
    "limit": 1,
    "offset": 1,
    "connector": ["wise", "adyen"],
    "status": ["pending", "failed"],
    "payout_method": ["bank", "card"],
    "payout_method_type": ["momo_mtn", "airtel_money"],
    "amount_filter": {
        "start_amount": 123,
        "end_amount": 123
    },
    "error_code": "<string>",
    "error_message": "<string>"
}
headers = {
    "api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.pesaswap.io/payouts/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'start_time' => '2023-11-07T05:31:56Z',
    'end_time' => '2023-11-07T05:31:56Z',
    'payout_id' => '187282ab-40ef-47a9-9206-5099ba31e432',
    'connector_response_reference_id' => 'UEM5T5GEZQ',
    'profile_id' => '<string>',
    'customer_id' => 'cus_y3oqhf46pyzuxjbcn2giaqnb44',
    'limit' => 1,
    'offset' => 1,
    'connector' => [
        'wise',
        'adyen'
    ],
    'status' => [
        'pending',
        'failed'
    ],
    'payout_method' => [
        'bank',
        'card'
    ],
    'payout_method_type' => [
        'momo_mtn',
        'airtel_money'
    ],
    'amount_filter' => [
        'start_amount' => 123,
        'end_amount' => 123
    ],
    'error_code' => '<string>',
    'error_message' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "size": 1,
  "data": [
    {
      "payout_id": "187282ab-40ef-47a9-9206-5099ba31e432",
      "merchant_id": "merchant_1668273825",
      "amount": 1000,
      "currency": "AED",
      "auto_fulfill": true,
      "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
      "client_secret": "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo",
      "return_url": "https://pesaswap.io",
      "business_country": "AF",
      "entity_type": "Individual",
      "recurring": false,
      "status": "success",
      "profile_id": "<string>",
      "connector": "wise",
      "payout_type": "card",
      "payout_method_data": {
        "card": {
          "card_exp_month": "01",
          "card_exp_year": "2026",
          "card_holder_name": "John Doe",
          "card_issuer": "<string>",
          "card_network": "Visa",
          "card_type": "<string>",
          "card_issuing_country": "<string>",
          "bank_code": "<string>",
          "last4": "<string>",
          "card_isin": "<string>",
          "card_extended_bin": "<string>"
        }
      },
      "billing": {
        "address": {
          "city": "New York",
          "country": "AF",
          "line1": "123, King Street",
          "line2": "Powelson Avenue",
          "line3": "Bridgewater",
          "zip": "08807",
          "state": "New York",
          "first_name": "John",
          "last_name": "Doe"
        },
        "phone": {
          "number": "9123456789",
          "country_code": "+1"
        },
        "email": "<string>"
      },
      "customer": {
        "id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
        "name": "John Doe",
        "email": "johntest@test.com",
        "phone": "9123456789",
        "phone_country_code": "+1"
      },
      "business_label": "food",
      "description": "It's my first payout request",
      "metadata": {},
      "merchant_connector_id": "mca_sAD3OZLATetvjLOYhUSy",
      "error_message": "Failed while verifying the card",
      "error_code": "E0001",
      "created": "2022-09-10T10:11:12Z",
      "connector_transaction_id": "S3FC9G9M2MVFDXT5",
      "connector_response_reference_id": "<string>",
      "priority": "instant",
      "attempts": [
        {
          "attempt_id": "<string>",
          "status": "success",
          "amount": 6583,
          "currency": "AED",
          "connector": "<string>",
          "error_code": "<string>",
          "error_message": "<string>",
          "payment_method": "card",
          "payout_method_type": "ach",
          "connector_transaction_id": "<string>",
          "cancellation_reason": "<string>",
          "unified_code": "UE_000",
          "unified_message": "Invalid card details"
        }
      ],
      "payout_link": {
        "payout_link_id": "<string>",
        "link": "<string>"
      },
      "email": "johntest@test.com",
      "name": "John Test",
      "phone": "9123456789",
      "phone_country_code": "+1",
      "unified_code": "UE_000",
      "unified_message": "Invalid card details",
      "payout_method_id": "<string>"
    }
  ],
  "total_count": 123
}

POST

payouts

list

Payouts - List using filters

curl --request POST \
  --url https://api.sandbox.pesaswap.io/payouts/list \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "start_time": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z",
  "payout_id": "187282ab-40ef-47a9-9206-5099ba31e432",
  "connector_response_reference_id": "UEM5T5GEZQ",
  "profile_id": "<string>",
  "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
  "limit": 1,
  "offset": 1,
  "connector": [
    "wise",
    "adyen"
  ],
  "status": [
    "pending",
    "failed"
  ],
  "payout_method": [
    "bank",
    "card"
  ],
  "payout_method_type": [
    "momo_mtn",
    "airtel_money"
  ],
  "amount_filter": {
    "start_amount": 123,
    "end_amount": 123
  },
  "error_code": "<string>",
  "error_message": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    start_time: '2023-11-07T05:31:56Z',
    end_time: '2023-11-07T05:31:56Z',
    payout_id: '187282ab-40ef-47a9-9206-5099ba31e432',
    connector_response_reference_id: 'UEM5T5GEZQ',
    profile_id: '<string>',
    customer_id: 'cus_y3oqhf46pyzuxjbcn2giaqnb44',
    limit: 1,
    offset: 1,
    connector: ['wise', 'adyen'],
    status: ['pending', 'failed'],
    payout_method: ['bank', 'card'],
    payout_method_type: ['momo_mtn', 'airtel_money'],
    amount_filter: {start_amount: 123, end_amount: 123},
    error_code: '<string>',
    error_message: '<string>'
  })
};

fetch('https://api.sandbox.pesaswap.io/payouts/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.sandbox.pesaswap.io/payouts/list"

payload = {
    "start_time": "2023-11-07T05:31:56Z",
    "end_time": "2023-11-07T05:31:56Z",
    "payout_id": "187282ab-40ef-47a9-9206-5099ba31e432",
    "connector_response_reference_id": "UEM5T5GEZQ",
    "profile_id": "<string>",
    "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
    "limit": 1,
    "offset": 1,
    "connector": ["wise", "adyen"],
    "status": ["pending", "failed"],
    "payout_method": ["bank", "card"],
    "payout_method_type": ["momo_mtn", "airtel_money"],
    "amount_filter": {
        "start_amount": 123,
        "end_amount": 123
    },
    "error_code": "<string>",
    "error_message": "<string>"
}
headers = {
    "api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.pesaswap.io/payouts/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'start_time' => '2023-11-07T05:31:56Z',
    'end_time' => '2023-11-07T05:31:56Z',
    'payout_id' => '187282ab-40ef-47a9-9206-5099ba31e432',
    'connector_response_reference_id' => 'UEM5T5GEZQ',
    'profile_id' => '<string>',
    'customer_id' => 'cus_y3oqhf46pyzuxjbcn2giaqnb44',
    'limit' => 1,
    'offset' => 1,
    'connector' => [
        'wise',
        'adyen'
    ],
    'status' => [
        'pending',
        'failed'
    ],
    'payout_method' => [
        'bank',
        'card'
    ],
    'payout_method_type' => [
        'momo_mtn',
        'airtel_money'
    ],
    'amount_filter' => [
        'start_amount' => 123,
        'end_amount' => 123
    ],
    'error_code' => '<string>',
    'error_message' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "size": 1,
  "data": [
    {
      "payout_id": "187282ab-40ef-47a9-9206-5099ba31e432",
      "merchant_id": "merchant_1668273825",
      "amount": 1000,
      "currency": "AED",
      "auto_fulfill": true,
      "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
      "client_secret": "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo",
      "return_url": "https://pesaswap.io",
      "business_country": "AF",
      "entity_type": "Individual",
      "recurring": false,
      "status": "success",
      "profile_id": "<string>",
      "connector": "wise",
      "payout_type": "card",
      "payout_method_data": {
        "card": {
          "card_exp_month": "01",
          "card_exp_year": "2026",
          "card_holder_name": "John Doe",
          "card_issuer": "<string>",
          "card_network": "Visa",
          "card_type": "<string>",
          "card_issuing_country": "<string>",
          "bank_code": "<string>",
          "last4": "<string>",
          "card_isin": "<string>",
          "card_extended_bin": "<string>"
        }
      },
      "billing": {
        "address": {
          "city": "New York",
          "country": "AF",
          "line1": "123, King Street",
          "line2": "Powelson Avenue",
          "line3": "Bridgewater",
          "zip": "08807",
          "state": "New York",
          "first_name": "John",
          "last_name": "Doe"
        },
        "phone": {
          "number": "9123456789",
          "country_code": "+1"
        },
        "email": "<string>"
      },
      "customer": {
        "id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
        "name": "John Doe",
        "email": "johntest@test.com",
        "phone": "9123456789",
        "phone_country_code": "+1"
      },
      "business_label": "food",
      "description": "It's my first payout request",
      "metadata": {},
      "merchant_connector_id": "mca_sAD3OZLATetvjLOYhUSy",
      "error_message": "Failed while verifying the card",
      "error_code": "E0001",
      "created": "2022-09-10T10:11:12Z",
      "connector_transaction_id": "S3FC9G9M2MVFDXT5",
      "connector_response_reference_id": "<string>",
      "priority": "instant",
      "attempts": [
        {
          "attempt_id": "<string>",
          "status": "success",
          "amount": 6583,
          "currency": "AED",
          "connector": "<string>",
          "error_code": "<string>",
          "error_message": "<string>",
          "payment_method": "card",
          "payout_method_type": "ach",
          "connector_transaction_id": "<string>",
          "cancellation_reason": "<string>",
          "unified_code": "UE_000",
          "unified_message": "Invalid card details"
        }
      ],
      "payout_link": {
        "payout_link_id": "<string>",
        "link": "<string>"
      },
      "email": "johntest@test.com",
      "name": "John Test",
      "phone": "9123456789",
      "phone_country_code": "+1",
      "unified_code": "UE_000",
      "unified_message": "Invalid card details",
      "payout_method_id": "<string>"
    }
  ],
  "total_count": 123
}

Authorizations

api-key

string

header

required

Use the API key created under your merchant account from the Pesaswap dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Body

application/json

A type representing a range of time for filtering, including a mandatory start time and an optional end time.

start_time

string<date-time>

required

The start time to filter payments list or to get list of filters. To get list of filters start time is needed to be passed

currency

enum<string>

required

The three letter ISO currency code in uppercase. Eg: 'USD' for the United States Dollar.

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLE,

SLL,

SOS,

SRD,

SSP,

STN,

SVC,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VES,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW,

ZWL

entity_type

enum<string>

required

Type of entity to whom the payout is being carried out to, select from the given list of options

Available options:

Individual,

Company,

NonProfit,

PublicSector,

NaturalPerson,

lowercase,

Personal

end_time

string<date-time> | null

The end time to filter payments list or to get list of filters. If not passed the default time is now

payout_id

string | null

The identifier for payout

Required string length: 30

Example:

"187282ab-40ef-47a9-9206-5099ba31e432"

connector_response_reference_id

string | null

The connector's reference ID for the payout transaction

Example:

"UEM5T5GEZQ"

profile_id

string | null

The identifier for business profile

customer_id

string | null

The identifier for customer

Example:

"cus_y3oqhf46pyzuxjbcn2giaqnb44"

limit

integer<int32>

The limit on the number of objects. The default limit is 10 and max limit is 20

Required range: x >= 0

offset

integer<int32> | null

The starting point within a list of objects

Required range: x >= 0

connector

enum<string>[] | null

The list of connectors to filter payouts list

Available options:

aicapay,

adyen,

adyenplatform,

airtel,

cybersource,

choicebank,

daraja,

ebanx,

payone,

paypal,

stripe,

wise,

momomtn

Example:

["wise", "adyen"]

status

enum<string>[] | null

The list of payout status to filter payouts list

Available options:

success,

failed,

cancelled,

initiated,

expired,

reversed,

pending,

ineligible,

requires_creation,

requires_confirmation,

requires_payout_method_data,

requires_fulfillment,

requires_vendor_account_creation

Example:

["pending", "failed"]

payout_method

enum<string>[] | null

The list of payout methods to filter payouts list

The payout_type of the payout request is a mandatory field for confirming the payouts. It should be specified in the Create request. If not provided, it must be updated in the Payout Update request before it can be confirmed.

Available options:

card,

bank,

wallet

Example:

["bank", "card"]

payout_method_type

enum<string>[] | null

The list of payout method types to filter payouts list

Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets.

Available options:

ach,

affirm,

afterpay_clearpay,

alfamart,

ali_pay,

ali_pay_hk,

alma,

amazon_pay,

apple_pay,

atome,

bacs,

bancontact_card,

becs,

benefit,

bizum,

blik,

boleto,

bca_bank_transfer,

bni_va,

bri_va,

card_redirect,

cimb_va,

pay_bill,

pay_till,

classic,

credit,

crypto_currency,

cashapp,

dana,

danamon_va,

debit,

duit_now,

efecty,

eps,

fps,

evoucher,

giropay,

givex,

google_pay,

go_pay,

gcash,

ideal,

interac,

indomaret,

klarna,

kakao_pay,

local_bank_redirect,

mandiri_va,

knet,

mb_way,

mobile_pay,

momo,

momo_atm,

pesa_link,

online_banking_thailand,

online_banking_czech_republic,

online_banking_finland,

online_banking_fpx,

online_banking_poland,

online_banking_slovakia,

oxxo,

pago_efectivo,

permata_bank_transfer,

open_banking_uk,

pay_bright,

paypal,

paze,

pix,

pay_safe_card,

przelewy24,

prompt_pay,

pse,

red_compra,

red_pagos,

samsung_pay,

sepa,

sofort,

swish,

touch_n_go,

trustly,

twint,

upi_collect,

upi_intent,

vipps,

viet_qr,

venmo,

walley,

we_chat_pay,

seven_eleven,

lawson,

mini_stop,

family_mart,

seicomart,

pay_easy,

local_bank_transfer,

mifinity,

open_banking_pis,

m_pesa_express,

airtel_money,

momo_mtn,

m_pesa_imt

Example:

["momo_mtn", "airtel_money"]

amount_filter

object | null

Show child attributes

error_code

string | null

The error code to filter payouts list

error_message

string | null

The error message to filter payouts list

Response

Payouts filtered

size

integer

required

The number of payouts included in the list

Required range: x >= 0

data

object[]

required

The list of payouts response objects

Show child attributes

total_count

integer<int64> | null

The total number of available payouts for given constraints

Operations

Advanced Features

Admin APIs

Payouts - List using filters

Authorizations

Body

Response