Payouts API

Use the Payouts API to make PayPal payments to multiple PayPal accounts in a single API call. You can specify the recipients by using their PayPal email addresses, phone numbers, or encrypted PayPal account numbers.

The Payouts API is a fast, convenient way to send commissions, rebates, rewards, and general disbursements. Payouts appear as Mass Payments in the sender's PayPal account and are provided with the Mass Payment reports.

Important: To use the Payouts API, request access through My Account. Alternatively, contact your account manager or PayPal Customer Support. You must have a PayPal business account.

The Payouts API uses the ISO 8601 date and time format.

For more information about the Payouts API, see Payouts.

Note: (Deprecation notice)

Synchronous mode will soon be deprecated and is no longer available for new integrations but continues to be supported for existing integrations. A synchronous mode payout immediately returns the results of the payout.

Payouts (resource group)

Use the /payouts resource to create payouts and show batch payout details.

Create payouts

POST /v1/payments/payouts

You can make payouts to one or more PayPal accounts.

By default, a Payouts API call is asynchronous, which lets you show payout details at a later time. See Batch payouts.

Note: (Deprecation notice)

Synchronous mode will soon be deprecated and is no longer available for new integrations but continues to be supported for existing integrations. A synchronous mode payout immediately returns the results of the payout.

If you submit a single payout, you can make a synchronous payout call, which immediately returns the results of the payout. In a synchronous payout call, the response is similar to the show batch payout status response.

To make a synchronous payout, specify sync_mode=true in the URI:

/v1/payments/payouts?sync_mode=true

In asynchronous payout mode (sync_mode=false), you can specify a maximum of 500 individual payouts in one API call. Exceeding 500 payouts in one call returns the HTTP 400 (Bad Request) status code. Default mode is the asynchronous payout mode.

Note: PayPal prevents duplicate batches from being processed. If you specify a sender_batch_id that was used in the last 30 days, the API rejects the request and returns an error message that indicates the duplicate sender_batch_id and includes a HATEOAS link to the original batch payout with the same sender_batch_id. If you receive an HTTP 5nn status code, you can safely retry the request with the same sender_batch_id. In any case, the API completes a payment only once for a specific sender_batch_id that is used within 30 days.

Note: The Payouts API does not currently support BN codes. In a future Payouts release, you can optionally provide BN codes in the PayPal-Partner-Attribution-Id request header. For information about the PayPal-Partner-Attribution-Id header, see REST API authentication and headers. To request a BN code or to learn more about these codes, contact your Partner Manager or see PayPal Partner Program.

Parameters

  • sync_mode

    query_string boolean

    Indicates whether to return an immediate and synchronous response or an asynchronous response in the background. Set to true to return an immediate and synchronous response. Default is false.
    Note: (Deprecation notice) Synchronous mode will soon be deprecated and is no longer available for new integrations but continues to be supported for existing integrations. A synchronous mode payout immediately returns the results of the payout.

Request

Include a sender_batch_header object to describe how to handle the payments in a specified items array.

For the difference between an asynchronous and synchronous create payout request, see the overview.

The items array in a synchronous call is the same as the items array in an asynchronous call, except that only one item is specified. To make a synchronous payout, specify sync_mode=true in the URL; see Create a single payout.

The recipient_type in the sender_batch_header is the type of identification that can be used for payment receivers. If you provide the recipient_type in the sender_batch_header, any payout items without a recipient_type value use the sender_batch_header value. If you omit the recipient_type from the sender_batch_header, each payout item must include a recipient_type value.

Thus, the recipient_type specifies the type of receiver data that identifies the receiver. Value is:

  • EMAIL. Unencrypted email.
  • PHONE. Unencrypted phone number.
  • PAYPAL_ID. Encrypted PayPal account number.

The items array contains payouts to individual recipients. Each item in the array has data for a single payout to one recipient.

  • sender_batch_header

    object

    required

    The sender-provided batch header for a batch payout request.
  • items

    array (contains the payout_item object)

    required

    A sender-created payout to a single recipient.

    Maximum length: 5000.

SDK samples: C#, JAVA, Node.js, PHP, Python, Ruby

Sample Request

curl -v -X POST https://api.sandbox.paypal.com/v1/payments/payouts \
-H "Content-Type:application/json" \
-H "Authorization: Bearer Access-Token" \
-d '{
  "sender_batch_header": {
  "sender_batch_id": "2014021801",
  "email_subject": "You have a payout!"
  },
  "items": [
  {
    "recipient_type": "EMAIL",
    "amount": {
    "value": "9.87",
    "currency": "USD"
    },
    "note": "Thanks for your patronage!",
    "sender_item_id": "201403140001",
    "receiver": "anybody01@gmail.com"
  },
  {
    "recipient_type": "PHONE",
    "amount": {
    "value": "112.34",
    "currency": "EUR"
    },
    "note": "Thanks for your support!",
    "sender_item_id": "201403140002",
    "receiver": "91-734-234-1234"
  },
  {
    "recipient_type": "PHONE",
    "amount": {
    "value": "5.32",
    "currency": "USD"
    },
    "note": "Thanks for your patronage!",
    "sender_item_id": "201403140003",
    "receiver": "408-234-1234"
  },
  {
    "recipient_type": "PHONE",
    "amount": {
    "value": "5.32",
    "currency": "USD"
    },
    "note": "Thanks for your patronage!",
    "sender_item_id": "201403140004",
    "receiver": "408-234-1234"
  }
  ]
}'

Response

The asynchronous payout response contains an ID for a newly created batch payout. To show a batch payout status, use the payout_batch_id value in the response. The response also contains data about the batch payout resource that the request creates.

If the initial scan that checks for syntax errors, missing or duplicated keywords, and more succeeds, the batch_status is PENDING. The API does not immediately validate some payout item values, such as the receiver phone numbers, before the API provides a call response.

For information about the response to a synchronous Payout request, see Create a single payout.

  • batch_header

    object

    The batch header.
  • items

    array (contains the payout_item object)

    A sender-created payout to a single recipient.

    Maximum length: 5000.

  • links

    array (contains the link object)

    HATEOAS links related to this call.

    Read only.

Sample Response

{
  "batch_header": {
    "sender_batch_header": {
      "sender_batch_id": "2014021801",
      "email_subject": "You have a payout!"
    },
    "payout_batch_id": "12345678",
    "batch_status": "PENDING"
  }
}

Show batch payout details

GET /v1/payments/payouts/payout_batch_id

Periodically shows the latest status of a batch payout along with the transaction status and other data for individual items.

Also, returns IDs for the individual payout items. You can use these item IDs in other calls. For example, specify the ID of a payout item to Show payout item details.

The batch payout status is one of these values:

Status Description
ACKNOWLEDGED The payout is acknowledged and will be processed. This status does not apply to the REST API but applies to only Web upload.
DENIED No batch payout items are processed.
PENDING The batch payout is waiting to be processed.
PROCESSING The batch payout is being processed.
SUCCESS The batch payout was successfully processed. Note that some batch payout items might not be completely processed because, for example, they are unclaimed or on hold.
NEW The batch payout is delayed due to PayPal internal updates.
CANCELED This status cannot occur if the sender uses the API to only send payouts. This status is an edge-case if a sender uses both the MassPay web upload and the Payouts API, cancels the web upload, and then uses the API to find the batch payout or payout items. Then, the CANCELED status is possible.

The item transaction status is one of these values:

Status Description
BLOCKED The payout item is blocked.
DENIED The payout item was denied payment.
FAILED Processing for the payout item failed.
NEW The payment processing is delayed due to PayPal internal updates.
ONHOLD The payout item is on hold.
PENDING The payout item is awaiting payment.
REFUNDED The payment for the payout item was successfully refunded.
RETURNED The payout item is returned. If the recipient does not claim it in 30 days, the funds are returned.
SUCCESS The payout item was successfully processed.
UNCLAIMED The payout item is unclaimed. If it is not claimed within 30 days, the funds are returned to the sender.

Parameters

Specify the ID of a batch payout in the URI. Enables you to show payout header information for an entire batch payout request.

  • payout_batch_id

    path string

    The ID of the batch payout for which to show status. You can use the payout_batch_id value that the create batch payout request created.

  • fields

    query_string string

    Optional. Shows details for only the specified fields.
SDK samples: C#, JAVA, Node.js, PHP, Python, Ruby

Sample Request

curl -v -X GET https://api.sandbox.paypal.com/v1/payments/payouts/12345678?fields=batch_header \
-H "Content-Type:application/json" \
-H "Authorization: Bearer Access-Token"

Response

Returns the batch payout data including status and payout items data.

  • batch_header

    object

    A batch payout header object. Includes the status of the batch payout and other data.

  • items

    array (contains the payout_item_details object)

    An array of individual payout items. Each item shows the payout item ID, transaction information, and other data.

  • links

    array (contains the link object)

    HATEOAS links related to this call.

    Read only.

Sample Response

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

Payout item (resource group)

Use the /payouts-item resource to show details for a payout item an cancel an unclaimed payout item.

Note: (Deprecation notice)

Synchronous mode will soon be deprecated and is no longer available for new integrations but continues to be supported for existing integrations. A synchronous mode payout immediately returns the results of the payout.

Show payout item details

GET /v1/payments/payouts-item/payout_item_id

Shows the details for a payout item. Use this call to review the current status of a previously unclaimed, or pending, payout item.

For the supported status values, see the transaction status table in show batch payout details.

Parameters

Specify a payout item ID. The show batch payout details call shows payout item IDs in payout_item_id fields.

  • payout_item_id

    path string

    required

    The ID of the payout item for which to show details.
SDK samples: C#, JAVA, Node.js, PHP, Python, Ruby

Sample Request

curl -v -X GET https://api.sandbox.paypal.com/v1/payments/payouts-item/1421342 \
-H "Content-Type:application/json" \
-H "Authorization: Bearer Access-Token"

Response

Returns a payout_item_details object, which contains data about a payout item including the transaction status.

A payout_item_id helps you identify denied payments. If a payment is denied, you can use the payout_item_id to identify the payment even if it lacks a transaction_id.

  • payout_item_id

    string

    The ID for the payout item. Viewable when you show details for a batch payout.

    Maximum length: 30.

  • transaction_id

    string

    The PayPal-generated ID for the transaction.

    Maximum length: 30.

  • transaction_status

    object

    The transaction status.
  • payout_item_fee

    object

    The fee, in U.S. dollars.
  • payout_batch_id

    string

    The PayPal-generated ID for the batch payout.

    Maximum length: 30.

  • sender_batch_id

    string

    A sender-specified ID number. Tracks the batch payout in an accounting system.

    Maximum length: 30.

  • payout_item

    object

    The sender-provided information for the payout item.
  • time_processed

    string

    The date and time when this item was last processed, in Internet date and time format.

    Format: date-time.

  • errors

    object

    Details of an Error
  • links

    array (contains the link object)

    HATEOAS links related to this call.

    Read only.

Sample Response

{
  "payout_item_id": "1421342",
  "transaction_id": "4345",
  "transaction_status": "SUCCESS",
  "payout_item_fee": {
    "currency": "USD",
    "value": "0.35"
  },
  "payout_batch_id": "20140724",
  "payout_item": {
    "amount": {
      "value": "9.87",
      "currency": "USD"
    },
    "recipient_type": "EMAIL",
    "note": "Thanks for your patronage!",
    "receiver": "anybody01@gmail.com",
    "sender_item_id": "14Feb_234"
  },
  "time_created": "2014-01-27T10:17:00Z",
  "time_processed": "2014-01-27T10:17:41Z",
  "links": [
    {
      "rel": "self",
      "href": "https://api.sandbox.paypal.com/v1/payments/payouts-item/1421342",
      "method": "GET"
    },
    {
      "rel": "self",
      "href": "https://api.sandbox.paypal.com/v1/payments/payouts-item/1421342/cancel",
      "method": "POST"
    },
    {
      "href": "https://localhost:12380/v1/payments/payouts/NEYJ9G3JNQV78",
      "rel": "batch",
      "method": "GET"
    }
  ]
}

Cancel unclaimed payout item

POST /v1/payments/payouts-item/payout_item_id/cancel

Cancels an unclaimed transaction. If no one claims the unclaimed item within 30 days, the funds are automatically returned to the sender. Use this call to cancel the unclaimed item before the automatic 30-day refund.

Parameters

Specify a payout item ID followed by the /cancel action in the URI. The show batch payout details call shows payout item IDs in payout_item_id fields.

You can cancel only payout items with a transaction_status of UNCLAIMED.

  • payout_item_id

    path string

    required

    The ID of the payout item to cancel.
SDK samples: C#, JAVA, Node.js, PHP, Python, Ruby

Sample Request

curl -v -X POST https://api.sandbox.paypal.com/v1/payments/payouts-item/1421342/cancel \
-H "Content-Type:application/json" \
-H "Authorization: Bearer Access-Token"

Response

A successful call returns the payout_item_details object with a RETURNED transaction status.

  • payout_item_id

    string

    The ID for the payout item. Viewable when you show details for a batch payout.

    Maximum length: 30.

  • transaction_id

    string

    The PayPal-generated ID for the transaction.

    Maximum length: 30.

  • transaction_status

    object

    The transaction status.
  • payout_item_fee

    object

    The fee, in U.S. dollars.
  • payout_batch_id

    string

    The PayPal-generated ID for the batch payout.

    Maximum length: 30.

  • sender_batch_id

    string

    A sender-specified ID number. Tracks the batch payout in an accounting system.

    Maximum length: 30.

  • payout_item

    object

    The sender-provided information for the payout item.
  • time_processed

    string

    The date and time when this item was last processed, in Internet date and time format.

    Format: date-time.

  • errors

    object

    Details of an Error
  • links

    array (contains the link object)

    HATEOAS links related to this call.

    Read only.

Sample Response

{
  "payout_item_id": "1421342",
  "transaction_id": "4345",
  "transaction_status": "RETURNED",
  "payout_item_fee": {
    "currency": "USD",
    "value": "0.35"
  },
  "payout_batch_id": "20140724",
  "sender_batch_id": "2014021801",
  "payout_item": {
    "recipient_type": "EMAIL",
    "amount": {
      "value": "9.87",
      "currency": "USD"
    },
    "note": "Thanks for your patronage!",
    "receiver": "anybody01@gmail.com",
    "payouts_item_id": "1421342",
    "sender_item_id": "14Feb_234"
  },
  "time_processed": "2014-01-27T10:17:41Z",
  "errors": {
    "name": "RECEIVER_UNREGISTERED",
    "message": "Receiver is unregistered",
    "information_link": "https://developer.paypal.com/docs/api/payments.payouts-batch#errors"
  },
  "links": [
    {
      "rel": "self",
      "href": "https://api.sandbox.paypal.com/v1/payments/payouts-item/1421342",
      "method": "GET"
    },
    {
      "rel": "batch",
      "href": "https://api.sandbox.paypal.com/v1/payments/payouts/20140724",
      "method": "GET"
    }
  ]
}

Common object definitions

batch_status

  • batch_header

    object

    A batch header. Includes the generated batch status.
  • items

    array (contains the payout_item_details object)

    The payout item status and other details.
  • links

    array (contains the link object)

    HATEOAS links related to this call.

    Read only.

common_currency:v1

  • currency

    string

    3 letter currency code
  • value

    string

    amount upto 2 decimals represented as string

common_error:v1

  • name

    string

    Human readable, unique name of the error.

    Read only.

  • debug_id

    string

    PayPal internal identifier used for correlation purposes.

    Read only.

  • message

    string

    Message describing the error.

    Read only.

  • information_link

    string

    URI for detailed information related to this error for the developer.

    Read only.

  • details

    array (contains the common_error_details:v1 object)

    Details about a specific error.

    Read only.

common_error_details:v1

  • field

    string

    Name of the field that caused the error.
  • issue

    string

    Reason for the error.

common_json_patch:v1

  • op

    enum

    The operation to perform.

    Possible values: add, remove, replace, move, copy, test.

  • path

    string

    string containing a JSON-Pointer value that references a location within the target document (the target location) where the operation is performed.
  • value

    string

    New value to apply based on the operation.
  • from

    string

    A string containing a JSON Pointer value that references the location in the target document to move the value from.

common_json_patch_request:v1

  • items

    (contains the common_json_patch:v1 object)

    A JSON Patch object used for doing partial updates to resources.

payout_batch_header

  • payout_batch_id

    string

    The PayPal-generated ID for a batch payout.

    Maximum length: 30.

  • batch_status

    object

    The PayPal-generated batch status. If the batch payout passes preliminary checks, the status is PENDING.
  • time_created

    string

    The date and time when processing for the batch payout began, in Internet date and time format.

    Format: date-time.

  • time_completed

    string

    The date and time when processing for the batch payout completed, in Internet date and time format.

    Format: date-time.

  • sender_batch_header

    object

    The original batch payout header, as provided by the payment sender.
  • amount

    object

    The total amount, in U.S. dollars, requested for the payouts.
  • fees

    object

    The total estimate, in U.S. dollars, for the applicable payouts fees.
  • errors

    object

    Details of an Error

payout_enumerations

  • batch_enum

    enum

    The batch payouts status. Value is:
    • ACKNOWLEDGED. The payout is acknowledged and will be processed. This status does not apply to the REST API but applies to only Web upload.
    • DENIED. No batch payout items are processed.
    • PENDING. The batch payout is waiting to be processed.
    • PROCESSING. The batch payout is being processed.
    • SUCCESS. The batch payout was successfully processed. Note that some batch payout items might not be completely processed because, for example, they are unclaimed or on hold.
    • NEW. The batch payout is delayed due to PayPal internal updates.
    • CANCELED. This status cannot occur if the sender uses the API to only send payouts. This status is an edge-case if a sender uses both the MassPay web upload and the Payouts API, cancels the web upload, and then uses the API to find the batch payout or payout items. Then, the CANCELED status is possible.

    Possible values: ACKNOWLEDGED, DENIED, PENDING, PROCESSING, SUCCESS, NEW, CANCELED.

  • transaction_enum

    enum

    The item transaction status. Value is:
    • NEW. The payment processing is delayed due to PayPal internal updates.
    • SUCCESS. The payout item was successfully processed.
    • DENIED. The payout item was denied payment.
    • PENDING. The payout item is waiting to be processed.
    • FAILED. Processing for the payout item failed.
    • UNCLAIMED. The payout item is unclaimed. If it is not claimed within 30 days, the funds are returned to the sender.
    • RETURNED. The payout item is returned. If the recipient does not claim it in 30 days, the funds are returned.
    • ONHOLD. The payout item is on hold.
    • BLOCKED. The payout item is blocked.
    • REFUNDED. The payment for the payout item was successfully refunded.

    Possible values: NEW, SUCCESS, DENIED, PENDING, FAILED, UNCLAIMED, RETURNED, ONHOLD, BLOCKED, REFUNDED.

  • recipient_enum

    enum

    The ID type that identifies the payment receiver. Value is:
      EMAIL. Unencrypted email. Value is a string of up to 127 single-byte characters.
    • PHONE. Unencrypted phone number.
    • PAYPAL_ID. Encrypted PayPal account number.
    These rules apply to the recipient_type:
    • If the sender_batch_header includes a recipient_type value, any payout items without a recipient_type value use the recipient_type value in the sender_batch_header.
    • If the sender_batch_header omits the recipient_type value, each payout item must include its own recipient_type value.

    Possible values: EMAIL, PHONE, PAYPAL_ID.

  • funding_enum

    enum

    The funding instrument.

    Possible values: BALANCE.

payout_item

  • recipient_type

    object

    The type of ID that identifies the payment receiver. Value is:
      EMAIL. Unencrypted email. Value is a string of up to 127 single-byte characters.
    • PHONE. Unencrypted phone number.
      Note: The PayPal sandbox does not support the PHONE recipient type.
    • PAYPAL_ID. Encrypted PayPal account number.
    If the sender_batch_header includes the recipient_type attribute, any payout item without its own recipient_type attribute uses the recipient_type value from sender_batch_header. If the sender_batch_header omits the recipient_type attribute, each payout item must include its own recipient_type value.
  • amount

    object

    The amount of money to pay the receiver.
  • note

    string

    Optional. A sender-specified note for notifications. Value is any string value.

    Read only.

    Maximum length: 4000.

  • receiver

    string

    The receiver of the payment. Corresponds to the recipient_type value in the request.

    Read only.

    Maximum length: 127.

  • sender_item_id

    string

    A sender-specified ID number. Tracks the batch payout in an accounting system.

    Read only.

    Maximum length: 30.

payout_item_details

  • payout_item_id

    string

    The ID for the payout item. Viewable when you show details for a batch payout.

    Maximum length: 30.

  • transaction_id

    string

    The PayPal-generated ID for the transaction.

    Maximum length: 30.

  • transaction_status

    object

    The transaction status.
  • payout_item_fee

    object

    The fee, in U.S. dollars.
  • payout_batch_id

    string

    The PayPal-generated ID for the batch payout.

    Maximum length: 30.

  • sender_batch_id

    string

    A sender-specified ID number. Tracks the batch payout in an accounting system.

    Maximum length: 30.

  • payout_item

    object

    The sender-provided information for the payout item.
  • time_processed

    string

    The date and time when this item was last processed, in Internet date and time format.

    Format: date-time.

  • errors

    object

    Details of an Error
  • links

    array (contains the link object)

    HATEOAS links related to this call.

    Read only.

payouts_batch_request

  • sender_batch_header

    object

    The sender-provided batch header for a batch payout request.
  • items

    array (contains the payout_item object)

    A sender-created payout to a single recipient.

    Maximum length: 5000.

payouts_batch_response

  • batch_header

    object

    The batch header.
  • items

    array (contains the payout_item object)

    A sender-created payout to a single recipient.

    Maximum length: 5000.

  • links

    array (contains the link object)

    HATEOAS links related to this call.

    Read only.

sender_batch_header

  • sender_batch_id

    string

    A sender-specified ID number. Tracks the batch payout in an accounting system.
    Note: PayPal prevents duplicate batches from being processed. If you specify a sender_batch_id that was used in the last 30 days, the API rejects the request and returns an error message that indicates the duplicate sender_batch_id and includes a HATEOAS link to the original batch payout with the same sender_batch_id. If you receive an HTTP 5nn status code, you can safely retry the request with the same sender_batch_id. In any case, the API completes a payment only once for a specific sender_batch_id that is used within 30 days.

    Maximum length: 30.

  • recipient_type

    object

    The ID type that is used to identify the recipient of the payment. For example, EMAIL.
  • email_subject

    string

    The subject line for the email that PayPal sends when payment for a payout item completes. The subject line is the same for all recipients. Value is an alphanumeric string with a maximum length of 255 single-byte characters.

Additional API information

Error messages

In addition to common REST API errors, the Payouts API can return the following errors. Corrective action is provided where possible.

  • ACCOUNT_RESTRICTED

    User is restricted.

  • ACCOUNT_UNCONFIRMED_EMAIL

    Sender may not have a confirmed bank (or) credit card on file. Sender may not have account status verified.

  • AUTHORIZATION_ERROR

    An authorization error occurred.

  • BATCH_NOT_COMPLETED

    You can cancel only items with Processed status.

  • CLOSED_MARKET

    Market is closed and transaction is between two different countries.

  • CURRENCY_COMPLIANCE

    Currency compliance.

  • CURRENCY_NOT_SUPPORTED_FOR_RECEIVER

    The recipient cannot receive the transaction currency.

  • DUPLICATE_ITEM

    REF_ID matches with another item in the batch payout.

  • INSUFFICIENT_FUNDS

    Sender has insufficient funds.

  • INTERNAL_ERROR

    An internal error has occurred.

  • ITEM_ALREADY_CANCELLED

    Requested item is already canceled.

  • ITEM_CANCELLATION_FAILED

    Cancel request for the item failed due to an internal error.

  • ITEM_INCORRECT_STATUS

    You can cancel only items with Unclaimed status.

  • MALFORMED_REQUEST_ERROR

    JSON request is malformed.

  • NEGATIVE_BALANCE

    Negative balance.

  • POS_LIMIT_EXCEEDED

    POS cumulative sending limit exceeded.

  • RECEIVER_ACCOUNT_LOCKED

    The receiver's account is locked or inactive. Any payment made to the account appears as FAILED.

  • RECEIVER_COUNTRY_NOT_ALLOWED

    Receiver's address is in a non-receivable country or a PayPal zero country.

  • RECEIVER_STATE_RESTRICTED

    Receiver's address is located in a restricted state, such as California.

  • RECEIVER_UNCONFIRMED

    The receiver's email is unconfirmed. Any payment made to this account appears as UNCLAIMED until the receiver's account is confirmed.

  • RECEIVER_UNREGISTERED

    Receiver is unregistered.

  • RECEIVER_YOUTH_ACCOUNT

    Youth account recipient.

  • RECEIVING_LIMIT_EXCEEDED

    Receiving limit exceeded.

  • REGULATORY_BLOCKED

    Regulatory review - Blocked.

  • REGULATORY_PENDING

    Regulatory review - Pending.

  • REQUIRED_SCOPE_MISSING

    Access token does not have required scope.

  • RISK_DECLINE

    Transaction was declined.

  • SELF_PAY_NOT_ALLOWED

    Cannot pay self.

  • SENDER_ACCOUNT_LOCKED

    Sender's account is locked or inactive.

  • SENDER_STATE_RESTRICTED

    Sender's address is located in a restricted state, such as California.

  • SPENDING_LIMIT_EXCEEDED

    Spending limit exceeded.

  • THIRD_PARTY_CALLS_FORBIDDEN

    A third-party access token cannot be used for this operation.

  • TRANSACTION_LIMIT_EXCEEDED

    Either the sender or receiver exceeded the transaction limit.

  • UNDEFINED

    Unknown error.

  • USER_BUSINESS_ERROR

    User business error.

  • USER_COUNTRY_NOT_ALLOWED

    User's country is not allowed.

  • USER_FUNDING_SOURCE_INELIGIBLE

    User's credit card is not in the list of allowed countries of the gaming merchant.

  • ZERO_AMOUNT

    Zero amount.