API Reference

Server API version 1.0
Java

Results for

icon-search-large No search results yet
Enter your search query above

Find payouts

GET https://{domainname}/v1/{merchantId}/payouts

Payouts

Our payout service allows you to easily transfer money directly into a bank account of your choice.

Before we can process your payout request you will need to pre-fund the total amount of money you want to payout.
For more information about payouts please click here.

Request

Retrieves the details of payouts based on your order identifier, your unique transaction reference, or both.

In addition to the filter, you can also provide an offset and limit. In combination with the total number of payouts matching the filter that is part of the response, this allows you to implement paging.

Query parameters

Query parameters for this method

Property Type Required Repeat Details
merchantReference string no no read close
close

Description

Your unique transaction reference to filter on.
merchantOrderId integer no no read close
close

Description

Your order identifier to filter on.
offset integer no no read close
close

Description

The zero-based index of the first payout in the result. If omitted, the offset will be 0.
limit integer no no read close
close

Description

The maximum number of payouts to return, with a maximum of 100. If omitted, the limit will be 10.

Request example

SDK: Java

This scenario you will probably use the most

  • FindPayoutsParams query = new FindPayoutsParams();
    query.setMerchantReference("AcmeOrder0001");
    query.setMerchantOrderId(123456L);
    query.setOffset(0);
    query.setLimit(10);
    
    FindPayoutsResponse response = client.merchant("merchantId").payouts().find(query);
    

Responses

Please find below an overview of the possible responses.

Response 200 - OKFindPayoutsResponse

The response contains an array of payouts that match the filters supplied in the request.

Property Type Required Details
limit integer no read close
close

Description

The limit you used in the request.
offset integer no read close
close

Description

The offset you used in the request.
payouts array of object no read close
close

Description

A list of payouts that matched your filter, starting at the given offset and limited to the given limit.
items object no read close
close
  • SDK Object type
    PayoutResult
id string no read close
close

Description

Our unique payout transaction identifier
payoutOutput object no read close
close

Description

Object containing payout details
  • SDK Object type
    OrderOutput
amountOfMoney object no read close
close

Description

Object containing amount and ISO currency code attributes
  • SDK Object type
    AmountOfMoney
amount integer (12) yes read close
close

Description

Amount in cents and always having 2 decimals
currencyCode string (3) yes read close
close

Description

Three-letter ISO currency code representing the currency for the amount
references object no read close
close

Description

Object that holds all reference fields that are linked to this transaction
  • SDK Object type
    PaymentReferences
merchantOrderId integer no read close
close

Description

Your order ID for this transaction that is also returned in our report files
merchantReference string no read close
close

Description

Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.
paymentReference string no read close
close

Description

Payment Reference generated by WebCollect
providerId string no read close
close

Description

Provides an additional means of reconciliation for Gateway merchants
providerReference string no read close
close

Description

Provides an additional means of reconciliation for Gateway merchants
referenceOrigPayment string no read close
close

Description

When you did not supply a merchantReference for your payment, you need to fill this field with the reference of the original payment when you want to refund it
status enum no read close
close

Description

Current high-level status of the payouts in a human-readable form. Possible values are :
  • CREATED - The transaction has been created. This is the initial state once a new payout is created.
  • PENDING_APPROVAL - The transaction is awaiting approval from you to proceed with the paying out of the funds
  • REJECTED - The transaction has been rejected
  • PAYOUT_REQUESTED - The transaction is in the queue to be payed out to the consumer
  • ACCOUNT_CREDITED - We have successfully credited the consumer
  • REJECTED_CREDIT - The credit to the account of the consumer was rejected by the bank
  • CANCELLED - You have cancelled the transaction
  • REVERSED - The payout has been reversed and the money is returned to your balance

Please see Statuses for a full overview of possible values.
statusOutput object no read close
close

Description

This object has the numeric representation of the current payout status, timestamp of last status change and performable action on the current payout resource.
In case of a rejected payout, detailed error information is listed.
  • SDK Object type
    OrderStatusOutput
errors array of object no read close
close

Description

Custom object contains the set of errors
items object no read close
close
  • SDK Object type
    APIError
category string no read close
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
code string yes read close
close

Description

Error code
httpStatusCode integer no read close
close

Description

HTTP status code for this error that can be used to determine the type of error
id string no read close
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
message string no read close
close

Description

Human-readable error message that is not meant to be relayed to consumer as it might tip off people who are trying to commit fraud
propertyName string no read close
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
requestId string no read close
close

Description

ID of the request that can be used for debugging purposes
isCancellable boolean no read close
close

Description

Flag indicating if the payment can be cancelled
  • true
  • false
statusCategory enum no read close
close

Description

Highlevel status of the payment, payout or refund with the following possible values:
  • CREATED - The transaction has been created. This is the initial state once a new payment, payout or refund is created. This category groups the following statuses:
    • CREATED
  • PENDING_PAYMENT: The payment is waiting on consumer action. This category groups the following statuses:
    • PENDING_PAYMENT
    • REDIRECTED
  • ACCOUNT_VERIFIED: The account has been verified. This category groups the following statuses:
    • ACCOUNT_VERIFIED
  • PENDING_MERCHANT: The transaction is awaiting approval to proceed with the payment, payout or refund. This category groups the following statuses:
    • PENDING_APPROVAL
    • PENDING_COMPLETION
    • PENDING_CAPTURE
    • PENDING_FRAUD_APPROVAL
  • PENDING_CONNECT_OR_3RD_PARTY: The transaction is in the queue to be processed. This category groups the following statuses:
    • AUTHORIZATION_REQUESTED
    • CAPTURE_REQUESTED
    • PAYOUT_REQUESTED
    • REFUND_REQUESTED
  • COMPLETED: The transaction has completed. This category groups the following statuses:
    • CAPTURED
    • PAID
    • ACCOUNT_CREDITED
    • CHARGEBACK_NOTIFICATION
  • REVERSED: The transaction has been reversed. This category groups the following statuses:
    • CHARGEBACKED
    • REVERSED
  • REFUNDED: The transaction has been refunded. This category groups the following statuses:
    • REFUNDED
  • UNSUCCESSFUL: The transaction has been rejected or is in such a state that it will never become successful. This category groups the following statuses:
    • CANCELLED
    • REJECTED
    • REJECTED_CAPTURE
    • REJECTED_CREDIT

Please see Statuses for a full overview of possible values.
statusCode integer no read close
close

Description

Numeric status code that is returned by either Ingenico's Global Collect Payment Platform or Ingenico's Ogone Payment Platform. It is returned to ease the migration from the local APIs to Ingenico Connect. You should not write new business logic based on this field as it will be deprecated in a future version of the API. The value can also be found in the Global Collect Payment Console, in the Global Collect report files and the Ogone BackOffice and report files.
statusCodeChangeDateTime string no read close
close

Description

Date and time of payment
Format: YYYYMMDDHH24MISS
totalCount integer no read close
close

Description

The total number of payouts that matched your filter.

Response example

SDK: Java

This scenario you will probably use the most

  • {
        "payouts" : [
            {
                "id" : "00000088970000001521000-100001",
                "payoutOutput" : {
                    "amountOfMoney" : {
                        "amount" : 2345,
                        "currencyCode" : "EUR"
                    },
                    "references" : {
                        "merchantOrderId" : 123456,
                        "merchantReference" : "AcmeOrder001",
                        "paymentReference" : "0"
                    }
                },
                "status" : "CANCELLED",
                "statusOutput" : {
                    "isCancellable" : false,
                    "statusCode" : 9999,
                    "statusCodeChangeDateTime" : "20140707093101"
                }
            }
        ],
        "offset" : 0,
        "limit" : 10,
        "totalCount" : 1
    }
    

Response 400 - Bad requestErrorResponse

You did not provide a valid filter, your offset or limit is negative, or your limit is too high.

Property Type Required Details
errorId string yes read close
close

Description

Unique reference, for debugging purposes, of this error response
errors array of object yes read close
close

Description

List of one or more errors
items object no read close
close
  • SDK Object type
    APIError
category string no read close
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
code string yes read close
close

Description

Error code
httpStatusCode integer no read close
close

Description

HTTP status code for this error that can be used to determine the type of error
id string no read close
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
message string no read close
close

Description

Human-readable error message that is not meant to be relayed to consumer as it might tip off people who are trying to commit fraud
propertyName string no read close
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
requestId string no read close
close

Description

ID of the request that can be used for debugging purposes

Response example

SDK: Java

This scenario you will probably use the most

  • {
        "errorId" : "15eabcd5-30b3-479b-ae03-67bb351c07e6-00000092",
        "errors" : [
            {
                "code" : "20000000",
                "propertyName" : "bankAccountBban.accountNumber",
                "message" : "PARAMETER_NOT_FOUND_IN_REQUEST"
            }
        ]
    }
    
icon_top_1