Customize Integration

APICurrentLast updated: October 27th 2021, @ 11:23:56 am

Show payout details

To show details for all items in your payout, use the payout_batch_id from the Create a payout response. You can specify the optional fields query parameter to filter the fields that are returned in the response. This example specifies fields=batch_header, which tells the API to return only the batch_header in the response:

curl -v -X GET \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <Access-Token>"

The response shows only batch header information for the payout. The batch header information includes the payout batch ID, the batch status, and other information:

  "batch_header": {
    "payout_batch_id": "12345678",
    "batch_status": "ACKNOWLEDGED",
    "time_created": "2014-01-27T10:17:00Z",
    "time_completed": "2014-01-27T11:17:39.00Z",
    "sender_payout_header": {
      "sender_batch_id": "2014021801",
      "email_subject": "You have a payout!"
    "amount": {
      "value": "435.85",
      "currency": "USD"

Send payments in a different currency

Send payments in certain currencies even if you don’t maintain a balance in that currency. It’s easy to view funding balances, see currency exchange rates, and monitor your payments.

Note: Before using the Payouts API to send payments in another currency, make sure you complete the Payouts integration.

To send a payment in a different currency with the Payouts API, set the currency parameter to the payment's currency code.

Sample currency conversion request

This request calls for a 10 Euro payout.

"recipient_type": "EMAIL", "amount": {
  "value": 10.00,
  "currency": "EUR"
  "receiver": "",
  "note": "Thanks from Acme Inc ",
  "sender_item_id": "item1"

Sample currency conversion response

PayPal automatically converts the payment in your PayPal balance to the currency specified.

"funding_source": "BALANCE", "amount": {
  "currency": "EUR",
  "value": "10.00"
}, "fees": {
  "currency": "EUR",
  "value": "0.20"
}, "currency_conversion": {
  "from_amount": {
    "currency": "USD",
    "value": "11.43"
  "to_amount": {
    "currency": "EUR",
    "value": "10.20"

Note: See a list of country exclusions and restrictions for payouts currency conversion.


Test your integration and go live.

See also