WooshPay OpenAPI
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Back to WooshPay Website
  1. Payouts
  2. Beneficiary
  • API Introduction
  • Error Code
  • Payment Intents
    • Create a PaymentIntent
      POST
    • Update a PaymentIntent
      POST
    • Cancel a PaymentIntent
      POST
    • Capture a PaymentIntent
      POST
    • Confirm a PaymentIntent
      POST
    • Retrieve a PaymentIntent
      GET
    • List all PaymentIntents
      GET
    • Search PaymentIntents
      GET
  • Charges
    • Retrieve a charge
      GET
    • List all charges
      GET
  • Payment Methods
    • Create a PaymentMethod
      POST
    • Retrieve a PaymentMethod
      GET
    • Retrieve a Customer's PaymentMethod
      GET
    • Update a PaymentMethod
      POST
    • List PaymentMethods
      GET
    • List a Customer's PaymentMethods
      GET
    • Attach a PaymentMethod to a Customer
      POST
    • Detach a PaymentMethod from a Customer
      POST
  • Refunds
    • Create a refund
      POST
    • Retrieve a refund
      GET
  • Webhooks
    • Create a Webhook
      POST
    • List All Webhooks
      GET
    • Retrieve a Webhook
      GET
    • Delete a Webhook
      DELETE
    • Update a Webhook
      POST
  • Events
    • Types of events
    • Retrieve an event
      GET
  • Files
    • Files
    • Create a file
      POST
    • Retrieve a file
      GET
  • Disputes
    • Retrieve a dispute
      GET
    • Update a dispute
      POST
    • Close a dispute
      POST
    • List all disputes
      GET
  • Payouts
    • Beneficiary
      • Create a beneficiary
        POST
      • Retrieve a beneficiary
        GET
      • List all beneficiaries
        GET
      • Update a beneficiary
        POST
      • Delete a beneficiary
        DELETE
    • Payouts
      • Create a payout
        POST
      • Retrieve a Payout
        GET
      • Update a Payout
        POST
      • List All Payouts
        GET
  • Balance
    • Get balance
      GET
  • Products
    • Create a Product
      POST
    • Retrieve a product
      GET
    • Update a product
      POST
    • List all products
      GET
  • Prices
    • Create a price
      POST
    • Retrieve a price
      GET
    • Update a price
      POST
  • Payment Links
    • Create a payment link
      POST
    • Update a payment link
      POST
    • Retrieve payment link
      GET
    • List all payment links
      GET
    • Retrieve a payment link's line items
      GET
  • Checkout
    • Create a Session
      POST
    • Expire a Session
      POST
    • Retreive a Session
      GET
    • List All Checkout Sessions
      GET
    • Retrieve a Checkout Session's line items
      GET
  • Customers
    • Create a customer
      POST
    • Retrieve a customer
      GET
    • Update a customer
      POST
  • Setup Intents
    • Create a SetupIntent
      POST
    • Retrieve a SetupIntent
      GET
    • Cancel a SetupIntent
      POST
    • List all SetupIntents
      GET
    • List all SetupAttempts
      GET
    • Update a SetupIntent
      POST
    • Confirm a SetupIntent
      POST
  • Invoices
    • Create an invoice
      POST
    • Retrieve an invoice
      GET
    • Finalize an invoice
      POST
    • Send an invoice for manual payment
      POST
    • Delete a draft invoice
      GET
    • Void an invoice
      POST
    • List all invoices
      GET
    • Pay an invoice
      POST
  • Invoice Items
    • Create an invoice item
      POST
    • Retrieve an invoice item
      GET
  • Invoice Line Item
    • Bulk add invoice line items
      POST
  • Subscriptions
    • Create a subscription
      POST
    • Retrieve a subscription
      GET
    • Update a subscription
      POST
    • Cancel a subscription
      DELETE
    • List subscriptions
      GET
  • Subscription Items
    • Create a subscription item
      POST
    • Retrieve a subscription item
      GET
    • Delete a subscription item
      DELETE
  • Issuing
    • Authorizations
      • Retrieve an authorization
        GET
      • List all authorization
        GET
    • Cardholders
      • Create a cardholder
        POST
      • Update a cardholder
        POST
      • Retrieve a cardholder
        GET
      • List all cardholders
        GET
    • Cards
      • Create a card
        POST
      • Update a card
        POST
      • Retrieve a card
        GET
      • List all cards
        GET
      • Retrieve card remaining limits
        GET
    • Transactions
      • Update a transaction
        POST
      • Retrieve a transaction
        GET
      • List all transactions
        GET
  • Coupons
    • Create a Coupon
      POST
    • Retrieve a coupon
      GET
    • Delete a coupon
      DELETE
  • Promotion Code
    • Create a promotion code
      POST
    • Update a promotion code
      POST
  • Accounts
    • Retrieve account's paymentmethods
      GET
  1. Payouts
  2. Beneficiary

Retrieve a beneficiary

GET
/v1/beneficiaries/{beneficiary_id}

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string {{Username}}:{{Password}}
Example:
Authorization: Basic YWRtaW46MTIzNDU2
Path Params
beneficiary_id
string 
required
Header Params
Accept
string 
required
Default:
application/json
Content-Type
string 
required
Default:
application/json

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://apitest.wooshpay.com/v1/beneficiaries/?members&reference&Type&_postman_listIndexKey=key&_postman_listAllowsMultipleValues'

Responses

🟢200OK
application/json
Body
id
string 
optional
Unique identifier for the object, "bn_xxxxx".
object
string 
optional
"beneficiary"
created
integer 
optional
The time at which the object was created. Measured in seconds since the Unix epoch.
destination_data
object 
required
Create a new card or bank account for payouts was sent to. Condtional requried, one of destination and destination is required.
destination_type
enum<string> 
required
Payment method
Allowed values:
bank_accountcardcarrier_billingalipay
bank_account
object 
optional
Condtional requried
card
object 
optional
Condtional requried
carrier_billing
object 
optional
Condtional requried
alipay
object 
optional
Condtional requried
imps
object 
optional
Condtional requried
upi
object 
optional
Condtional requried
nickname
string 
optional
Nickname of beneficiary for quickly retrieving
metadata
object 
optional
Set of key-value pairs attaching to an object. This can be a channel for customers that provides additional material about the beneficiary
livemode
boolean 
optional
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Example
{
  "id": "string",
  "object": "string",
  "created": 0,
  "destination_data": {
    "destination_type": "bank_account",
    "bank_account": {
      "account_number": "string",
      "account_holder_name": "string",
      "account_holder_type": "individual",
      "phone_number": "string",
      "email": "string",
      "country": "string",
      "swift": "string",
      "dob": {
        "day": "string",
        "month": "string",
        "year": "string"
      },
      "gender": "male",
      "certificate": {
        "certificate_type": "id_card",
        "certificate_number": "string"
      },
      "bank_name": "string",
      "metadata": {},
      "routing_number": "string",
      "routing_type": "aba",
      "description": "string"
    },
    "card": {
      "name": "string",
      "number": "string",
      "description": "string",
      "billing_address": {
        "address": {
          "city": "string",
          "country": "string",
          "line1": "string",
          "line2": "string",
          "postal_code": "string",
          "state": "string"
        }
      },
      "metadata": {}
    },
    "carrier_billing": {
      "carrier": "megafon",
      "phone_number": "string",
      "country": "string",
      "description": "string"
    },
    "alipay": {
      "user_id": "string",
      "first_name": "string",
      "last_name": "string"
    },
    "imps": {
      "account_number": "string",
      "phone_number": "string",
      "email": "string",
      "name": "string",
      "bank_code": "string"
    },
    "upi": {
      "vpa": "string",
      "phone_number": "string"
    }
  },
  "nickname": "string",
  "metadata": {},
  "livemode": true
}
Modified at 2023-12-18 06:36:01
Previous
Create a beneficiary
Next
List all beneficiaries
Built with