WooshPay OpenAPI
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Back to WooshPay Website
  1. 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
    • Retrieve a refund
  • Webhooks
    • Create a Webhook
    • List All Webhooks
    • Retrieve a Webhook
    • Delete a Webhook
    • Update a Webhook
  • Events
    • Types of events
    • Retrieve an event
  • Files
    • Files
    • Create a file
    • Retrieve a file
  • Disputes
    • Retrieve a dispute
    • Update a dispute
    • Close a dispute
    • List all disputes
  • 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
      • Retrieve a Payout
      • Update a Payout
      • List All Payouts
  • Balance
    • Get balance
  • Products
    • Create a Product
    • Retrieve a product
    • Update a product
    • List all products
  • Prices
    • Create a price
    • Retrieve a price
    • Update a price
  • Payment Links
    • Create a payment link
    • Update a payment link
    • Retrieve payment link
    • List all payment links
    • Retrieve a payment link's line items
  • Checkout
    • Create a Session
    • Expire a Session
    • Retreive a Session
    • List All Checkout Sessions
    • Retrieve a Checkout Session's line items
  • Customers
    • Create a customer
    • Retrieve a customer
    • Update a customer
  • Invoices
    • Setup Intents
      • Create a SetupIntent
      • Retrieve a SetupIntent
      • Cancel a SetupIntent
      • List all SetupIntents
      • List all SetupAttempts
      • Update a SetupIntent
      • Confirm a SetupIntent
    • Create an invoice
    • Retrieve an invoice
    • Finalize an invoice
    • Send an invoice for manual payment
    • Delete a draft invoice
    • Void an invoice
    • List all invoices
    • Pay an invoice
  • Invoice Items
    • Create an invoice item
    • Retrieve an invoice item
  • Invoice Line Item
    • Bulk add invoice line items
  • Subscriptions
    • Create a subscription
    • Retrieve a subscription
    • Update a subscription
    • Cancel a subscription
    • List subscriptions
  • Subscription Items
    • Create a subscription item
    • Retrieve a subscription item
    • Delete a subscription item
  • Issuing
    • Authorizations
      • Retrieve an authorization
      • List all authorization
    • Cardholders
      • Create a cardholder
      • Update a cardholder
      • Retrieve a cardholder
      • List all cardholders
    • Cards
      • Create a card
      • Update a card
      • Retrieve a card
      • List all cards
      • Retrieve card remaining limits
    • Transactions
      • Update a transaction
      • Retrieve a transaction
      • List all transactions
  • Coupons
    • Create a Coupon
    • Retrieve a coupon
    • Delete a coupon
  • Promotion Code
    • Create a promotion code
    • Update a promotion code
  • Accounts
    • Retrieve account's paymentmethods
  • Fx Quote
    • Create an FX Quote
  1. Beneficiary

Update a beneficiary

POST
/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 *****************
Path Params
beneficiary_id
string 
required
Header Params
Accept
string 
required
Default:
application/json
Content-Type
string 
required
Default:
application/json
Body Params application/json
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
Example
{
    "nickname": "string",
    "metadata": {}
}

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 POST 'https://apitest.wooshpay.com/v1/beneficiaries/' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "nickname": "string",
    "metadata": {}
}'

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
}
Previous
List all beneficiaries
Next
Delete a beneficiary
Built with