Update transfer

patch

https://api.stage.payouts.com/api/v1/paypal-payment/transfers/{transferId}

Required headers for authentication with api key OR more secure signature + timestamp

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

transferId

number

required

Body Params

paymentDate

string | null

Date when the transfer should be done

recipientDestinationType

string

Type of the paypal recipient destination

recipientDestination

string

Paypal recipient destination

currency

string

Currency you would like to pay in

amount

number

Amount you would like to transfer

note

string | null

Note for the paypal transfer which will be visible to the recipient

reason

string

Reason

requireApproval

object | null

If true, the transfer requires approval and will be in a pending state until approved

reference

string

Reference

internalReference

string

Internal reference

recipientType

string

enum

Type of the recipient

Allowed:

recipientFirstName

string | null

First name of the recipient

recipientLastName

string | null

Last name of the recipient

recipientCompanyName

string | null

Company name of the recipient

recipientEmail

string | null

Email address of the recipient. It's not use for a executing a payment

recipientNickName

string | null

Nick name of the recipient

recipientCity

string | null

Recipient city

recipientState

string | null

Recipient state

recipientCountry

string | null

Recipient country

recipientPostalCode

string | null

Recipient postal code

recipientAddress

string | null

Recipient address

provider

string

enum

Defaults to EXTERNAL

Provider of the transfer

Allowed:

Responses

400

404

A response indicating that the tranfer not found

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201

401A response indicating that the provided api token is invalid or has already expired